Blast RCS to Audience | Pinnacle

Send an RCS message to all contacts in an audience.

Messages are distributed evenly across the provided RCS agents for load balancing. Requires active RCS agents and recipient devices that support RCS Business Messaging.

Use the optional schedule parameter in options to schedule the blast for future delivery. When scheduled, the response will contain a scheduleId instead of blast details.

Send an RCS message to all contacts in an audience. <br> Messages are distributed evenly across the provided RCS agents for load balancing. Requires active RCS agents and recipient devices that support RCS Business Messaging. <br> Use the optional `schedule` parameter in `options` to schedule the blast for future delivery. When scheduled, the response will contain a `scheduleId` instead of blast details.

Authentication

PINNACLE-API-KEYstring

API Key authentication via header

Request

This endpoint expects an object.

audienceIdstringRequiredformat: "^aud_"

The audience ID to send the blast to. This identifier is a string that always begins with the prefix aud_, for example: aud_abc123.

You can create an audience via the dashboard or API.

The audience ID to send the blast to. This identifier is a string that always begins with the prefix `aud_`, for example: `aud_abc123`. <br> You can create an audience via [the dashboard](https://app.pinnacle.sh/dashboard/audiences) or [API](/api-reference/audiences/create).

senderslist of stringsRequired

Array of RCS agent IDs to send from. Each must be prefixed with agent_.

Messages will be evenly distributed across these agents.

Note: Test agents cannot be used for blasts.

Limit: 1 min

messageobjectRequired

fallbackobjectOptional

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

When a recipient’s device doesn’t support RCS or the RCS message cannot be delivered, 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. Note: You will not be charged for the fallback message, only the original RCS message will be charged.

SMS/MMS fallback message to send if the RCS message fails to deliver. When a recipient's device doesn't support RCS or the RCS message cannot be delivered, 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. > **Note:** You will not be charged for the fallback message, only the original RCS message will be charged.

optionsobjectOptional

Configure how your RCS blast is sent and tracked.

Response

Successfully queued or scheduled the RCS blast.

Immediate blast: Returns blast details including total recipients, messages, segments, and cost.
Scheduled blast: Returns a scheduleId and the schedule configuration.

Successfully queued or scheduled the RCS blast. <br> - **Immediate blast**: Returns blast details including total recipients, messages, segments, and cost. - **Scheduled blast**: Returns a `scheduleId` and the schedule configuration.

Blast Responseobject

Scheduled Blast Responseobject

1	import { PinnacleClient } from "rcs-js";
2
3	const client = new PinnacleClient({ apiKey: "YOUR_API_KEY" });
4	await client.messages.blast.rcs({
5	audienceId: "aud_abc123",
6	senders: ["agent_pinnacle", "agent_pinnacle2"],
7	message: {
8	quickReplies: [{
9	type: "trigger",
10	payload: "payload",
11	title: "title"
12	}],
13	text: "Hello from Pinnacle RCS!"
14	},
15	fallback: {
16	from: "+14155164736",
17	text: "Hello from Pinnacle! Reply LEARN to learn more."
18	},
19	options: {
20	transcode: true,
21	validate: true
22	}
23	});

1	{
2	"blastId": "blast_1234567890",
3	"audienceId": "aud_abc123",
4	"totalRecipients": 250,
5	"totalMessages": 250,
6	"totalSegments": 250,
7	"totalCost": 8.75
8	}

Authentication

Request

Response

Errors