72c602a06f
Co-authored-by: Franck Nijhof <frenck@frenck.nl> Co-authored-by: Franck Nijhof <git@frenck.dev>
2.4 KiB
| title | description | ha_category | ha_iot_class | ha_release | ha_domain | ha_platforms | ha_integration_type | ||
|---|---|---|---|---|---|---|---|---|---|
| ClickSend TTS | Instructions on how to add ClickSend text-to-speech (TTS) notifications to Home Assistant. |
|
Cloud Push | 0.55 | clicksend_tts |
|
integration |
The clicksend_tts platform uses ClickSend to deliver text-to-speech (TTS) notifications from Home Assistant.
After creating your account, you should now be able to obtain your username and api_key here.
To add ClickSend to your installation, add the following to your Home Assistant configuration.yaml file:
notify:
- platform: clicksend_tts
username: CLICKSEND_USERNAME
api_key: CLICKSEND_API_KEY
recipient: PHONE_NO
{% 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_tts
type: string
username:
description: Your username (probably your email address).
required: true
type: string
api_key:
description: Your API Key.
required: true
type: string
recipient:
description: An E.164 formatted phone number, like +14151234567. This is the phone number that you want to call and notify via TTS, see ClickSend Documentation for more info.
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.
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 %}
Usage
ClickSend is a notify platform and thus can be controlled by calling the notify service as described here. It will send a notification to the E.164 phone number you configured as recipient.
alias: "The sun has set"
trigger:
- platform: sun
event: sunset
action:
- service: notify.clicksend_tts
data:
message: "The sun has set"