What you need
1
An approved RCS sender
An RCS sender is the branded identity (name, logo, colour, contact details) that recipients see. Create one with Create an RCS sender and poll Sender status until it is approved. The RCS senders page walks through the registration.
2
Use the sender as the from value
For
channel: "rcs", from is the sender’s senderName, not a phone number.3
Decide on SMS fallback
Recipients without RCS cannot receive the rich message. Set
failoverToSms: true to deliver the text as SMS instead - this needs an SMS-capable number on your account for the route. See SMS.Send an RCS message with buttons
Response - 201 Created
Request fields for RCS
Suggestion buttons
Each entry inrcsSuggestions is one button under the message. text is the label the recipient sees and postbackData is the value returned to you when the button is tapped. The remaining fields depend on type:
The
rcsSuggestions array is passed to the RCS platform as sent.
Fall back to SMS
WithfailoverToSms: true, when the RCS send is rejected - typically because the handset is not RCS-enabled - Vobiz sends the same text as SMS on the same route. The result is a single message record with channel: "sms" and status: "sent", and the call returns 201 Created. Buttons and media are RCS features and are left out of the SMS.
Without failoverToSms, a rejected RCS send is stored with status: "failed" and the reason in errorMessage, and the call returns 202 Accepted.
An RCS message that falls back to SMS is billed as SMS.
Check reachability first
RCS reachability asks the RCS platform whether a number can receive RCS from your sender. Use it to pick RCS or SMS before you send, or to decide whether to spend on rich media.cURL
Response - 200 OK
from and to are both required (400 {"error":"from and to are required"}). from must be an RCS sender so the request can be routed to the RCS platform.
Receive button taps and replies
When a recipient taps aREPLY button or types a reply, Vobiz stores an inbound message with direction: "in" and status: "received" in the conversation between your sender and that number. For a button tap the inbound message carries the button’s postbackData, so you can branch on the value you set (pickup_now_4821) instead of parsing free text.
Receive these in real time with the message.received webhook event or over the WebSocket.
Statuses
RCS uses the same statuses as SMS:sent, delivered, failed, unknown for outbound and received for inbound, with statusHistory on Retrieve a message. An RCS send is a single segment. See SMS statuses.
Before you go live
RCS senders
Create and verify the sender you send from.
Compliance overview
Register the numbers your SMS fallback uses.
Related
RCS senders
Register and manage the branded sender your messages come from.
Send a message
Every request field, response and error code.
RCS reachability
Endpoint reference for the reachability check.
Conversations
Where replies and button taps are stored.