Getting Started

Prerequisites to connect to API

To start using the Gupshup Enterprise SMS API, you should have:

• User ID & password. If you don’t have an account, you can create one at Gupshup Enterprise SMS.
• DLT template with messages for customers.

Authentication

Gupshup Enterprise SMS API supports only a Plain Authentication Scheme for users. This authentication scheme requires only the user ID and password. The connection security is provided through HTTPS protocol.

In addition to SSL, the API is designed to allow you to securely send sensitive data to the Gupshup platform by encrypting the data using Advanced Encryption Standard i.e. AES 256-bit encryption. At​ your request (please reach out to us at 022 42006799 or email us, a 256-bit symmetric key is generated by Gupshup and set up for your account.

You must use this key to encrypt API parameter values when sending the API request. Once the request is received by Gupshup, the payload is decrypted by Gupshup and sent ahead to the operator.

Managing DLT templates

Distributed ledger technology or DLT is a digital structure for retaining and handling the records of sender identities and templates. Every SMS text and your ID has to be submitted on the DLT SMS platform before sending Bulk SMS to your customers. After you have completed registration with any of the DLT operator platform (Jio, Vodafone, Airtel, Videocon, MTNL, BSNL), you need to send us the principalEntityId, Sender Header, dltTemplateId, template type, and SMS content.

Encoding message

Gupshup recommends you to encode your text message. Only the English language SMS can be sent without encoding the message. If you need to send SMS in different languages, then it's mandatory to encode your message.

📘

Currently Gupshup supports SMS in Hindi language only.

The message should be UrlEncoded (also known as percent encoding) string of UTF-8 characters.

For more information on URL encoding, please see this.

Example:
Original text
Hi Amar!
Happy Diwali to you
Regards,
[email protected]

Encoded text
Hi%20Amar%21%0AHappy%20Diwali%20to%20you%0ARegards%2C%0Ank%40w.com

Get your first call

Prerequisites

1. Gupshup Enterprise SMS User ID and password
2. DLT template information

Test your connection

1. Login to Gupshup Enterprise SMS with above credentials.

2. Send API request through web browser in the following format:

https://enterprise.smsgupshup.com/GatewayAPI/rest?userid=USER ID RECEIVED FROM GUPSHUP&password=PASSWORD RECEIVED FROM GUPSHUP&send_to=RECEIVER MOBIL NUMBER&msg=your text message&method=SendMessage&msg_type=text&format=text&auth_scheme=plain&v=1.1

Success Response

Successful execution of the request will generate an HTTP 200 response. The response to any request is a string
of tokens separated by pipe symbol (|).

A typical success response is:

success | 919XXXXXXXXX| 728014710863298817-1234567890

This indicates that the message request has been successfully accepted for mobile number 91XXXXXXXXXX under the Unique Identifier ‘728014710863298817-1234567890’. The identifier string is unique for each recipient number and is auto-generated at the time of message submission. The first number is the transaction ID and the second one is the message ID.

Failure Response

An error response is generated when any of the required parameters is not specified correctly. The error response
will indicate an error code along with the actual error message.

A typical error response is:

error | 102 | Authentication failed due to invalid userId or password.

Messages and text characters ratio

Refer to this table to know your customer will receive how many messages when you send any particular message. The calculation of the number messages is based on the number of characters in a text message.