Send RCS Message API Reference

Serverhttps://api.pinnacle.sh/

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

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

Authorization

Pinnacle API key

PINNACLE-API-KEY<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Type

Send a text RCS message with optional quick reply buttons.

fromstring

Your RCS agent ID which must be prefixed with 'agent_'.

Match

^agent_.*$

Example

"agent_pinnacle"

Fallback MessageOptional

SMS/MMS fallback message to send if the RCS message fails to deliver.

When a recipient's device doesn't support RCS, this fallback message will be sent as SMS or MMS instead. The fallback is sent from the specified phone number.

Note: At least one of text or mediaUrls must be provided. Fallback messages require a verified from phone number with SMS/MMS sending capabilities.

Billing: You will be charged the standard SMS or MMS rate for the fallback message. The original RCS message will not be charged if the fallback is sent instead.

objectOptional

Configure how your RCS message is sent and tracked.

tostring

Recipient's phone number in E.164 format.

Example

"+14155550142"

array<6 variants>Optional

List of interactive quick reply buttons in the message.

Limit: 10 max

Items

items <= 10

textstring

Text content of the RCS message.

Length

length <= 3000

Example

"Hello from Pinnacle!"

Response Body

`application/json`

Pinnacle client libraries

import { PinnacleClient } from "rcs-js";

const client = new PinnacleClient({
  apiKey: process.env.PINNACLE_API_KEY!,
});

await client.messages.rcs.send({
    text: "text",
    from: "from",
    to: "to"
});

Responses

{  "messageId": "msg_1234567890",  "segments": 1,  "totalCost": 0.03,  "recipient": "+14154746461",  "sender": "agent_pinnacle",  "status": "queued"}

Send RCS Message

Request body

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Try asking

Send RCS Message

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

401application/json

402application/json

403application/json

404application/json

500application/json

501application/json

Example Send RCS Response

Scheduled Response

Fallback SMS sent when recipient is not RCS-capable

Fallback MMS sent when recipient is not RCS-capable

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`