diff --git a/source/_components/notify.telstra.markdown b/source/_components/notify.telstra.markdown new file mode 100644 index 00000000000..1319ec2ea24 --- /dev/null +++ b/source/_components/notify.telstra.markdown @@ -0,0 +1,39 @@ +--- +layout: page +title: "Telstra" +description: "Instructions on how to add Telstra API notifications to Home Assistant." +date: 2016-10-19 10:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: telstra.png +ha_category: Notifications +ha_release: 0.32 +--- + + +The `telstra` notification platform allows you to deliver Home Assistant notifications to Australian phone numbers over the [Telstra SMS API](https://dev.telstra.com/content/sms-api-0). + +To enable the Telstra notifications in your installation, you must first create an account and API app over at [dev.telstra.com](https://dev.telstra.com/). The free tier allows for 1000 notifications to be sent per month. + +After your API app is approved, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +notify: + name: NOTIFIER_NAME + platform: telstra + consumer_key: TELSTRA_API_CONSUMER_KEY_HERE + consumer_secret: TELSTRA_API_CONSUMER_SECRET_HERE + phone_number: SMS_RECIPIENT_PHONE_NUMBER_HERE +``` + +Configuration variables: + +- **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`. +- **consumer_key** (*Required*): The consumer key of your Telstra API app. +- **consumer_secret** (*Required*): The consumer secret of your Telstra API app. +- **phone_number** (*Required*): The phone number of where the notifications will be sent. + +To use notifications, please see the [getting started with automation page](/getting-started/automation/). diff --git a/source/images/supported_brands/telstra.png b/source/images/supported_brands/telstra.png new file mode 100644 index 00000000000..c86d95af6b2 Binary files /dev/null and b/source/images/supported_brands/telstra.png differ