diff --git a/source/_components/notify.twilio_sms.markdown b/source/_components/notify.twilio_sms.markdown new file mode 100644 index 00000000000..79601056f4d --- /dev/null +++ b/source/_components/notify.twilio_sms.markdown @@ -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 +``` diff --git a/source/images/supported_brands/twilio.png b/source/images/supported_brands/twilio.png new file mode 100644 index 00000000000..9e9ea721e1e Binary files /dev/null and b/source/images/supported_brands/twilio.png differ