2024.11.3
Home ▸ Integrations ▸

Sinch SMS

The sinch integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] uses Sinch to deliver notifications from Home Assistant.

Prerequisites

Go to your Sinch Dashboard and click “Add new REST API”. You should now be able to obtain your service_plan_id and api_key.

Configuration

To add Sinch 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: sinch
    service_plan_id: SINCH_SERVICE_PLAN_ID
    api_key: SINCH_API_KEY

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 Sinch. The notifier will bind to the notify.NOTIFIER_NAME action.

service_plan_id string Required

Your Sinch Service Plan ID.

api_key string Required

Your API Token.

default_recipient string | list (Optional)

A single or multiple phone numbers. This is where you want to send your SMS notification messages by default (when not specifying target in the action), e.g., 09171234567 or [09171234567, 09177654321].

sender string (Optional, default: Home Assistant)

The name or number of the sender.

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

Full configuration example 

# Example configuration.yaml entry
notify:
  - platform: sinch
    name: Sinch
    service_plan_id: SINCH_SERVICE_PLAN_ID
    api_key: SINCH_API_KEY
    default_recipient: [PHONE_NO1, PHONE_NO2]
    sender: Home Assistant

Related topics