Send Non-Template Messages

Send free-form (non-template) RCS content through the same Send Message endpoint used by all OneXtel channels. Non-template messages build the content directly in the request body, instead of referencing a pre-approved templateCode.

Endpoint

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

string

required

Your OneXtel API key.

string

required

Must be application/json.

Request structure

Every request wraps one or more message objects in an rcs array:

{
  "rcs": [ { /* messageObject */ } ],
  "prefix": "+91",
  "urlShortener": { /* optional */ }
}

array

required

Array of RCS message objects to send.

string

Country code prefix (e.g. +91) applied to recipient numbers that don’t already include one.

object

Optional. Shortens and tracks links inside the message. See URL shortener.

Message object (`rcs[]`)

string

required

Message category: Promotional, Transactional, or OTP.

string

required

Recipient phone number, without the prefix.

string

required

RCS sender/bot ID.

object

required

Holds the message body — one of text or richCard for non-template messages.

string

Time-to-live for the message (e.g. "1200s"). Provide only one of ttl or expireTime.

string

Absolute expiry time in UTC/Zulu format (e.g. "2024-10-02T15:01:23Z"). Provide only one of ttl or expireTime.

string

Optional custom reference field. Up to custref6 is accepted for plain text messages, and custref1–custref5 for rich card messages.

ttl and expireTime are mutually exclusive — provide at most one.

Message types

Plain Text
RichCard Standalone
RichCard Carousel

The simplest non-template message: a text field inside contentMessage.

string

required

The plain text content of the message.

string

Optional URL of a file to attach alongside the text.

Request

{
  "rcs": [
    {
      "messageType": "Promotional",
      "recipient": "919999999999",
      "sender": "your_rcs_sender",
      "contentMessage": {
        "text": "Your OTP is 482913"
      },
      "custref1": "",
      "custref2": "",
      "custref3": "",
      "custref4": "",
      "custref5": "",
      "custref6": ""
    }
  ],
  "prefix": "+91"
}

cURL

curl --location 'https://api.onexaura.com/oapi/send_sms' \
--header 'apikey: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
  "rcs": [
    {
      "messageType": "Promotional",
      "recipient": "919999999999",
      "sender": "your_rcs_sender",
      "contentMessage": {
        "text": "Your OTP is 482913"
      }
    }
  ],
  "prefix": "+91"
}'

A plain text message can also carry a ttl (e.g. "1200s") alongside contentMessage.text to set an expiry — provide only one of ttl or expireTime.

A single rich card with a title, description, media, and optional suggestion chips.

string

required

VERTICAL or HORIZONTAL.

string

Applicable only for HORIZONTAL orientation: LEFT (default) or RIGHT.

string

required

Title text displayed on the card.

string

required

Body/description text displayed on the card.

string

Applicable only for VERTICAL orientation: SHORT, MEDIUM (default), or TALL.

string

required

Publicly accessible URL of the media file (image, GIF, or video). A fileName returned by the Media Upload API can be used here.

string

Optional URL of a thumbnail image to display before the media loads.

array

Optional list of reply or action suggestion chips. See Suggestions below.

Request

{
  "rcs": [
    {
      "messageType": "Promotional",
      "recipient": "919999999999",
      "sender": "your_rcs_sender",
      "contentMessage": {
        "richCard": {
          "standaloneCard": {
            "cardOrientation": "VERTICAL",
            "cardContent": {
              "title": "Electronics Offer",
              "description": "Flat 20% off, this weekend only.",
              "media": {
                "height": "TALL",
                "contentInfo": {
                  "fileUrl": "https://example.com/media/offer.jpg",
                  "thumbnailUrl": "https://example.com/media/offer_thumb.jpg"
                }
              },
              "suggestions": [
                {
                  "reply": {
                    "text": "Suggestion #1",
                    "postbackData": "suggestion_1"
                  }
                },
                {
                  "action": {
                    "text": "Shop Now",
                    "postbackData": "shop_now",
                    "openUrlAction": {
                      "url": "https://example.com/shop",
                      "application": "BROWSER"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "custref1": "",
      "custref2": "",
      "custref3": "",
      "custref4": "",
      "custref5": ""
    }
  ],
  "prefix": "+91"
}

cURL

curl --location 'https://api.onexaura.com/oapi/send_sms' \
--header 'apikey: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{"rcs":[{"messageType":"Promotional","recipient":"919999999999","sender":"your_rcs_sender","contentMessage":{"richCard":{"standaloneCard":{"cardOrientation":"VERTICAL","cardContent":{"title":"Electronics Offer","description":"Flat 20% off, this weekend only.","media":{"height":"TALL","contentInfo":{"fileUrl":"https://example.com/media/offer.jpg"}}}}}}}],"prefix":"+91"}'

Multiple cards in a single message, each with its own title, description, and media.

string

required

Carousel width: MEDIUM_WIDTH or SMALL_WIDTH (documented in the JSON sample as MEDIUM — confirm the exact enum with OneXtel support before going live).

array

required

Array of card objects, each with title, description, and media.

string

required

Title of the carousel card.

string

required

Description text below the title.

string

required

SHORT, MEDIUM, or TALL.

string

required

URL of the media file. A fileName generated by the Media API can be used here.

boolean

Whether to bypass cached media and force a re-fetch.

Request

{
  "rcs": [
    {
      "messageType": "Transactional",
      "recipient": "919999999999",
      "sender": "your_rcs_sender",
      "contentMessage": {
        "richCard": {
          "carouselCard": {
            "cardWidth": "MEDIUM",
            "cardContents": [
              {
                "title": "New York Store",
                "description": "Visit us in NYC and grab exciting deals!",
                "media": {
                  "height": "TALL",
                  "contentInfo": {
                    "fileUrl": "https://example.com/media/nyc.jpg",
                    "forceRefresh": false
                  }
                }
              },
              {
                "title": "Chicago Store",
                "description": "Exclusive offers this week.",
                "media": {
                  "height": "SHORT",
                  "contentInfo": {
                    "fileUrl": "https://example.com/media/chicago.jpg",
                    "forceRefresh": false
                  }
                }
              }
            ]
          }
        }
      },
      "custref1": "",
      "custref2": "",
      "custref3": "",
      "custref4": "",
      "custref5": ""
    }
  ],
  "prefix": "+91"
}

cURL

curl --location 'https://api.onexaura.com/oapi/send_sms' \
--header 'apikey: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{"rcs":[{"messageType":"Transactional","recipient":"919999999999","sender":"your_rcs_sender","contentMessage":{"richCard":{"carouselCard":{"cardWidth":"MEDIUM","cardContents":[{"title":"New York Store","description":"Visit us in NYC and grab exciting deals!","media":{"height":"TALL","contentInfo":{"fileUrl":"https://example.com/media/nyc.jpg","forceRefresh":false}}}]}}}}],"prefix":"+91"}'

Suggestions

cardContent.suggestions (rich card standalone) accepts a list of quick-reply or action chips. Reply suggestion:

{
  "reply": {
    "text": "Suggestion #1",
    "postbackData": "suggestion_1"
  }
}

Action suggestion (Open URL):

{
  "action": {
    "text": "Shop Now",
    "postbackData": "shop_now",
    "openUrlAction": {
      "url": "https://example.com/shop",
      "application": "BROWSER",
      "webviewViewMode": "FULL"
    }
  }
}

Field	Values	Description
`application`	`BROWSER` (default), `WEBVIEW`	How to open the URL.
`webviewViewMode`	`FULL` (default), `TALL`, `HALF`	Webview size, only applicable when `application` is `WEBVIEW`.

URL shortener

Set urlShortener at the top level (alongside rcs and prefix) to shorten and optionally track links referenced in the message.

integer

1 to enable URL shortening, 0 to disable.

array

Array of URLs to shorten.

string

required

The original full URL to shorten.

string

Sender ID or bot ID associated with the message (matches your RCS sender).

string

Custom domain to use for the shortened link.

boolean

Whether to enable user-level click tracking. Default: disabled.

string

Optional expiry for the shortened URL.

Response

[
  {
    "messageId": "33mXmXf0myfFe7lA1QpPcDJcVaH",
    "code": 200,
    "status": "success"
  }
]

string

Unique identifier for the submitted message. Use it to correlate delivery reports.

integer

Result code. 200 indicates the message was accepted.

string

Result status, e.g. success.

Depending on the TUC (tenant/use-case) configuration, additional fields such as recipient, sender, and custref1–custref5 may be dynamically added to each response object.

Error codes

These are the OneXtel API validation errors, returned when the request is rejected before it reaches the operator. For failures raised downstream by the recipient’s RCS platform, see RCS operator error codes.

Error	Response Status	Error Description
Invalid Method	405	`API_Method_Not_Allowed`
Missing Body	400	`API_No_Content`
Invalid Body	400	`API_JSON_Decode_format_not_supported`
Missing ApiKey	401	`API_Invalid_Auth_Key`
Missing url_shortener flag	400	`API_Missing_Url_Shortner_Flag`
Unknown Request	404	`API_Unknown_Request`
Invalid Channel for TUC	400	`API_Route_WA/RCS_Not_Allowed_on_TUC`
Invalid ApiKey	401	`API_Invalid_Authorisation`
Empty SMS Body	400	`API_Empty_Body_Sms_Payload`
Empty RCS Body	400	`API_Empty_Body_RCS_Payload`
Invalid SMS Body	400	`API_Invalid_Sms_Details`
Invalid RCS Body	400	`API_Invalid_RCS_Details`
Missing Recipient	400	`API_Missing_Recipient`
Missing Sender	400	`API_Missing_Sender`
Invalid TemplateName-Sender	400	`API_Invalid_Sender`
Invalid MsgType (RCS)	400	`API_Invalid_Message_Type`
Missing MsgType (RCS)	400	`API_Missing_Message_Type`

For sending pre-approved template messages instead of free-form content, see Send template messages.

WhatsApp

RCS

SMS (India)

SMS (International)

OmniChannel

Verify

Send Non-Template Messages

Endpoint

Request structure

Message object (`rcs[]`)

Message types

Suggestions

URL shortener

Response

Error codes

​Endpoint

​Request structure

​Message object (rcs[])

​Message types

​Suggestions

​URL shortener

​Response

​Error codes

Endpoint

Request structure

Message object (`rcs[]`)

Message types

Suggestions

URL shortener

Response

Error codes