API ReferenceMessages

Send RCS Message

Send a RCS message immediately or schedule it for future delivery.

Requires an active RCS agent and recipient devices that support RCS Business Messaging.

Authentication

PINNACLE-API-KEYstring
API Key authentication via header

Request

This endpoint expects an object.
TextobjectRequired
Send a text RCS message with optional quick reply buttons.
OR
MediaobjectRequired
Send a media RCS message with optional quick reply buttons.
OR
CardsobjectRequired

Send a cards RCS message with quick replies / buttons.

  • Quick replies are shared across all cards in the carousel
  • While buttons resemble quick replies, they remain on screen after being clicked and are card-specific.

Response

Successfully sent or scheduled the message. Use our [/messages/:id](./get) endpoint to track your message. <Accordion title="About RCS Fallback SMS Response and RCS Fallback MMS Response"> When you send an RCS message with a fallback configured, the API checks whether the recipient's phone supports RCS **before** sending. If the phone does not support RCS, the fallback SMS or MMS is sent immediately instead, and you receive one of these response types. You will receive message statuses for the fallback message at your configured webhooks and also receive a `FALLBACK_SENT` webhook event for the original RCS message. </Accordion>
RCS Sent Responseobject
OR
Scheduled Responseobject
OR
RCS Fallback SMS Responseobject
OR
RCS Fallback MMS Responseobject

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error
501
Not Implemented Error