List WhatsApp suppressions
/v1/whatsapp/suppressions// address matches one complete address exactly; a partial number returns nothing.
const suppressions = await bird.whatsapp.suppressions.list({ address: "+15550001234" });
for (const suppression of suppressions.data ?? []) {
console.log(suppression.address, suppression.waba ?? "every account");
}# address matches one complete address exactly; a partial number returns nothing.
suppressions = client.whatsapp.suppressions.list(address="+15550001234")
for suppression in suppressions.data or []:
print(suppression.address, suppression.waba or "every account")for suppression, err := range client.Whatsapp.Suppressions.List(context.Background(), bird.WhatsappSuppressionsListParams{
Address: "+15550001234", // one complete address, matched exactly; a partial number returns nothing
}) {
if err != nil {
log.Fatal(err)
}
fmt.Println(suppression.Address, suppression.Reason)
}// address matches one complete address exactly; a partial number returns nothing.
foreach ($bird->whatsapp->suppressions->list(['address' => '+15550001234']) as $suppression) {
echo $suppression->getAddress(), ' ', $suppression->getWaba() ?? 'every account', PHP_EOL;
}bird whatsapp suppressions listcurl -X GET "https://us1.platform.bird.com/v1/whatsapp/suppressions" \
-H "Authorization: Bearer $TOKEN" \
--url-query "address=+5511977670804" \
--url-query "waba=102290129340398" \
--url-query "limit=25"{
"data": [
{
"id": "was_01krdgeqcxet5s7t44vh8rt9mg",
"address": "+5511977670804",
"waba": null,
"reason": "manual",
"origin": "user",
"applies_to": "all",
"source_whatsapp_id": "wam_01krdgeqcxet5s7t44vh8rt9mg",
"ended_reason": "api_key"
}
],
"next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
"prev_cursor": null,
"refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}
Returns the suppressions currently stopping your messages, most recent first by effective_at. Pass address to look up one recipient before messaging them, and waba to narrow to one business account.
A suppression covers one address for one business account, or for every account in the workspace when waba is null. Filtering by waba returns that account's suppressions together with the workspace-wide ones that stop it too.
Ended suppressions are excluded; fetch one by ID to read it. An empty result does not mean the address is reachable: another suppression scope, a newer suppression, or the recipient's WhatsApp preferences (such as a STOP) can still refuse a send.
Parâmetros de consulta
addressstringReturn only suppressions for this exact address: a phone number in E.164 form or a business-scoped user ID. A phone number is matched in its canonical form, so spacing and punctuation do not matter. Prefix matching is unsupported.
wabastringReturn only suppressions covering this WhatsApp Business Account, identified by its WhatsApp-issued account ID or by the waa_ ID Bird gives it, including the workspace-wide ones that stop it too. Omit for every account in the workspace.
reasonstringReturn only suppressions with this reason:
manual: Added through the API or dashboard.
Possible values: manual
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.
Payload de resposta
dataPage of suppressions in force, most recent first by effective_at. Ended suppressions are left out; fetch one by ID to read it.
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.
Recursos relacionados
Continue com a documentação, guias e exemplos sobre este tópico.