Blast RCS to Audience | Pinnacle

import { PinnacleClient } from "rcs-js";
async function main() {
    const client = new PinnacleClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.messages.blast.rcs({
        audienceId: "aud_abc123",
        senders: [
            "agent_pinnacle",
            "agent_pinnacle2",
        ],
        message: {
            quickReplies: [
                {
                    type: "trigger",
                    payload: "learn_more",
                    title: "Learn More",
                },
            ],
            text: "Hello from Pinnacle RCS!",
        },
        fallback: {
            from: "+14155164736",
            text: "Hello from Pinnacle! Reply LEARN to learn more.",
        },
        options: {
            transcode: true,
            validate: true,
        },
    });
}
main();

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.

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.

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.

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, 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.

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.

Blast Responseobject

Response containing details about the scheduled blast.

Scheduled Blast Responseobject

Response returned when a blast is scheduled for future delivery.

Errors

400

Bad Request Error

401

Unauthorized Error

402

Payment Required Error

403

Forbidden Error

500

Internal Server Error