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

Send a text RCS message with optional quick reply buttons.

MediaobjectRequired

Send a media RCS message with optional quick reply buttons.

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.

Send a cards RCS message with quick replies / buttons. - [Quick replies](/api-reference/messages/send-rcs#request.body.Cards.quickReplies) are shared across all cards in the carousel - While [buttons](/api-reference/messages/send-rcs#request.body.Cards.cards.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 endpoint to track your message.

RCS Sent Responseobject

Scheduled Responseobject

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

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

Authentication

Request

Response

Errors