RCS Messaging Overview

The RCS API creates and fetches templates, sends messages, and reports what happened to each one. Everything is a JSON request over HTTPS, authenticated with your OneXtel API key, so it fits whatever your campaigns are already triggered from. Start by copying your API key from the portal. The endpoints below are the whole surface: templates, sends, and the callbacks that carry delivery status back.

Authentication

Every request is authenticated with your API key passed in the apikey request header:

--header 'apikey: YOUR_API_KEY'

JSON endpoints also require:

--header 'Content-Type: application/json'

Base URL

https://api.onexaura.com

Endpoints

API	Method	Endpoint
Create Template	POST	`/rcs/templates`
Fetch Templates	POST	`/oapi/templates/fetch`
Send Template Message	POST	`/oapi/send_sms`
Send Non-Template Message	POST	`/oapi/send_sms`
Media Upload	POST	`/rcs/mediaupload`
Opt-in / Opt-out	GET/POST/DELETE	`/opt/{in,out}/rcs`
Delivery Notification	POST	Your endpoint

Failures fall into two layers: OneXtel API validation errors are listed under Send messages, and errors raised downstream by the recipient’s operator are listed under RCS operator error codes.

The RCS Send Message API and Fetch Template API share the same endpoints as the other OneXtel channels (/oapi/send_sms, /oapi/templates/fetch). The channel is determined by the request body: RCS messages are wrapped in an rcs array, and template fetches set "channel": "RCS".

Message types

Every RCS message is classified with a messageType of Promotional, Transactional, or OTP. You can send two kinds of message bodies through the Send Message API:

Non-template messages — free-form content built in the request itself: plain text, rich card standalone, and rich card carousel.
Template messages — pre-approved templates referenced by templateCode, optionally personalized with customParams. See Send template messages.

Response format

The Send Message API returns an array with one result object per message:

[
  {
    "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.

WhatsApp

RCS

SMS (India)

SMS (International)

OmniChannel

Verify

RCS Messaging Overview

Authentication

Base URL

Endpoints

Message types

Response format

​Authentication

​Base URL

​Endpoints

​Message types

​Response format

Authentication

Base URL

Endpoints

Message types

Response format