Introduction
Route Mobile provides mobile communication solutions. The Company offers text messaging, voice calling, number lookups, firewall, email, and other related services. Route Mobile serves customers worldwide.
library_add_check |
Prerequisites Ensure you have access to your Route Mobile Dashboard and have the API key for your Route mobile account. |
Configure Route Mobile as a Custom SMS Connector (Service Provider)
This article will help you set Infobip as a Custom Connector on the MoEngage dashboard.
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.
- Add the following details in the Sender Details screen.
Field Description Mark as default
Turn on this toggle to mark the sender as the default sender for the service provider being configured. If marked as default, this sender would be used for sending all SMS campaigns from MoEngage unless you select a different sender while creating the campaign.
Service provider name This field identifies the service provider you are configuring on the MoEngage Dashboard and has to be unique. Type the name of the service provider here.
Sender name
This field identifies the Sender. Type the name of the sender here.
Sender type
The Sender type can either be Promotional or Transactional. Choose the Sender type as Promotional when you would be using the Sender for sending information about your brand, promoting deals, or engaging with users. Choose the Sender type as Transactional when you would be using the Sender for sending alerts about transactions, OTPs, security information, or any information that can be classified as transactional in nature.
- Configure the Webhook by adding the following details:
Field Description API URL
This field contains information about the URL that should be used to send an API request to the Sender. You can get this information from the API Documentation of the Sender. Type the API Endpoint of the sender here. The API URL for Infobip is: https://yr8qyp.api.infobip.com/sms/2/text/advanced
Method
Select POST as the HTTP method.
URL Parameters
Add the URL Parameters to be passed to the API as Key-Value pairs using this option. You can get this information from the API Documentation of the Sender. For example, if the API URL call uses the GET method, all the parameters, such as API Key, Authorization, and so on, are passed as URL Parameters.
Headers
Add the Request Headers to be passed to the API as Key-Value pairs using this option. You can get this information from the API Documentation of the Sender. Add the Authorization Header.
Body Type
Choose the Body Type as JSON and add the following details:
{ "messages":[ { "destinations":[{"to":"Moesms_destination"}], "from":"RAPIDA", "text":"Moesms_message", "intermediateReport":"True", "notifyContentType":"application/json", "notifyUrl":"YourMoEngageAccountURL" }] }
Change the values of Sender_ID and YourMoEngageAccountURL based on your Infobip and MoEngage accounts.
- Send a test SMS to verify your configuration.
- Click Save to save the Sender Configuration.
- You can configure delivery tracking after creating the sender in the MoEngage Dashboard. For information about Delivery Tracking, refer to Delivery Tracking for Custom Connectors.
- You can map the attributes of the delivery tracking response manually or automatically.
-
Configure in Old UI
Log in to the MoEngage dashboard
- Navigate to Settings > Channel > SMS & Connectors.
- Click the SMS Connector Config tab.
- Under Custom Connecters, click +CREATE.
For International Customers
i. Sender Type
Promotional : Choose the Sender Type as Promotional when you would be using the Sender for sending information about your brand, promoting deals, or engaging with users.
Transactional : Choose the Sender Type as Transactional when you would be using the Sender for sending alerts about transactions, OTPs, security information, or any information that can be classified as transactional in nature.
ii. Connector Name :
This field identifies the Custom Connector you are configuring on the MoEngage Dashboard and has to be unique. Type the name of the connector here.Ex(RMLTransDomestic)
iii. Sender Name : This field identifies the Sender or header. Type the name of the sender here.
iv. Is Default Sender : User Choice(Select yes or No)
v. API URL: This is the base URL of the SMS service provider along with all the query parameters which can be used to call API to send SMS.
Dropdown Button : Select GET
vi. URL Parameters:
Key:
Username: The username of the HTTP account
Source: Sender ID
Password: The password of the HTTP account.
Dlr: Indicates whether the client wants a delivery report for this message. The values for dlr include: 0: No delivery report required 1: Delivery report required
Message: The message to be sent.
Destination: Mobile number to which the message is to be sent
Type: It indicates the type of message.
vii. Headers:
Add the Request Headers to be passed to the API as Key-Value pairs using this option. You can get this information from the API Documentation of the Sender. For example, Authorization Headers and Content-Type Headers are added as KV pairs depending on the Sender's API specifications.
Key: Application/JSON
Value: Add the Request Headers to be passed to the API as Key-Value pairs using this option. You can get this information from the API Documentation of the Sender. For example, Authorization Headers and Content-Type Headers are added as KV pairs depending on the Sender's API specifications.
viii. Configure Delivery Tracking : Users must add the Delivery Tracking URL to the callback webhook settings of the custom connector's dashboard. MoEngage generates a unique identifier called custom_connectorID under the SMS delivery tracking URL
For Indian Customers
i. Sender Type
Promotional: Choose the Sender Type as Promotional when you would be using the Sender for sending information about your brand, promoting deals, or engaging with users.
Transactional: Choose the Sender Type as Transactional when you would be using the Sender for sending alerts about transactions, OTPs, security information, or any information that can be classified as transactional in nature.
ii. Connector Name :
This field identifies the Custom Connector you are configuring on the MoEngage Dashboard and has to be unique. Type the name of the connector here.Ex(RMLTransDomestic)
iii. Sender Name : This field identifies the Sender or header. Type the name of the sender here.
iv. Is Default Sender : (Select yes or No)
v. API URL: This is the base URL of the SMS service provider along with all the query parameters which can be used to call API to send SMS.
Dropdown Button : Select GET
vi. URL Parameters:
Key:
Username: The username of the HTTP account
Dlr: Indicates whether the client wants a delivery report for this message. The values for dlr include: 0: No delivery report required 1: Delivery report required
Destination: Mobile number to which the message is to be sent
Temp id: This data corresponds to the content Template ID received when template is registered on DLT platform
Source: Sender ID
Message: The message to be sent.
Password: The password of the HTTP account.
Type: The password of the HTTP account.
Entityid: This will be a unique client identifier on DLT platform
vii. Headers:
Add the Request Headers to be passed to the API as Key-Value pairs using this option. You can get this information from the API Documentation of the Sender. For example, Authorization Headers and Content-Type Headers are added as KV pairs depending on the Sender's API specifications.
Key: Application/JSON
Add the Request Headers to be passed to the API as Key-Value pairs using this option. You can get this information from the API Documentation of the Sender. For example, Authorization Headers and Content-Type Headers are added as KV pairs depending on the Sender's API specifications.
Value: Add the Request Headers to be passed to the API as Key-Value pairs using this option. You can get this information from the API Documentation of the Sender. For example, Authorization Headers and Content-Type Headers are added as KV pairs depending on the Sender's API specifications.
viii. Configure Delivery Tracking :
Users must add the Delivery Tracking URL to the callback webhook settings of the custom connector's dashboard. MoEngage generates a unique identifier called custom_connectorID under the SMS delivery tracking URL
6. Click on SMS General Settings under SMS & CONNECTOR SETTINGS
i. SMS Subscription Management: SMS Subscription Management enables customers to opt-in or opt-out of receiving SMS notifications.
ii. Current Provider: Select the SMS provider from the drop-down
iii. User Attribute that stores user's mobile numbers: Select the standard attribute for the mobile number. The standard attribute name for the mobile number attribute is Mobile Number (Standard) in MoEngage. This is a standard attribute where MoEngage provides the name, and you provide the value.
iv: Preference Management : When the Subscription Management toggle is enabled, the configured preference management settings for SMS are overwritten. When the Subscription Management toggle is disabled, the preference management settings are set to 'Mobile Number(Standard) exists'.
7. Click on SUBSCRIPTION & KEYWORDS under SMS & CONNECTOR SETTINGS
Manage SMS Subscription & Keywords :
Keywords capture the user consent to subscribe (or receive) and unsubscribe (or not receive) SMS notifications. Keywords are used to get support or help with SMS alert subscriptions.
When the Manage SMS Subscription and Keywords Toggle is on, the custom keywords become enabled and must be configured. Auto-response messages for the respective keywords need to be configured.