Add notify.twilio_sms platform docs

This commit is contained in:
Robbie Trencheny 2016-05-14 13:56:25 -07:00
parent 73854ca35c
commit e35d6fd880
2 changed files with 54 additions and 0 deletions

View File

@ -0,0 +1,54 @@
---
layout: page
title: "Twilio SMS"
description: "Instructions how to add user notifications to Home Assistant."
date: 2016-01-29
sidebar: true
comments: false
sharing: true
footer: true
logo: twilio.png
ha_category: Notifications
---
The Twilio notify platform enables sending notifications via SMS, powered by [Twilio](https://twilio.com).
### Configuration
```yaml
# Example configuration.yaml entry
notify:
platform: twilio_sms
account_sid: ACCOUNT_SID_FROM_TWILIO
auth_token: AUTH_TOKEN_FROM_TWILIO
from_number: E164_PHONE_NUMBER
# Optional
name: NOTIFIER_NAME
```
Configuration variables:
- **account_sid** (*Required*): Your Twilio Account SID which can be found in your [console](https://www.twilio.com/console). It starts with the letters `AC`.
- **auth_token** (*Required*): Your Twilio Account SID which can be found in your [console](https://www.twilio.com/console). It should be directly under where you found the `account_sid`.
- **from_number** (*Required*): An [E.164](https://en.wikipedia.org/wiki/E.164) formatted phone number, like +14151234567. See [Twilio's guide to formatting phone numbers](https://www.twilio.com/help/faq/phone-numbers/how-do-i-format-phone-numbers-to-work-internationally) for more information.
- **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`.
### Usage
Twilio is a notify platform and thus can be controlled by calling the notify service [as described here](/components/notify/). It will send a notification to all E.164 phone numbers in the notification **target**. See the notes above regarding the `from_number` configuration variable for information about formatting phone numbers.
```yaml
# Example automation notification entry
automation:
- alias: The sun has set
trigger:
platform: sun
event: sunset
action:
service: notify.twilio_sms
data:
message: 'The sun has set'
target:
- +14151234567
- +15105555555
```

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.8 KiB