List a broadcast's recipients
GET /v1/broadcasts/{id}/recipients
Returns a page of a broadcast’s recipients and what happened to each message, newest first. A broadcast still preparing lists the recipients collected so far.
Needs broadcasts:read.
Path parameters
Section titled “Path parameters”id string · uuid
The broadcast’s ID.
Query parameters
Section titled “Query parameters”limit integer
How many items to return.
From 1 to 100. Default 25.
cursor string
The next_cursor of the previous page, unchanged. A cursor that was changed, or made for another broadcast or status filter, is 400 invalid_request.
status string
Only recipients with this status. Any other value is 400 invalid_request.
One of pending sent delivered read failed.
Phone numbers
Section titled “Phone numbers”A key with broadcasts:read sees recipients’ full phone numbers. The app’s masking settings don’t apply to keys.
Returns
Section titled “Returns”200 A page of recipients.
data array of objects
Show 9 child attributesHide child attributes
Each item:
data[].phone string
E.164, with +.
data[].name string
data[].status string
Open enum.
One of pending sent delivered read failed.
data[].message_id string · uuid · nullable
The message sent (see GET /v1/messages/{id}); null until it is sent.
data[].error object · nullable
Why it failed; null unless it did.
Show 2 child attributesHide child attributes
data[].error.code integer
WhatsApp’s error code, or 0.
data[].error.message string
data[].sent_at string · date-time · nullable
data[].delivered_at string · date-time · nullable
data[].read_at string · date-time · nullable
data[].replied_at string · date-time · nullable
When they first replied after it.
next_cursor string · nullable
Pass it as cursor to get the next page. null means the end.
Errors
Section titled “Errors”Besides the ones every request can get: