Blast SMS to Audience | Pinnacle

Send an SMS message to all contacts in an audience.

Messages are distributed evenly across the provided sender phone numbers.

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 phone numbers to send from in E.164 format.

Messages will be distributed evenly across these senders.

Note: Sandbox numbers cannot be used for blasts.

Limit: 1 min

messageobjectRequired

SMS message containing plain text only.

optionsobjectOptional

Additional settings to customize SMS blast delivery.

Response

Successfully queued or scheduled the SMS 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 SMS 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	async function main() {
4	const client = new PinnacleClient({
5	environment: "https://api.pinnacle.sh",
6	});
7	await client.messages.blast.sms({
8	audienceId: "aud_abc123",
9	senders: [
10	"+14155164736",
11	"+14155164737",
12	],
13	message: {
14	text: "Hello from Pinnacle!",
15	},
16	});
17	}
18	main();

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

Authentication

Request

Response

Errors