List a broadcast's recipients
list_broadcast_recipientsList a broadcast's recipients
Each recipient and their message's status, in the order they were added: pending until
sent, then sent, delivered, read or failed as WhatsApp reports it. status narrows
the list, such as to the failed ones with Meta's reason in failure_detail.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Page size, 1 to 100 (values outside are clamped). Default 20. | |
| cursor | No | Opaque cursor from the previous page's `next_cursor`. Omit for the first page. A cursor the API didn't return is `422 invalid_request`. | |
| status | No | ||
| agent_id | Yes | The agent the resource belongs to. Another company's agent, or the nil UUID, is `404 agent_not_found`; an agent outside the key's agent list is `403 agent_not_authorized`. | |
| broadcast_id | Yes | One of the agent's broadcasts. Another agent's broadcast is `404 not_found`. |