send

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.

post/send/rcs

Request

  • Base URL: https://www.trypinnacle.dev/api
  • URL: https://www.trypinnacle.dev/api/send/rcs
  • Auth: API key in header PINNACLE-API-Key

Request body

fromstring required

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.

tostring required

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

textstring

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.

mediaUrlstring uri

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.

statusCallbackstring uri

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 required

The unique ID of the sent message.

messagestring required

A message indicating the status of the sent message.

Changes

No recorded changes to this operation across all 1 revision of this API.