Introduction
Sinch is a global CPaas (Communications Platform as a Service provider) that enables businesses to send text messages to large numbers of customers and to make video and voice calls.
Configure Sinch as SMS connector (Service Provider)
library_add_check |
Prerequisites Ensure you have the Shortcode, Access token, and Service Plan ID available on the Sinch dashboard. You can also reach out to MoEngage Customer Success team to get assistance on this. |
info |
Information We've revamped our dashboard settings. This article describes the steps to be followed to configure Infobip as a Custom Connector (Service Provider) in the revamped settings UI and the older UI. |
Configure in Revamped UI
Log in to the MoEngage Dashboard and follow these steps:
- Navigate to Settings -> Channel -> SMS -> Sender Configuration.
- Click +Add Service Provider at the top right corner.
- Select Sinch in the Add Sender screen.
- Add the following details in the Sender Details screen.
Field Description Mark as default
This toggle will be disabled during sender creation. The first sender to be created in your MoEngage account will be marked as the default sender for your SMS campaigns. You can change the default sender by following the steps mentioned in Marking a sender as default.
Sender name
This field identifies the Sender. Type the name of the sender here.
Sender number
This field denotes the number from which SMS will be sent to your users. Use the shortcode number from the Shortcode Sinch dashboard, as described.
API token This field denotes the API token that is required for authentication and is linked to a service plan ID. You can find the API token here. Click Show to reveal your API token.
Service plan ID
Enter the Service plan ID corresponding to the API token you have entered in the API token field. Ensure that your short code is linked to this service plan ID. You can check with the Sinch team if you need clarity on which shortcode is linked to which service plan ID.
Mobile Originated (MO) callback URL
This callback URL depends on the data center (DC) to which your workspace belongs. The callback URLs are listed below:
- For DC 01:https://api-01.moengage.com/v1/campaigns/outbound/sms/callbacks/mo/twilio
- For DC 02: https://api-02.moengage.com/v1/campaigns/outbound/sms/callbacks/mo/twilio
- For DC 03:https://api-03.moengage.com/v1/campaigns/outbound/sms/callbacks/mo/twilio
- For DC 04:https://api-04.moengage.com/v1/campaigns/outbound/sms/callbacks/mo/twilio
Note that this field is only available when the Manage keyword based responses toggle under Keyword management is enabled.
SMS unsubscribe text
The input text provided in this field appears when you select the SMS opt-out instruction checkbox while creating content for your SMS campaign.
The SMS opt-out instruction allows you to include a text in the created SMS campaign that helps your customers to opt-out from receiving further SMS messages.
Note that this field is only available when the Manage keyword based responses toggle under Keyword management is enabled.
- Send a test SMS to verify your configuration.
- Click Save to save the Sender Configuration.
Configure in Old UI
- On the MoEngage Dashboard, navigate to Settings > Channel > SMS & Connector and click the SMS Connector Config tab.
- In Integrated Connectors, click Sinch.
- Fill in the following details:
Field Description Sender Name Type the name to identify the Sinch sender Sender Number Use the shortcode, the number from which SMS will be sent to your users. You can find the shortcode Sinch dashboard here, as described. API Token Use API token is required for authentication and is linked to a service plan ID. You can find API token here. Click Show to reveal your API token. Service Plan ID Enter the Service plan ID corresponding to the API token you have entered above. Make sure that your short code is linked to this service plan ID. You can check with Sinch team if you need clarity on which short code is linked to which service plan ID. Mobile Originated (MO) callback URL This callback URL depends on the data center (DC) to which your workspace belongs. The callback URLs are listed below:
- For DC 01:https://api-01.moengage.com/v1/campaigns/outbound/sms/callbacks/mo/twilio
- For DC 02: https://api-02.moengage.com/v1/campaigns/outbound/sms/callbacks/mo/twilio
- For DC 03:https://api-03.moengage.com/v1/campaigns/outbound/sms/callbacks/mo/twilio
- For DC 04:https://api-04.moengage.com/v1/campaigns/outbound/sms/callbacks/mo/twilio
Note that this field is only available when the Manage keyword based responses toggle under Keyword management is enabled.
SMS unsubscribe text The input text provided in this field appears when you select the SMS opt-out instruction checkbox while creating content for your SMS campaign.
The SMS opt-out instruction allows you to include a text in the created SMS campaign that helps your customers to opt-out from receiving further SMS messages.
Note that this field is only available when the Manage keyword based responses toggle under Keyword management is enabled.
- Click Save to save the configuration.
Delivery Callback
MoEngage automatically tracks delivery receipts as the delivery callback URL is passed in the API call to Sinch. No additional configuration for tracking the SMS delivery.
Configure Keyword Management
Changes in MoEngage Settings
To configure keyword management, you need to input the below two fields in the Sender Details screen of the MoEngage dashboard. These fields appear only when the Manage keyword-based responses toggle under Keyword management is enabled.
-
Mobile Originated (MO) callback URL - This callback URL depends on the DC you belong to. The callback URLs are listed below:
- For DC 01-https://api-01.moengage.com/v1/campaigns/outbound/sms/callbacks/mo/twilio
- For DC 02-https://api-02.moengage.com/v1/campaigns/outbound/sms/callbacks/mo/twilio
- For DC 03-https://api-03.moengage.com/v1/campaigns/outbound/sms/callbacks/mo/twilio
- For DC 04-https://api-04.moengage.com/v1/campaigns/outbound/sms/callbacks/mo/twilio
- SMS unsubscribe text- The SMS unsubscribe text allows you to include a text in the created SMS campaign that helps your customers opt-out from further SMS messages. The input text provided in this field is displayed as an opt-out text when you select SMS opt-out instruction checkbox while creating content for your SMS campaign.
Changes in Sinch Console
For any configured sender, perform the following steps to configure key management in the Sinch console:
- Log in to Sinch console.
- Navigate to SMS and click Service APIs.
- Under Callback URLs, navigate to Incoming URL.
- In the Incoming URL field, enter the same callback URL you added in the Mobile Originated (MO) callback URL field of the MoEngage dashboard.
Next Steps
- Create an SMS campaign using the Getting Started for creating SMS campaign.
- Set the Frequency Capping for SMS.
- Set the Current Service Provider.