Sign inGet Started

WhatsApp-suppressies

Een suppressie is een adres waarnaar je werkruimte geen berichten stuurt, vastgelegd met een bereik. Bird blokkeert een verzending naar een onderdrukt adres voordat deze WhatsApp bereikt.

Open de Suppressions-pagina om met de lijst te werken, of gebruik de API hieronder. Records die door ontvangers zijn opgegeven staan op het tabblad Preferences van dezelfde pagina en volgen andere regels.

Een lijst van vier geblokkeerde nummers, elk gekoppeld aan alle zakelijke accounts of aan één specifiek account

Een zakelijk account onderdrukken

Maak op het tabblad Suppressions een suppressie aan voor een telefoonnummer en kies het zakelijke account waarvoor deze geldt. Bird blokkeert berichten van dat account, en je andere accounts kunnen het nummer nog steeds berichten sturen. De kolom Business account in de lijst noemt het account waarvoor een suppressie geldt, of toont All accounts als de suppressie je hele werkruimte dekt.

POST /v1/whatsapp/suppressions legt hetzelfde vast vanuit code. waba is het account waarvoor je het wilt laten gelden; laat het weg om het adres te blokkeren voor je hele werkruimte, inclusief accounts die je later koppelt:

// Omit waba to block the address for the whole workspace, whichever account
// sends. With it, your other accounts keep reaching them, and the same
// address for two accounts is two records.
const suppression = await bird.whatsapp.suppressions.add({
  address: "+15550001234",
  waba: "102290129340398",
});
console.log(suppression.id, suppression.applies_to);

Een dialoogvenster voor het blokkeren van een nummer, met het bereik ingesteld op één zakelijk account

Eén bereik, één record

Een suppressie heeft één bereik, dus hetzelfde adres geblokkeerd voor twee accounts levert twee records op in plaats van één. Om je hele werkruimte te dekken, doe je één aanroep zonder waba.

Een adres toevoegen dat al onderdrukt is voor dat bereik geeft 200 terug met het bestaande record, in plaats van een tweede aan te maken. Een nieuw record geeft 201 terug.

Een suppressie is gekoppeld aan het adres dat je vastlegt. Een ontvanger die je via een telefoonnummer bereikt en dezelfde ontvanger die je via een business-scoped user ID bereikt, zijn twee sleutels. Als je de ene onderdrukt, is de andere dus niet onderdrukt. Leg beide vast als je dezelfde persoon op beide manieren aanspreekt.

Je suppressielijst lezen

GET /v1/whatsapp/suppressions geeft de actieve suppressies terug als een cursorpagina, de nieuwste eerst. address matcht precies één volledig adres. De waarde die je meegeeft wordt op dezelfde manier genormaliseerd als het record, dus spaties en leestekens maken niet uit, maar een gedeeltelijk nummer levert niets op. reason beperkt de lijst tot een categorie, zoals manual voor de suppressies die je zelf hebt toegevoegd:

Wil je zien wat één zakelijk account blokkeert, geef dan de waba ervan mee. De pagina bevat de suppressies van dat account en de suppressies voor de hele werkruimte, die het account ook blokkeren. Als je zelf een volledige lijst filtert op waba, mis je de records voor de hele werkruimte.

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

De lijst bevat wat actief is; beëindigde records worden weggelaten. Een ontbrekend adres bewijst niet dat de werkruimte het nooit heeft onderdrukt; het record kan beëindigd zijn. Lees het op ID om het te bevestigen.

Eén record lezen

GET /v1/whatsapp/suppressions/{suppression_id} geeft zowel een beëindigd record als een actief record terug, met vermelding van wanneer het is beëindigd en waardoor:

// Resolves a record that has already ended, which the list leaves out.
const suppression = await bird.whatsapp.suppressions.get("was_01krdgeqcxet5s7t44vh8rt9mg");
console.log(suppression.reason, suppression.ended_at ?? "still in force");

Een suppressie beëindigen

De actie Delete op een rij in de lijst beëindigt de suppressie in plaats van deze te verwijderen. De blokkering stopt. Het record blijft leesbaar en toont wanneer het is beëindigd en door wie. DELETE /v1/whatsapp/suppressions/{suppression_id} doet hetzelfde en geeft 204 terug:

// Only a manual suppression can be ended; a recipient's own opt-out is
// theirs to reverse. The record is kept and still reads back by id.
await bird.whatsapp.suppressions.remove("was_01krdgeqcxet5s7t44vh8rt9mg");

Een suppressie die je zelf hebt toegevoegd heeft reden manual en kan worden beëindigd. De eigen opt-out van een ontvanger kan alleen de ontvanger zelf terugdraaien, en de poging geeft 422 terug. Opnieuw aanroepen op een suppressie die al beëindigd is slaagt en verandert niets, en een ID dat niet in de werkruimte bestaat geeft 404 terug.

Om een suppressie te beëindigen heb je het ID ervan nodig, dus zoek het eerst op in de lijst.

Nieuwe suppressies volgen

whatsapp_suppression.created wordt geactiveerd wanneer een suppressie wordt vastgelegd, zodat je eigen systeem nieuwe blokkeringen ziet zonder te pollen. De payload bevat:

  • suppression_id, de identifier van het record.
  • address, het onderdrukte nummer in E.164-formaat.
  • waba, het account waartoe de blokkering beperkt is, of null wanneer het de hele werkruimte dekt.
  • reason en workspace_id.

Er wordt geen event verstuurd wanneer een suppressie eindigt, dus lees de lijst opnieuw voordat je vertrouwt op een kopie die je bewaart. Zie Webhooks voor WhatsApp-suppressies voor de volledige payload.

Volgende stappen