1.9 KiB
| layout | title | description | date | sidebar | comments | sharing | footer | logo | ha_category | ha_release |
|---|---|---|---|---|---|---|---|---|---|---|
| page | ClickSend SMS | Instructions on how to add ClickSend notifications to Home Assistant. | 2017-06-22 00:00 | true | false | true | true | clicksend.png | Notifications | 0.48 |
The clicksend platform uses ClickSend to deliver notifications from Home Assistant.
Get your ClickSend API Credentials
Go to your ClickSend Dashboard section and create your new project. After creating your project, you should now be able to obtain your username and api_key.
To add ClickSend to your installation, add the following to your Home Assistant configuration.yaml file:
# Example configuration.yaml entry
notify:
- platform: clicksend
name: ClickSend
username: CLICKSEND_USERNAME
api_key: CLICKSEND_API_KEY
recipient: PHONE_NO
# Multiple recipients
notify:
- platform: clicksend
name: ClickSend
username: CLICKSEND_USERNAME
api_key: CLICKSEND_API_KEY
recipient: [PHONE_NO1, PHONE_NO2]
{% configuration %}
name:
description: "Setting the optional parameter name allows multiple notifiers to be created. The default value is ClickSend. The notifier will bind to the service notify.NOTIFIER_NAME."
required: false
type: string
username:
description: Your Clicksend username.
required: true
type: string
api_key:
description: Your Clicksend API Key.
required: true
type: string
recipient:
description: "A single or multiple phone numbers. This is where you want to send your SMS notification messages, e.g., 09171234567 or [09171234567, 09177654321]."
required: true
type: string or list
sender:
description: The name or number of the sender.
required: false
type: string
default: recipient
{% endconfiguration %}
To use notifications, please see the getting started with automation page.