SMS

SMS .

SMS APIs

SMS

Postman Collection

Send Sms

URL

POST : /v1/service/sms/send

Headers

Content-Type  (String)   required
application/json

Authorization  (String)   required
Basic Auth

Accept  (String)   required
application/json

Body Params

clientRefId  (Number)   Required
Unique Reference number (Max Length: 30)

templateId  (String)   Required
Temaplate ID (Max Length: 30)

shortUrl  (String)   Required
shortUrl (Max Length: 300)

recipients  (object)   Required
shortUrl (Max Length: 300)

Request

Example Request

    curl --location '/v1/service/sms/send' \
        --header 'Content-Type: application/json' \
        --header 'Authorization: Basic Og==' \
        --data '{
        "templateId": "66b74800d6fc05xxxxxxxx",
        "clientRefId": "ALSM202509xxx2768",
        "shortUrl": "0",
        "recipients": [
                {
                        "mobiles": "+917319xxxx",
                        "var1": "var1",
                        "var2": "598990"
                }
        ]
        
}'

Response Samples

SUCCESS

 {
       "code": "0x0200",
       "message": "success",
       "status": "SUCCESS",
       "data": {
               "message": "35696771706151516c613cccc",
               "type": "success"
       }
}

FAILED

    {
    "code": "0x0202",
    "status": "FAILURE",
    "message": "Sms not send."
}

Response Code

Status Code	Status	Message
0x0200	SUCCESS	TRANSACTION SUCCESSFULL
0x0201	UNAUTHORIZED	UNAUTHORIZED USER
0x0202	FAILURE	FAILURE USER
0x0203	MISSING_PARAMETER	MISSING PARAMETER
0x0204	CONNECTION_TIMEOUT	CONNECTION TIMEOUT
0x0205	SOMETHING_WENT_WRONG	SOMETHING WENT WRONG
0x0206	PENDING	TRANSACTION PENDING
0x0207	REVERSED	TRANSACTION REVERSED
0x0209	REDIRECT	REDIRECT URL