MessageBot Logo
Documentation

Overview

This documentation describes MessageBot SMS API endpoints for sending SMS (single & multiple), delivery report tracking (DLR), campaign reports, and approved sender verification. Each API supports both GET and POST methods with JSON responses.

Send SMS to Single Recipient

http://papi.messagebot.in/SendSmsV2

GET Request

http://papi.messagebot.in/SendSmsV2?apiToken=YOUR_TOKEN&messageType=2&messageEncoding=1&destinationAddress=917006822667&sourceAddress=STRZBT&messageText=Your OTP is 8977&userReferenceId=ABC123

POST Request

{
  "apiToken": "YOUR_TOKEN",
  "messageType": "2",
  "messageEncoding": "1",
  "destinationAddress": "917006822667",
  "sourceAddress": "STRZBT",
  "messageText": "One Time Password for account verification is 8977",
  "dltEntityId": "18",
  "dltEntityTemplateId": "8",
  "userReferenceId": "ABC123"
}

Parameters

ParameterRequiredDescription
apiTokenYesAuthentication token
messageTypeYes1 = Promotional, 2 = Transactional, 3 = OTP
messageEncodingYesMessage encoding format
destinationAddressYesRecipient mobile number
sourceAddressYesApproved sender ID
messageTextYesSMS content
dltEntityIdConditionalDLT entity ID (India DLT mandatory)
dltEntityTemplateIdConditionalDLT template ID
userReferenceIdNoCustom tracking ID

Response

{
  "MessageId": 3195701,
  "OperationCode": 0,
  "Status": "Success",
  "DlrStatus": null,
  "UserReferenceId": "ABC123",
  "DestinationAddress": "917006822667",
  "Remarks": "Message Submitted",
  "CallBackUrl": null
}

Fetch Delivery Report (DLR) Details

http://papi.messagebot.in/Dlr/GetDetails

GET Request

http://papi.messagebot.in/Dlr/GetDetails?apiToken=YOUR_TOKEN&messageId=3196185

POST Request

{
  "apiToken": "YOUR_TOKEN",
  "messageId": 3196185,
  "userDefinedId": "ABC123"
}

Response

{
  "IsSuccess": true,
  "ErrorCode": 0,
  "ErrorDescription": "OK",
  "ReturnData": [
    {
      "MessageId": 3196185,
      "DestinationAddress": "917006123394",
      "TextReceived": "Hello",
      "MessageType": "Transactional",
      "MessageLength": 5,
      "MessageParts": 1,
      "CustomerCost": 0.17,
      "DlrStatus": "Delivered",
      "ErrorCode": 1,
      "ErrorDescription": "No Error",
      "SentDateTime": "2025-02-24T06:22:04",
      "SmsId": "db15035c-da41-4f89-aa39-9b89f61d958a"
    }
  ]
}

Retrieve Campaign Details

http://papi.messagebot.in/Dlr/GetCampaignDetail

GET Request

http://papi.messagebot.in/Dlr/GetCampaignDetail?apiToken=YOUR_TOKEN&campaignId=16139&startDate=2025-02-24T09:00:00

POST Request

{
  "apiToken": "YOUR_TOKEN",
  "campaignId": 16139,
  "dlrStatus": "NULL",
  "startDate": "2025-02-24T09:00:00"
}

Response

{
  "IsSuccess": true,
  "ErrorCode": 0,
  "ErrorDescription": "OK",
  "ReturnData": [
    {
      "Id": 16139,
      "Name": "Fahad",
      "SubmissionDate": "2025-02-24T07:15:40",
      "TotalSms": 4,
      "DetailId": 2487562,
      "DestinationAddress": "917006123394",
      "DlrStatus": null
    }
  ]
}

Check Approved Senders List

http://papi.messagebot.in/sender/List

GET Request

http://papi.messagebot.in/sender/List?apiToken=YOUR_TOKEN

POST Request

{
  "apiToken": "YOUR_TOKEN"
}

Response

{
  "IsSuccess": true,
  "ErrorCode": 0,
  "ErrorDescription": "OK",
  "ReturnData": [
    {
      "CampaignSenderId": 271,
      "SenderId": "INFO",
      "CountryName": "India",
      "MessageTypeId": 2,
      "MessageTypeName": "Transactional",
      "StatusName": "Approved",
      "RequestedDateTime": "2025-02-24T01:27:47"
    }
  ]
}

Support

For technical assistance, contact sales@messagebot.in