Skip to main content
OneXtel pushes RCS delivery status and user events to an endpoint you host. Register the endpoint against your API key, and every message you send reports back its outcome — delivered, failed, or a user interaction such as a suggestion tap.

Configure the callback

Register your endpoint in the OneXtel portal under Configuration → Add New Callback. Set the channel to RCS, choose the event type you want to receive, set the HTTP method to POST, and enter your endpoint URL. The callback is bound to the API key you select, so a key without a registered callback sends messages but reports no status.

Parameters

None of the parameters are individually mandatory, but at least one must be configured for the callback to be valid. Select the fields you want in the callback configuration; only those are included in the payload.
string
Unique authentication key used to identify and authorize the API request.
string
Identifier of the bot that handled or triggered the message or event.
string
Unique ID assigned to the message for tracking. Use it to correlate the callback with the messageId returned when you sent the message.
string
Event type received in the callback — for example USER_EVENT.
string
Actual message text or payload sent, or attempted to be delivered.
string
Timestamp when the message was originally sent.
string
Name or ID of the entity sending the message.
string
Phone number from which the message was sent.
string
Recipient’s phone number.
string
Error code returned when message delivery fails. See RCS operator error codes for what each value means and whether a retry is worthwhile.
string
Description of the error associated with errCode.
string
Custom reference field 1, used for client-specific metadata.
string
Custom reference field 2, used for client-specific metadata.
string
Custom reference field 3, used for client-specific metadata.
string
Custom reference field 4, used for client-specific metadata.
string
Custom reference field 5, used for client-specific metadata.
The custref1–custref5 fields are echoed back exactly as you set them on the original send, which makes them the simplest way to carry your own campaign or order identifiers through to the callback. See Send messages.

Sample payloads

The incoming payload is what OneXtel receives from the RCS platform. The outgoing payload is what OneXtel posts to your endpoint — this is the one your handler must parse.
The outgoing sample sends the key as api_key, while the parameter table names it apiKey. The sample also carries a tuc_id field that is not in the parameter list. Both are reproduced as documented — confirm the exact field names against a live callback before you write strict parsing.