Configure the callback
Register your endpoint in the OneXtel portal under Configuration → Add New Callback. Set the channel toRCS, 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.
