Send SMS via SMS Gupshup

Before proceeding to this, we would recommend you to check how to create connector campaigns.  You can use connectors to send SMS via any SMS Service providers.

Note: Gupshup is also available as an integrated provider on MoEngage dashboard. This means you can directly go to SMS settings page on MoEngage dashboard, fill in the required fields and you are good to go. For more details on how to use integrated providers, please check this page 

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.

To create a SMS campaign, move to Create Campaign and go to Connectors. Click on Create custom connector.

Step 1: 

Add a suitable name for your campaign (e.g. you are creating a campaign to send out SMS)

Choose the Sending Type as per your use case. Say you want to trigger a SMS to customers who have done a certain event but have not received/clicked the notification sent to them, choose sending type as At trigger event.

Choose the target audience once you have decided the sending type. You can target all the users or users who fulfill certain user criteria/behavior criteria.

Step 2:

We are quoting below example using API of SMS Gupshup to send simple (non-unicode) text SMS. You can read 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 : 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 send_to field, you can personalize [using @] it to select user's mobile number. Ensure that selected attribute consists of user's 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 text for plain text message; Should be unicode_text for unicode messages.

Note: Before sending SMS campaign to your users, please ensure that 2 or more active/installed users are not mapped to same Mobile Number. If they are, those users will receive multiple SMSs. You can avoid that by choosing Mobile Number as De-dup key in Step 3.


Once you are done with campaign, you will be take to campaign analytics page. Analytics will be generated with-in an hour from the time your campaign starts sending. 

Read more about campaign analytics.

Was this article helpful?
1 out of 6 found this helpful