Update Clickatell notify component configuration (#7389)

This commit is contained in:
Klaas Schoute 2018-11-06 08:12:09 +01:00 committed by Fabian Affolter
parent 5548971745
commit 7012cb3204

View File

@ -12,7 +12,6 @@ ha_category: Notifications
ha_release: 0.56 ha_release: 0.56
--- ---
The `clickatell` platform uses [Clickatell](https://clickatell.com) to deliver SMS notifications from Home Assistant. The `clickatell` platform uses [Clickatell](https://clickatell.com) to deliver SMS notifications from Home Assistant.
### Get your Clickatell API Credentials ### Get your Clickatell API Credentials
@ -36,11 +35,20 @@ notify:
recipient: PHONE_NO recipient: PHONE_NO
``` ```
Configuration variables: {% configuration %}
name:
* **name** (Optional): Setting the optional parameter name allows multiple notifiers to be created. The default value is `clickatell`. The notifier will bind to the service notify.NOTIFIER_NAME. description: Setting the optional parameter name allows multiple notifiers to be created. The notifier will bind to the service notify.NOTIFIER_NAME.
* **api_key** (Required): Your API key. required: false
* **recipient** (Required): Your phone number. This is where you want to send your notification SMS messages. e.g., `61444333444`. default: clickatell
type: string
api_key:
description: Your API key.
required: true
type: string
recipient:
description: Your phone number. This is where you want to send your notification SMS messages. e.g., `61444333444`.
required: true
type: string
{% endconfiguration %}
To use notifications, please see the [getting started with automation page](/getting-started/automation/). To use notifications, please see the [getting started with automation page](/getting-started/automation/).