Send SMS — India

Send SMS to Indian numbers with DLT fields, custom references, campaign tagging, and URL shortening.

Send SMS to Indian numbers. Messages go in an sms array, so one request can carry several.

This API covers India, and carries the DLT fields Indian traffic requires. For destinations outside India, use the SMS List API — a different host with a different authentication scheme. See how the two compare.

Endpoint

POST https://api.onexaura.com/send_sms

Call the endpoint over HTTPS. An http:// request is answered with a 301 redirect, and a client that does not follow redirects — or that follows one without re-sending the body — will appear to send nothing while reporting no error.

Headers

apikey · string · required

API key issued by OneXtel.

Content-Type · string · required

Must be application/json.

Example request

cURL

curl --location 'https://api.onexaura.com/send_sms' \
--header 'apikey: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
  "sms": [
    {
      "sender": "ONEXTL",
      "recipient": "919999999999",
      "templateId": "YOUR_DLT_TEMPLATE_ID",
      "entityId": "YOUR_DLT_ENTITY_ID",
      "type": "SI",
      "custRef1": "order-4821",
      "custRef2": "",
      "custRef3": "",
      "custRef4": "",
      "custRef5": "",
      "messageBody": "Hi {#var#}, your secure code is {#var#}. Click here {#var#}",
      "unicode": 0
    }
  ],
  "validation": false,
  "campaignName": "SpringPromo2026",
  "prefix": "+91",
  "urlShortener": {
    "flag": 1,
    "urlDetails": [
      {
        "longUrl": "https://example.com/offers/spring",
        "senderId": "ONEXTL",
        "domain": "links.example.com",
        "track_user": 1
      }
    ]
  }
}'

The sms array

The sms array carries one or more messages in a single call. Each object is one message.

sms[].sender · string · required

Sender ID. Must be DLT-approved — see DLT registration.

sms[].recipient · string · required

Recipient mobile number.

sms[].messageBody · string · required

Content of the SMS.

sms[].type · string · required

Message type: SI, OTP, or SE. Case-sensitive.

SI and SE correspond to the DLT consent categories Service Implicit and Service Explicit — see DLT registration.

sms[].templateId · string

DLT-approved template ID.

sms[].entityId · string

DLT entity ID.

sms[].unicode · integer

1 for a Unicode message, 0 for normal text. Required when sending Unicode.

sms[].custRef1 … custRef5 · string | object

Up to five custom references of your own, echoed back on the delivery report so you can match a receipt to your own record. Each slot takes either a plain string or a nested object:

"custRef1": "order-4821"

"custRef1": {
  "CustomReference1": "testSMS",
  "CustomReference2": "123"
}

The nested form lets one slot carry several values — useful when five slots are not enough, or when you want the pairs kept together.

The nested object form is supported on SMS only. WhatsApp and RCS take custom references as plain values. Sending an object on those channels is not supported.

The message type is ultimately determined by your API key configuration, regardless of the type you send in the request. If messages are being charged or routed as a different category than you expect, the API key is the thing to check — not the payload.

templateId and entityId are marked optional in the API, but DLT-regulated traffic in India will be rejected by the operator without them. Treat them as required for Indian destinations. See DLT registration.

Top-level fields

campaignName · string

Identifier used to group and track messages as a campaign. Set it if you want the send to be filterable in reports.

prefix · string

Country code applied to recipient numbers — for example +91.

validation · boolean

true rejects invalid requests outright; false processes them anyway.

Set validation to true while integrating. With false, a malformed request is accepted and fails silently downstream, which is far harder to diagnose than an upfront rejection.

URL shortener

Include the urlShortener object when your message contains a link you want shortened and tracked.

urlShortener.flag · integer

1 enables shortening, 0 disables it. Required if short-URL conversion is needed.

urlShortener.urlDetails[].longUrl · string

The original URL to shorten. Required when flag is 1.

urlShortener.urlDetails[].senderId · string

Sender ID associated with the shortened URL. Required when flag is 1.

urlShortener.urlDetails[].domain · string

Custom domain, if one is configured for your account. Required when flag is 1.

urlShortener.urlDetails[].track_user · integer

1 enables click tracking, 0 disables it. Required if location tracking is needed.

Click data captured this way appears in the Clicker Data and Clicker Details reports.

Response

A request with a valid API key returns HTTP 200, with one entry per message inside smslist.sms[]. The wrapper key is lowercase smslist.

Accepted

{
  "smslist": {
    "sms": [
      {
        "description": "Message submitted with tracking id ( UID )",
        "messageid": "3JLkExampleMessageId0000000",
        "status": 200
      }
    ]
  }
}

smslist.sms[].status · integer

Per-message result. 200 means the message was accepted for processing.

smslist.sms[].description · string

Outcome text — for an accepted message, the tracking-id confirmation.

smslist.sms[].messageid · string

Tracking ID for the accepted message.

Accepted is not delivered. A 200 entry means OneXtel accepted the message for processing — not that it reached the handset, and not that the recipient number is valid. Confirm the outcome from the delivery report.

Authentication errors

A request with an invalid API key is rejected with HTTP 401, before any message is read:

{
  "status": "Failed",
  "reason": "API_Invalid_Authorisation",
  "code": 401
}

Related

• DLR callback
• SMS error codes
• DLT registration