Sign in

v1

latestOpenAPI 3.1.02026-07-2616459400.5 KB
JSON Message

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.

post/v2/JsonSingleApi

Query parameters

feedidstring
Example:392095

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

jsonstring

Alternative way to pass JSON body as query parameter

Headers

X-SSL'1' | '2'

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

X-SSLIVstring

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

X-AES-KEYstring

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

Request body

feedidstring

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

usernamestring

Username or registered mobile number for authentication.

passwordstring password

Password associated with the username.

jobnamestring

Custom name assigned to the message batch for tracking.

shortstring

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

tzstring

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

timestring

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

mobilestring required

Comma-separated mobile numbers

messagesstring required

SMS message content (alias: message)

messagestring

SMS message content to be sent.

senderidstring

Sender ID

entityidstring

DLT entity ID

templateidstring

DLT template ID

async'0' | '1'

0 = sync (default), 1 = async

dlt_template_typestring

DLT template type

jobidstring

Job ID

mtypestring

Message type (1 = text)

urlstring

WAP URL for WAP push

udhstring

UDH for binary messages

hexflagstring

Hex flag for encoded messages

response_type'json' | 'xml'

Response format

DepIdstring

Department ID

AppIDstring

Application ID

sslstring

Encryption mode (when in JSON body)

sslivstring

IV (when message encrypted in JSON)

aesKeystring

AES key (when message encrypted in JSON)

Example request

{
  "feedid": "392095",
  "mobile": "9870524533,9956808517",
  "messages": "Your OTP is 456789"
}

Response

The request was processed successfully.