mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-19 15:26:59 +00:00
Add sender (#4422)
This commit is contained in:
parent
7ac7cc768e
commit
1b1fcb5558
@ -18,10 +18,10 @@ The `clicksend` platform uses [ClickSend](https://clicksend.com) to deliver noti
|
|||||||
### Get your ClickSend API Credentials
|
### Get your ClickSend API Credentials
|
||||||
Go to your [ClickSend Dashboard](https://dashboard.clicksend.com) section and create your new project. After creating your project, you should now be able to obtain your `username` and `api_key`.
|
Go to your [ClickSend Dashboard](https://dashboard.clicksend.com) section and create your new project. After creating your project, you should now be able to obtain your `username` and `api_key`.
|
||||||
|
|
||||||
### Configuration
|
|
||||||
To add ClickSend to your installation, add the following to your Home Assistant `configuration.yaml` file:
|
To add ClickSend to your installation, add the following to your Home Assistant `configuration.yaml` file:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
|
# Example configuration.yaml entry
|
||||||
notify:
|
notify:
|
||||||
- platform: clicksend
|
- platform: clicksend
|
||||||
name: ClickSend
|
name: ClickSend
|
||||||
@ -30,12 +30,28 @@ 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 `ClickSend`. The notifier will bind to the service notify.NOTIFIER_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`."
|
||||||
* **username** (Required): Your `Username`.
|
required: false
|
||||||
* **api_key** (Required): Your `API Key`.
|
type: string
|
||||||
* **recipient** (Required): Your phone no. This is where you want to send your notification SMS messages. eg: `09171234567`
|
username:
|
||||||
|
description: Your Clicksend username.
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
api_key:
|
||||||
|
description: Your Clicksend API Key.
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
recipient:
|
||||||
|
description: "Your phone number. This is where you want to send your notification SMS messages, e.g., `09171234567`."
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
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](https://home-assistant.io/getting-started/automation/).
|
To use notifications, please see the [getting started with automation page](https://home-assistant.io/getting-started/automation/).
|
||||||
|
Loading…
x
Reference in New Issue
Block a user