jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-16 05:46:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update Clicksend_tts notify component configuration (#7259)

Browse Source
This commit is contained in:
Klaas Schoute 2018-10-30 07:41:39 +01:00 committed by Fabian Affolter
parent b2e369a701
commit efcaa6f124
1 changed files with 29 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
source/_components/notify.clicksend_tts.markdown
View File

@ -13,7 +13,6 @@ ha_release: 0.55
redirect_from: /components/notify.clicksendaudio/
---
The `clicksend_tts` platform uses [ClickSend](https://clicksend.com) to deliver text-to-speech (TTS) notifications from Home Assistant.
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`.
@ -29,14 +28,34 @@ notify:
recipient: PHONE_NO
```
Configuration variables:
* **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.
* **username** (Required): Your username.
* **api_key** (Required): Your API Key.
* **recipient** (Required): Your phone number. This is where you want to send your notification SMS messages (e.g., `09171234567`)
* **language** (Optional): The language you want to use to convert the message to audio. Accepted values are found in the [ClickSend Documentation](http://docs.clicksend.apiary.io/#reference/voice/voice-languages). Default value is `en-us`.
* **voice** (Optional): The voice that needs to be used to play the message to the recipient. Allowed values are `female` or `male`. Default value is `female`.
{% configuration %}
name:
description: Setting the optional parameter name allows multiple notifiers to be created. The notifier will bind to the service notify.NOTIFIER_NAME.
required: false
default: ClickSend
type: string
username:
description: Your username.
required: true
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., `09171234567`).
required: true
type: string
language:
description: The language you want to use to convert the message to audio. Accepted values are found in the [ClickSend Documentation](http://docs.clicksend.apiary.io/#reference/voice/voice-languages).
required: false
default: en-us
type: string
voice:
description: The voice that needs to be used to play the message to the recipient. Allowed values are `female` or `male`.
required: false
default: female
type: string
{% endconfiguration %}
To use notifications, please see the [getting started with automation page](/getting-started/automation/).