Home Assistant Home Assistant

ClickSend TTS

The clicksend_tts platform uses ClickSend to deliver text-to-speech (TTS) notifications from Home Assistant.

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:

notify:
  - platform: clicksend_tts
    username: CLICKSEND_USERNAME
    api_key: CLICKSEND_API_KEY
    recipient: PHONE_NO

Configuration Variables

name string (Optional, default: ClickSend)

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.

api_key string Required

Your API Key.

recipient string Required

Recipient phone number. This is the phone number that you want to call and notify via TTS (e.g., 09171234567).

caller string (Optional)

Caller phone number. This is the phone number that you want to be the TTS call originator (e.g., 09181234567). If not defined the recipient number is used.

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.

To use notifications, please see the getting started with automation page.