SMS API Documentation

Integrate powerful SMS functionality into your application — simple, fast, and scalable messaging APIs built for businesses of all sizes.

Steps to Integrate SMS API

1. Get API Key

Sign up and obtain your unique API credentials.

2. Integrate with Code

Use our documentation to connect your system.

3. Send SMS

Use API endpoints to send messages.

POST yourdomain.in/api/json/sendsms/
Headers
Key Value Description
key XXXX3d086XX API authentication key
content-type application/json Request content type
Request Body
{
    "listsms": [
        {
            "sms": "Sms content will come here...",
            "mobiles": "+919999999999",
            "senderid": "XXXXXX",
            "entityid": "1234567891112131415",
            "tempid": "111111111122222"
        },
        {
            "sms": "Sms content will come here...",
            "mobiles": "+918888888888",
            "senderid": "XXXXXX",
            "entityid": "1234567891112131415",
            "tempid": "1111111111111122"
        }
    ]
}
Optional Parameters
Parameter Type Description Example
unicode integer Unicode support 1
isShortUrl integer Enable short URL 1
clientsmsid integer Client SMS ID 1947692308
encryptContent integer Encrypt content 1
time string Schedule time YYYY-MM-DD HH:MM:SS
Response
{
    "smslist": {
        "sms": {
            "reason": "success",
            "code": "000",
            "clientsmsid": 1947692308,
            "messageid": 709462811,
            "mobileno": "+919999999999",
            "status": "success"
        }
    }
}
POST yourdomain.in/api/sendsms?key=$key&mobiles=$mobiles&sms=test%20sms&senderid=$senderid&entityid=$entityid&tempid=$tempid
Parameters
Parameter Value Description
key 6d6563d086XX API key
mobiles +91XXXX78XXXX Customer mobile number
sms TEST Message content
senderid XXXXXX Sender ID
entityid 1234567891112131415 Entity ID
tempid 1034567891112131819 Template ID
Optional Parameters
Parameter Type Description Example
unicode integer Unicode support 1
isShortUrl integer Enable short URL 1
clientsmsid integer Client SMS ID 2007
encryptContent integer Encrypt content 1
time string Schedule time YYYY-MM-DD HH:MM:SS
Response
{
  "smslist": {
    "sms": {
      "reason": "success",
      "code": "000",
      "clientsmsid": 1947692308,
      "messageid": 187449454,
      "mobileno": "+919999999999",
      "status": "success"
    }
  }
}
File Upload
POST yourdomain.in/api/uploadFile
Header
Key Value Description
key 6d6563d086XX API authentication key
Form Data
Key Value Description
file campaign.xlsx Excel file containing bulk campaign data
Response
{
    "headers": [
        "srno",
        "mobileno",
        "name",
        "url",
        "msg",
        "email"
    ],
    "message": "File Upload Successfully",
    "fileId": 4,
    "status": true
}
Bulk Push
POST yourdomain.in/api/bulk-push
Header
Key Value Description
key 6d6563d086XX API authentication key
content-type application/json Request content type
Request Body
{
    "campaingName": "Communication",
    "templateId": "111111111122222",
    "entityId": "1234567891112131415",
    "senderId": "XXXXXX",
    "message": "Sms content will come here... {#name#}",
    "fileId": "21",
    "mobilenoFiled": "2"
}
Parameter Value Description
unicode 1 Enable Unicode (e.g., Hindi, Gujarati)
countryCode 91 Country code of the recipient number
To schedule a campaign, both of the following parameters are required:
isSchedule 1 Set to 1 to enable scheduling
scheduleDateTime YYYY-MM-DD HH:MM:SS Date and time to schedule the campaign
Response
{
    "msg": "Campaign sent successfully",
    "status": "success"
}