Send single SMS (JSON)

Send a single SMS to one or more recipients via JSON request body.

Key Features:

  • JSON request/response format
  • Optional AES-256 GCM encryption for in-transit security (set X-SSL: 2 header)
  • Supports synchronous or asynchronous processing
  • DLT/TRAI compliant messaging

Encryption Mode (X-SSL=2):
When encryption is enabled, the entire request body is AES-256 GCM encrypted.
IV and AES key can be provided in headers (X-SSLIV, X-AES-KEY) or fetched from DB using feedid.
The feedid query parameter is required when using encryption.

JSON via query parameter:
Alternatively, the JSON payload can be passed as the json query parameter instead of in the request body.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Account/Feed ID. Required when using X-SSL=2 (encrypted body). Used to fetch IV/AES key from DB when not provided in headers.

string

Alternative way to pass JSON body as query parameter

Body Params
string

Account/Feed ID used for authentication and required for encryption key retrieval.

string

Username or registered mobile number for authentication.

password

Password associated with the username.

string
length ≤ 50

Custom name assigned to the message batch for tracking.

string
Defaults to 0

URL shortener flag: 0 = off (default), 1 = on

string

Timezone for scheduled time (e.g. GMT+05:30)

string

Future publish time (yyyymmddhhmm or yyyy-MM-dd HH:mm)

string
required

Comma-separated mobile numbers

string
required

SMS message content (alias: message)

string

SMS message content to be sent.

string

Sender ID

string

DLT entity ID

string

DLT template ID

string
enum
Defaults to 0

0 = sync (default), 1 = async

Allowed:
string

DLT template type

string

Job ID

string

Message type (1 = text)

string

WAP URL for WAP push

string

UDH for binary messages

string

Hex flag for encoded messages

string
enum

Response format

Allowed:
string

Department ID

string

Application ID

string

Encryption mode (when in JSON body)

string

IV (when message encrypted in JSON)

string

AES key (when message encrypted in JSON)

Headers
string
enum

Set to 2 for AES-256 GCM encrypted body. Requires feedid in query.

Allowed:
string

IV for AES decryption (else fetched from DB by feedid)

string

AES key for decryption (else fetched from DB by feedid)

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json