Send RCS Message | Pinnacle

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

MediaobjectRequired

CardsobjectRequired

Response

Successfully sent or scheduled the message.

Use our /messages/:id endpoint to track your message.

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.

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

Scheduled Responseobject

RCS Fallback SMS Responseobject

Returned when a fallback is configured and the recipient does not support RCS. The API checks RCS capabilities at send time. If the recipient’s device doesn’t support RCS, the fallback SMS is sent instead. You will also receive a FALLBACK_SENT webhook event for the original RCS message.

RCS Fallback MMS Responseobject

Returned when a fallback is configured and the recipient does not support RCS. The API checks RCS capabilities at send time. If the recipient’s device doesn’t support RCS, the fallback MMS is sent instead. You will also receive a FALLBACK_SENT webhook event for the original RCS message.

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

1	import { PinnacleClient } from "rcs-js";
2
3	async function main() {
4	const client = new PinnacleClient({
5	apiKey: "YOUR_API_KEY_HERE",
6	});
7	await client.messages.rcs.send({
8	from: "agent_pinnacle",
9	fallback: {
10	from: "+14155164736",
11	text: "Check out our website for more information! Visit: https://www.pinnacle.sh/",
12	},
13	options: {
14	validate: false,
15	},
16	to: "+14154746461",
17	quickReplies: [
18	{
19	type: "openUrl",
20	payload: "https://www.pinnacle.sh/",
21	title: "Open Url",
22	},
23	],
24	text: "Check out our website for more information!",
25	});
26	}
27	main();

1	{
2	"messageId": "msg_1234567890",
3	"segments": 1,
4	"totalCost": 0.03,
5	"sender": "agent_pinnacle",
6	"recipient": "+14154746461",
7	"status": "queued"
8	}