Sinch SMS


The sinch platform 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.yaml file:

# Example configuration.yaml entry
notify:
  - platform: sinch
    service_plan_id: SINCH_SERVICE_PLAN_ID
    api_key: SINCH_API_KEY

Configuration Variables

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 service notify.NOTIFIER_NAME.

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 service call), e.g., 09171234567 or [09171234567, 09177654321].

sender

(string)(Optional)

The name or number of the sender.

Default value:

Home Assistant

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