Get campaign recipients status

Lists the current delivery status of each recipient of an SMS campaign (channels sms and sms_flash), paginated.

The campaign_id is the value returned as campaign_id by POST /sms.

Availability window. Recipient records are written as the campaign is processed, which starts a few seconds after POST /sms returns. Querying immediately after the send may answer 404 — retry after a few seconds.

Retention. Records are kept for 72 hours; after that the campaign answers 404. Use the daily detailed report for historical data.

Pagination. Follow data.pagination.next_cursor until it is absent. A page may contain fewer items than limit — that does not mean the end. The listing is duplicate-free, but it is not a point-in-time snapshot: a recipient whose first status is recorded after the cursor has already passed its position may only appear on a later pass.

Single recipient. Pass phone to look one up directly. It accepts any mask and cannot be combined with cursor.

Duplicates. If the same number appeared more than once in the same send (e.g. 11999999999 and (11) 99999-9999), it is listed once here.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The campaign_id returned by POST /sms.

Query Params
integer
1 to 500
Defaults to 100

Page size (1-500).

string

Opaque cursor from a previous response. Pass it back verbatim; do not construct or modify it. Mutually exclusive with phone.

string

Narrows the result to a single recipient. Accepts any mask (11999999999, (11) 99999-9999, +5511999999999). Mutually exclusive with cursor.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json