apprise

extern/apprise

Fork 0

mirror of https://github.com/caronc/apprise.git synced 2024-12-04 05:54:35 +01:00

Table of Contents

Sinch Notifications

Account Setup
Syntax
Parameter Breakdown

Example

Sinch Notifications

Source: https://sinch.com
Icon Support: No
Message Format: Text
Message Limit: 160 Characters per message

Account Setup

To use Sinch, you will need to acquire your Service Plan ID and API Token. Both of these are accessible via the Sinch Dashboard or through the API section.

You'll need to have a number defined as an Active Number (from your dashboard here). This will become your {FromPhoneNo} when identifying the details below.

Syntax

Valid syntaxes are as follows:

sinch://{ServicePlanID}:{ApiToken}@{FromPhoneNo}/{PhoneNo}
sinch://{ServicePlanID}:{ApiToken}@{FromPhoneNo}/{PhoneNo1}/{PhoneNo2}/{PhoneNoN}

If no ToPhoneNo is specified, then the FromPhoneNo will be messaged instead; hence the following is a valid URL:

sinch://{ServicePlanID}:{ApiToken}@{FromPhoneNo}/

Short Codes are also supported but require at least 1 Target PhoneNo

sinch://{ServicePlanID}:{ApiToken}@{ShortCode}/{PhoneNo}
sinch://{ServicePlanID}:{ApiToken}@{ShortCode}/{PhoneNo1}/{PhoneNo2}/{PhoneNoN}

Parameter Breakdown

Variable	Required	Description
ServicePlanID	Yes	The Account SID associated with your Sinch account. This is available to you via the Sinch Dashboard.
ApiToken	Yes	The Auth Token associated with your Sinch account. This is available to you via the Sinch Dashboard.
FromPhoneNo	*No	The Active Phone Number associated with your Sinch account you wish the SMS message to come from. It must be a number registered with Sinch. As an alternative to the FromPhoneNo, you may also provide a ShortCode here instead. The phone number MUST include the country codes dialling prefix as well when placed. This field is also very friendly and supports brackets, spaces and hyphens in the event you want to format the number in an easy to read fashion.
ShortCode	*No	The ShortCode associated with your Sinch account you wish the SMS message to come from. It must be a number registered with Sinch. As an alternative to the ShortCode, you may provide a FromPhoneNo instead.
PhoneNo	*No	A phone number MUST include the country codes dialling prefix as well when placed. This field is also very friendly and supports brackets, spaces and hyphens in the event you want to format the number in an easy to read fashion. Note: If you're using a ShortCode, then at least one PhoneNo MUST be defined.
Region	No	Can be either `us` or `eu`. By default the region is set to `us`.

Example

Send a Sinch Notification as an SMS:

# Assuming our {ServicePlanID} is AC735c307c62944b5a
# Assuming our {ApiToken} is e29dfbcebf390dee9
# Assuming our {FromPhoneNo} is +1-900-555-9999
# Assuming our {PhoneNo} - is in the US somewhere making our country code +1
#                        - identifies as 800-555-1223
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   sinch://AC735c307c62944b5a:e29dfbcebf390dee9@19005559999/18005551223

# the following would also have worked (spaces, brackets,
# dashes are accepted in a phone no field):
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   sinch://AC735c307c62944b5a:e29dfbcebf390dee9@1-(900) 555-9999/1-(800) 555-1223

Quick Links:

📣 Apprise Notification Services and URL Examples
💡 Apprise CLI Tool Help
⚙️ Apprise Configuration Help
🌎 Apprise API/Web Interface