Introduction
Whush is a CPaaS platform offering services such as SMS, IVR/OBD, and WABA to enable businesses to have efficient communication with their customers. Offerings of Whush are comprehensive and end-to-end where a business can trust us from DLT registration to campaign management, using the right channel at the right time.
Configure Whush as a Custom SMS Connector (Service Provider)
This article helps you configure Whush as a Custom SMS Connector (Service Provider) on the MoEngage platform for businesses that use MoEngage for their communication campaign scheduling.
info |
Information We've revamped our dashboard settings. This article describes the steps to be followed to configure Whush as a 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.
- On the Sender Configuration tab, click + Add Sender. The Add sender page is displayed.
- In step 1 "Service Provider", click + Add custom service provider. The Add Custom Connector sender page is displayed.
- Add the following details in step 2 "Sender Details":
Field Description Mark as default
Turn this toggle on to mark the sender as the default sender for the service provider being configured. If marked as default, this sender will 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.
Enter “Whush”.
Sender name
This field identifies the sender.
Enter “Whush”.
Sender type
Select the sender type. Available options are:
- Transactional: Select this option to use the sender for sending alerts about transactions, OTPs, security information, or any information that can be classified as transactional in nature.
- Promotional: Select this option to use the sender for sending information about your brand, promoting deals, or engaging with users.
- 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. Enter the API Endpoint of the sender here. The API URL for Whush is:
https://whush.pludous.com/whush-send-sms
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
Enter the following code:
curl --location 'https://api.whush.io/api/v1/one2One' \
--header 'Content-Type: application/json' \
--header 'apikey: A2D31FB9BA1C7E1356FF' \
--data '{
"credentials": {
"password": "apimo",
"user": "apimo"
},
"options": {
},
"unicode": "false",
"from": "CRDHAT",
"shortMessages": [
{
"recipient": "Number",
"corelationId": "0e6503aa-1ac7-4a0c-9819-beb69cfdedca",
"message": "Template"
}
]
}' - Click Send 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 and follow these steps:
- On the MoEngage Dashboard, navigate to Settings > Channel > SMS & Connector and click SMS CONNECTOR CONFIG tab.
- Under Integrated Connectors, click + CREATE beside Custom Connectors.
- Enter the following details:
Field Description Connector Name Type the name to identify the Whush custom connector.
Enter "Whush".
Sender name
Type the name to identify the Whush sender.
Enter "Whush".
- In the API URL field, enter the following URL:
https://whush.pludous.com/whush-send-sms
- Click Send 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 in Custom Connectors.
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.
- Read more about campaign analytics.