List recipients of a broadcast
/v1/email/broadcasts/{broadcast_id}/recipientsfor await (const recipient of bird.broadcasts.listRecipients("eb_01krdgeqcxet5s7t44vh8rt9mg")) {
console.log(recipient.recipient, recipient.status);
}for recipient in client.broadcasts.list_recipients("eb_01krdgeqcxet5s7t44vh8rt9mg"):
print(recipient.recipient, recipient.status)for recipient, err := range client.Broadcasts.ListRecipients(context.Background(),
"eb_01krdgeqcxet5s7t44vh8rt9mg", bird.BroadcastsListRecipientsParams{}) {
if err != nil {
log.Fatal(err)
}
fmt.Println(recipient.Recipient, *recipient.Status)
}foreach ($bird->broadcasts->listRecipients('eb_01krdgeqcxet5s7t44vh8rt9mg') as $recipient) {
echo $recipient->getRecipient(), ' ', $recipient->getStatus(), PHP_EOL;
}bird email broadcasts list-recipients <broadcast-id>curl -X GET "https://us1.platform.bird.com/v1/email/broadcasts/{broadcast_id}/recipients" \
-H "Authorization: Bearer $TOKEN" \
--url-query "limit=25"{
"data": [
{
"id": "er_01krdgeqcxet5s7t44vh8rt9mg",
"parent_id": "em_01krdgeqcxet5s7t44vh8rt9mg",
"role": "to",
"recipient": "delivered@messagebird.dev",
"status": "accepted",
"rejection_reason": "recipient_suppressed",
"bounce_type": "hard",
"bounce_code": "550",
"bounce_description": "5.1.1 Unknown user",
"open_count": 0,
"click_count": 0
}
],
"next": [
{
"kind": "operation"
}
],
"next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
"prev_cursor": null,
"refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}
Returns recipient-level delivery state for a broadcast, paginated. This is who a broadcast reached and how far each one got.
The list is empty for a draft, scheduled, or accepted broadcast: recipients are resolved from the audience only once sending begins. Pass to to return just that address's row, which is how you answer "did this person get it?" on a send too large to page through.
Paramètres
broadcast_idstringID of the broadcast whose recipients to read.
Paramètres de requête
limitintegerMaximum number of items to return per page.
starting_afterstringCursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.
ending_beforestringCursor from the prev_cursor or refresh_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order. prev_cursor returns the preceding page. refresh_cursor anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.
tostringReturn only the recipient at this address. Exact match, normalised to lowercase before comparison, so it returns at most one row.
Contenu de la réponse
dataPage of recipient objects for this email send.
nextWhat to do next, given what this page reports. Present only where the read computes it: an empty list means the answer you were looking for is here and there is nothing further to do. Absent entirely on reads that do not report next actions.
Afficher les attributs enfants
next.kindWhat you do about this step.
operation: call the operation named inoperation, then read again.external: act somewhere this API does not reach, then read again.wait: nothing is asked of you, so read again later.terminal: nothing you do resolves this, so stop retrying.
Tolerate a value you do not recognize: show the description and
offer no action.
Possible values (may grow over time): operation, external, wait, terminal
next.descriptionA short, human-readable label for the step, suitable for display.
next.operationThe operationId to call. Present only when kind is operation. The operation's own schema says how to call it; this says only which one, and what to address it with.
next.paramsThe parameters that address the operation, by name: {"sender_id": "…"} for an operation on /v1/sms/senders/{sender_id}/requirements. A parameter the operation takes in its query string is given the same way, so an operation addressed as ?subject_id= carries {"subject_id": "…"}. Every parameter the call needs is here, whether its value came from the thing you were acting on or is fixed for this step, so you can make the call from this object alone. Present only when kind is operation and the operation names a subject. A request body, when the operation takes one, is described by the operation's own schema and never appears here.
next.urlA URL to open. Present only when kind is external, and only when the step has one. An external step whose description says to go and do something with no URL to open is normal.
next_cursorCursor for the next page. Pass back as starting_after to advance forward. null when no next page exists.
prev_cursorCursor for the previous page. Pass back as ending_before to step backward. null when no previous page exists.
refresh_cursorRefresh anchor, the first row of this response. Pass back as ending_before to fetch what precedes it in the current sort order. On a newest-first sort those are the items that have appeared since; on any other sort they are the items that sort earlier, so refreshing such a list means re-fetching it instead. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.
Ressources associées
Poursuivez avec la documentation, les guides et les exemples sur ce sujet.