Home Assistant

ClickSend TTS

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 Variables

Looking for your configuration file?
name string (Optional, default: clicksend_tts)

Setting the optional parameter name allows multiple notifiers to be created. The notifier will bind to the service notify.NOTIFIER_NAME.

username string Required

Your username (probably your email address).

api_key string Required

Your API Key.

recipient string Required

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.

language string (Optional, default: en-us)

The language you want to use to convert the message to audio. Accepted values are found in the ClickSend Documentation.

voice string (Optional, default: female)

The voice that needs to be used to play the message to the recipient. Allowed values are female or male.

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"