Before proceeding to this, we would recommend you check how to create connector campaigns. You can use connectors to send SMS via any SMS Service provider.
Note: Gupshup is also available as an integrated provider on MoEngage dashboard.
Navigate to MoEngage Dashboard > Settings > SMS & Connectors, click SMS General Settings and fill in the required fields. For more details on how to use integrated providers, refer to this page
Set Delivery Callback URL for Integrated Gupshup Connector
Enter the MoEngage Delivery Tracking URL https://api-01.moengage.com/sms/dlr/gupshup and paste it under Real Time Delivery URL in Gupshup portal for the Transactional SMS Account. As per the latest DLT guidelines, delivery tracking for Promotional SMS is no more provided.
Note: The delivery tracking URL should be set as a GET request on Gupshup, contact your Gupshup account manager for setting it as a GET request.
Set Gupshup as a custom connector
Use the steps mentioned below if you want to set up SMS Gupshup API as a custom connector.
Before creating the campaign, ensure that you have UserId and Password for SMS Gupshup Account. These are the credentials to login into your Gupshup account. If you are not able to find these, reach out to your contact in Gupshup.
Then, Go to Settings > SMS & Connector > SMS Connector Config. On this page click "Create" corresponding to Custom Connectors
Set a name for the Connector and corresponding Sender. You can create multiple Senders corresponding to a Connector or SMS provider. Refer this page for more information on how to do this.
To create an SMS campaign, navigate to MoEngage Dashboard > Campaigns, click Create Campaign > Connector Campaigns and click Create.
We are quoting the below example using the API of SMS Gupshup to send simple (non-unicode) text SMS. You can read the complete API documentation for SMS Gupshup here.
Configure Webhook URL
Use GET Method to send the API request.
Webhook URL : Just copy this in Webhook URL Field : http://enterprise.smsgupshup.com/GatewayAPI/rest?method=SendMessage&send_to=918884664443&msg=This is a test message&msg_type=TEXT&userid=Username&auth_scheme=plain&password=Password&v=1.1&format=text
Once copied, URL params will be populated automatically. You should be able to see something like this:
Change value for these keys:
- Userid and Password - Set as per your account credentials
- send_to - In the send_to field, you can personalize [using @] it to select the user mobile number. Ensure that the selected attribute consists of the user mobile number with country code - 91.
If you are saving the Mobile Number without country code, prefix 91 to your selected attribute. e.g.
- msg - Configure the message that you would want to send in the msg text field above. Ensure that you use the approved template (approved by your SMS provider - Gupshup in this case) in the message (msg) for transactional type messaging.
- msg_type - Should be the text for plain text message; Should be unicode_text for Unicode messages.
Do a test SMS to make sure everything is set up correctly. And finally click Save to save the settings.
Now you are good to proceed with SMS Campaign creation. For more information about the steps to create an SMS Campaign, refer to this link.