From d75387f3439fdeee0d3bf1c1b8ee7042d5601382 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Tue, 14 Mar 2017 10:51:09 +0100 Subject: [PATCH] Add twilio component and update platforms --- .../_components/notify.twilio_call.markdown | 15 ++------- source/_components/notify.twilio_sms.markdown | 13 ++------ source/_components/twilio.markdown | 33 +++++++++++++++++++ 3 files changed, 38 insertions(+), 23 deletions(-) create mode 100644 source/_components/twilio.markdown diff --git a/source/_components/notify.twilio_call.markdown b/source/_components/notify.twilio_call.markdown index 9458a14ca0c..9caf251d046 100644 --- a/source/_components/notify.twilio_call.markdown +++ b/source/_components/notify.twilio_call.markdown @@ -9,18 +9,13 @@ sharing: true footer: true logo: twilio.png ha_category: Notifications -ha_release: "0.37" +ha_release: 0.37 --- -The `twilio` notification platform enables sending notifications via Voice, powered by [Twilio](https://twilio.com). +The `twilio_call` notification platform enables sending notifications via Voice, powered by [Twilio](https://twilio.com). Passed message will be read by Text-To-Speech service. -This component is just an adaptation from the Twilio SMS notification platform and won't exist without it. - -Free trial account is available at [Twilio](https://twilio.com) website providing free calls to verified phone numbers. -Calls are limited to 10 minutes and will play a short trial message before your message runs. - -Upgraded accounts have no limitation. +The requirement is that you have setup [Twilio](/components/twilio/). To use this notification platform in your installation, add the following to your `configuration.yaml` file: @@ -29,15 +24,11 @@ To use this notification platform in your installation, add the following to you notify: - name: NOTIFIER_NAME platform: twilio_call - account_sid: ACCOUNT_SID_FROM_TWILIO - auth_token: AUTH_TOKEN_FROM_TWILIO from_number: E164_PHONE_NUMBER ``` 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`. diff --git a/source/_components/notify.twilio_sms.markdown b/source/_components/notify.twilio_sms.markdown index 73d21af8e2a..81c9570311f 100644 --- a/source/_components/notify.twilio_sms.markdown +++ b/source/_components/notify.twilio_sms.markdown @@ -18,23 +18,14 @@ To use this notification platform in your installation, add the following to you ```yaml # Example configuration.yaml entry -twilio: - account_sid: "abc" - auth_token: "xyz" - notify: - - name: sms + - name: NOTIFIER_NAME platform: twilio_sms - from_number: "+1111" - - name: call - platform: twilio_call - from_number: "+1111" + from_number: E164_PHONE_NUMBER ``` 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`. diff --git a/source/_components/twilio.markdown b/source/_components/twilio.markdown new file mode 100644 index 00000000000..6c4e040cbad --- /dev/null +++ b/source/_components/twilio.markdown @@ -0,0 +1,33 @@ +--- +layout: page +title: "Twilio" +description: "Instructions how to add Twilio notifications to Home Assistant." +date: 2016-05-14 14:14 +sidebar: true +comments: false +sharing: true +footer: true +logo: twilio.png +ha_category: Notifications +ha_release: "0.20" +--- + +The `twilio` component enables the sending of notifications via SMS and the creation of calls with [Twilio](https://twilio.com). + +Free trial account is available at [Twilio](https://twilio.com) website providing free calls to verified phone numbers. +Calls are limited to 10 minutes and will play a short trial message before your message runs. Upgraded accounts have no limitation. + +To use this notification component in your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +twilio: + account_sid: ACCOUNT_SID_FROM_TWILIO + auth_token: AUTH_TOKEN_FROM_TWILIO +``` + +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`. +