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");
}

# address is a prefix, so a partial value matches every address under it.
suppressions = client.whatsapp.suppressions.list(address="+1555")
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: "+1555", // a prefix, so a partial value matches every address under it
}) {
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(suppression.Address, suppression.Reason)
}

// address is a prefix, so a partial value matches every address under it.
foreach ($bird->whatsapp->suppressions->list(['address' => '+1555']) as $suppression) {
    echo $suppression->getAddress(), ' ', $suppression->getWaba() ?? 'every account', PHP_EOL;
}

bird whatsapp suppressions list

curl -X GET "https://us1.platform.bird.com/v1/whatsapp/suppressions" \
  -H "Authorization: Bearer $TOKEN" \
  --url-query "address=+5511977670804" \
  --url-query "limit=25"

Respuesta200

{
  "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.

Parámetros de consulta

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.

Carga de respuesta

data

array of object

obligatorio

Mostrar atributos secundarios

next_cursor

nullable string

obligatorio

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

prev_cursor

nullable string

obligatorio

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

refresh_cursor

nullable string

obligatorio

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.

Continúa con la documentación, guías y ejemplos de este tema.

Obtener un resumen de implementación

// 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");
}

# address is a prefix, so a partial value matches every address under it.
suppressions = client.whatsapp.suppressions.list(address="+1555")
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: "+1555", // a prefix, so a partial value matches every address under it
}) {
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(suppression.Address, suppression.Reason)
}

// address is a prefix, so a partial value matches every address under it.
foreach ($bird->whatsapp->suppressions->list(['address' => '+1555']) as $suppression) {
    echo $suppression->getAddress(), ' ', $suppression->getWaba() ?? 'every account', PHP_EOL;
}

bird whatsapp suppressions list

curl -X GET "https://us1.platform.bird.com/v1/whatsapp/suppressions" \
  -H "Authorization: Bearer $TOKEN" \
  --url-query "address=+5511977670804" \
  --url-query "limit=25"

Respuesta200

{
  "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"
}

List WhatsApp suppressions

Parámetros de consulta

Carga de respuesta

Recursos relacionados