API ReferenceSend a Message

RCS Message

Send an interactive RCS message with text, media, or cards. Each message can only contain either text, media, or card(s).

Quick replies can also be added to the message.

Headers

PINNACLE-API-KeystringRequired

Request

This endpoint expects an object.
fromstringRequired

The id of the RCS agent sending the message.

Use ‘test’ if you want to send from the Pinnacle test agent. The test agent can only send to whitelisted test numbers.

See https://dashboard.trypinnacle.app/settings/test-numbers to whitelist a number.

tostringRequiredformat: "^\+\d{11}$"

The recipient’s RCS-enabled phone number in E.164 format (e.g., +12345678901).

textstringOptional

Text content of the message.

Make sure you have either ‘text’, ‘mediaUrl’, or ‘cards’. An error will be thrown if multiple (i.e. both ‘text’ and ‘mediaUrl’) is provided.

mediaUrlstringOptional

Media URL to be included in the message.

Make sure you have either ‘text’, ‘mediaUrl’, or ‘cards’. An error will be thrown if multiple (i.e. both ‘text’ and ‘mediaUrl’) is provided.

cardslist of objectsOptional

List of rich cards. Maximum of 10 cards.

Make sure you have either ‘text’, ‘mediaUrl’, or ‘cards’. An error will be thrown if multiple (i.e. both ‘text’ and ‘mediaUrl’) is provided.

quickReplieslist of objectsOptional

Optional list of quick reply actions (max 10).

fallbackobjectOptional
statusCallbackstringOptional

Optional URL to receive a POST request when the message status changes. Read more about status callbacks here.

Response

RCS/Fallback message sent successfully

messageIdstring
The unique ID of the sent message.
messagestring
A message indicating the status of the sent message.

Errors