2024.11.2
Home ▸ Integrations ▸

ClickSend SMS

The clicksend platform uses ClickSend to deliver notifications from Home Assistant.

Prerequisites

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.

Configuration

To add ClickSend to your installation, add the following to your Home Assistant configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file. After changing the configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file, restart Home Assistant to apply the changes. The integration is now shown on the integrations page under Settings > Devices & services. Its entities are listed on the integration card itself and on the Entities tab.

# Example configuration.yaml entry
notify:
  - platform: clicksend
    name: ClickSend
    username: CLICKSEND_USERNAME
    api_key: CLICKSEND_API_KEY
    recipient: PHONE_NO
    
# Multiple recipients
notify:
  - platform: clicksend
    name: ClickSend
    username: CLICKSEND_USERNAME
    api_key: CLICKSEND_API_KEY
    recipient: [PHONE_NO1, PHONE_NO2]

Configuration Variables

Looking for your configuration file?
name string (Optional)

Setting the optional parameter name allows multiple notifiers to be created. The default value is ClickSend. The notifier will bind to the notify.NOTIFIER_NAME action.

username string Required

Your Clicksend username.

api_key string Required

Your Clicksend API Key.

recipient string | list Required

A single or multiple phone numbers. This is where you want to send your SMS notification messages, e.g., 09171234567 or [09171234567, 09177654321].

sender string (Optional, default: hass)

The name or number of the sender. (Limited to 11 characters.)

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

Related topics