Sign inGet Started
Inizia ora
Guide
Riferimento API
SDK
CLI
Knowledge Base
Changelog

List WhatsApp suppressions

GET
/v1/whatsapp/suppressions
// address is a prefix, so a partial value matches every address under it.
const suppressions = await bird.whatsapp.suppressions.list({ address: "+1555" });
for (const suppression of suppressions.data ?? []) {
  console.log(suppression.address, suppression.waba ?? "every account");
}
Risposta200
{
  "data": [
    {
      "id": "was_01krdgeqcxet5s7t44vh8rt9mg",
      "address": "+5511977670804",
      "waba": null,
      "reason": "manual",
      "origin": "api_key",
      "applies_to": "all",
      "source_whatsapp_id": "wam_01krdgeqcxet5s7t44vh8rt9mg",
      "ended_reason": "api_key"
    }
  ],
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "prev_cursor": null,
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}

Returns a paginated list of the WhatsApp addresses the workspace is currently suppressing. Records that have ended are left out; fetch one by ID to read it. Use the address parameter for prefix lookup.

Parametri di query

addressstring

Address prefix filter (case-insensitive). A complete address returns only that address; a partial value returns all matches.

reasonstring

Return only suppressions with this reason:

  • manual: Added through the API or dashboard.

Possible values: manual

limitinteger

Maximum number of items to return per page.

starting_afterstring

Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.

ending_beforestring

Cursor 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 di risposta

data
array of object
obbligatorio
Mostra attributi secondari
data.id
string
obbligatorio

Unique identifier for the suppression record.

data.address
string
obbligatorio

The suppressed WhatsApp address. For a phone number this is canonical E.164 with a leading plus sign, such as +5511977670804.

data.waba
nullable string

The WhatsApp Business Account the suppression is limited to, identified by its WhatsApp-issued account ID, or null when it covers the whole workspace.

data.reason
string
obbligatorio

Why the address is suppressed. manual means it was added directly rather than created automatically from a delivery outcome. This list grows over time, so treat an unknown value as informational rather than rejecting the record.

Possible values (may grow over time): manual

data.origin
string
obbligatorio

How the suppression came to exist: api_key (added through the API with an API key) or user (added by a user in the dashboard). This list grows over time, so treat an unknown value as informational rather than rejecting the record.

Possible values (may grow over time): api_key, user

data.applies_to
string
obbligatorio

Blocking policy. all blocks every message category. Treat an unrecognized value as blocking.

Possible values (may grow over time): all

data.source_whatsapp_id
string

ID of the WhatsApp message that caused this address to be suppressed, when the suppression was created automatically. Omitted for addresses added manually.

data.ended_at
nullable string

When this stopped applying. Null while it is still stopping messages, which is the case for every record in the list.

data.ended_reason
nullable string

What ended it: api_key (deleted through the API with an API key) or user (deleted by a user in the dashboard). Null while it is still stopping messages. This list grows over time, so treat an unknown value as informational rather than rejecting the record.

Possible values (may grow over time): api_key, user

data.created_at
string
obbligatorio

When the suppression was created.

next_cursor
nullable string
obbligatorio

Cursor for the next page. Pass back as starting_after to advance forward. null when no next page exists.

prev_cursor
nullable string
obbligatorio

Cursor for the previous page. Pass back as ending_before to step backward. null when no previous page exists.

refresh_cursor
nullable string
obbligatorio

Refresh 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.

Risorse correlate

Continua con la documentazione, le guide e gli esempi per questo argomento.

Ottieni un brief di implementazione