For the complete documentation index, see llms.txt. This page is also available as Markdown.

Campaign details

One SMS campaign's status, batches, and statistics.

Where: SMS β†’ Campaigns β†’ campaign Β· /projects/<project>/sms/campaigns/<id>/view

The SMS Campaign view shows one campaign end to end β€” when it was sent, to whom, through which provider, and how each batch and message did.

Screenshot TODO β€” capture comes from testing-plan area 14-sms.

What you can do here

General Information β€” the campaign id (cmp_…, copyable) with a status badge, Initiated time plus the delivery plan (Deliver Instantly or the scheduled time), Status, a link to the Template used, and the Deliver strategy (the audience). If the campaign failed, a red Campaign Failed alert lists every error with its code.

SMS Provider β€” the integration that sent the campaign, with a See integration details link.

Statistics β€” four tiles: Batches, Sent SMS, Failed, and Success rate (%).

Batches β€” the campaign's batches, each row showing the recipient count, the batch id (e.g. cmpb_4olwlX3NxQyesGIya90zuo), the last status time, and a status coin. Filter by Batch ID or Phone number. Open a batch to list its messages β€” recipient phone numbers, notification id, and per-message status; batch-level failures appear in a Batch has errors alert. Open a message to reach the message log.

While a campaign is still in flight (Scheduled, Registered, Started, or Processing), a red Stop campaign button is shown. Stopping lets batches that are already sending finish, but no new recipients are messaged β€” it cannot be undone.

Use it from code

Get SMS campaign.

API reference

Endpoints: Get campaign, Get statistics, Get batches, Stop campaign.

Last updated