Sign inGet Started

Suppresje WhatsApp

Suppresja to adres, do którego Twój obszar roboczy nie będzie wysyłać wiadomości, zapisany z określonym zakresem. Bird blokuje wysyłkę na adres objęty suppresją, zanim dotrze ona do WhatsApp.

Otwórz stronę Suppressions, aby zarządzać listą, lub użyj API poniżej. Wpisy zgłoszone przez odbiorców znajdują się na karcie Preferences tej samej strony i podlegają innym zasadom.

Lista czterech zablokowanych numerów, każdy przypisany do wszystkich kont biznesowych lub do jednego

Blokowanie konta biznesowego

Na karcie Suppressions utwórz suppresję dla numeru telefonu i wybierz konto biznesowe, którego dotyczy. Bird blokuje wiadomości z tego konta, a Twoje pozostałe konta nadal mogą wysyłać wiadomości na ten numer. Kolumna Business account na liście wskazuje konto, do którego suppresja jest przypisana, lub wyświetla All accounts, jeśli obejmuje cały obszar roboczy.

POST /v1/whatsapp/suppressions zapisuje to samo z poziomu kodu. waba to konto, do którego chcesz przypisać zakres; pomiń je, aby zablokować adres w całym obszarze roboczym, w tym na kontach, które podłączysz później:

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

Okno dialogowe blokowania numeru z zakresem ustawionym na pojedyncze konto biznesowe

Jeden zakres, jeden wpis

Suppresja ma jeden zakres, więc ten sam adres zablokowany dla dwóch kont to dwa wpisy, a nie jeden. Aby objąć cały obszar roboczy, wykonaj jedno wywołanie bez waba.

Dodanie adresu, który jest już objęty suppresją w danym zakresie, zwraca 200 z istniejącym wpisem zamiast tworzyć drugi. Nowy wpis zwraca 201.

Suppresja jest identyfikowana po zapisanym adresie. Odbiorca wskazany numerem telefonu i ten sam odbiorca wskazany identyfikatorem użytkownika w zakresie konta biznesowego to dwa różne klucze, więc objęcie suppresją jednego nie obejmuje drugiego. Zapisz oba, jeśli kontaktujesz się z tą samą osobą na oba sposoby.

Odczytywanie listy suppresji

GET /v1/whatsapp/suppressions zwraca obowiązujące suppresje, od najnowszych, jako stronę kursorową. address dopasowuje dokładnie jeden pełny adres: przekazana wartość jest normalizowana tak samo jak wpis, więc spacje i interpunkcja nie mają znaczenia, ale częściowy numer nie zwraca niczego. reason zawęża wyniki do kategorii, na przykład manual dla wpisów dodanych przez Ciebie:

Aby sprawdzić, co blokuje jedno konto biznesowe, przekaż jego waba. Strona zawiera suppresje tego konta oraz suppresje obejmujące cały obszar roboczy, które również je blokują, więc samodzielne filtrowanie pełnej listy po waba pominęłoby wpisy obejmujące cały obszar roboczy.

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

Lista zawiera obowiązujące wpisy, a zakończone wpisy są pomijane. Brak adresu nie dowodzi, że nigdy nie był objęty suppresją w obszarze roboczym; wpis mógł zostać zakończony. Aby to potwierdzić, odczytaj wpis po ID.

Odczytywanie pojedynczego wpisu

GET /v1/whatsapp/suppressions/{suppression_id} zwraca zarówno wpis zakończony, jak i obowiązujący, podając kiedy został zakończony i co go zakończyło:

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

Kończenie suppresji

Akcja Delete w wierszu suppresji kończy suppresję, zamiast ją usuwać. Blokada przestaje obowiązywać. Wpis nadal można odczytać i pokazuje, kiedy został zakończony i kto go zakończył. DELETE /v1/whatsapp/suppressions/{suppression_id} działa tak samo i zwraca 204:

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

Suppresja dodana przez Ciebie ma powód manual i możesz ją zakończyć. Rezygnację zgłoszoną przez odbiorcę może cofnąć tylko on, a próba jej zakończenia zwraca 422. Ponowne wywołanie dla suppresji, która została już zakończona, kończy się powodzeniem i niczego nie zmienia, a ID, którego nie ma w obszarze roboczym, zwraca 404.

Do zakończenia suppresji potrzebne jest jej ID, więc najpierw wyszukaj je na liście.

Obserwowanie nowych suppresji

whatsapp_suppression.created jest wywoływane, gdy suppresja zostanie zapisana, dzięki czemu Twój system widzi nowe blokady bez odpytywania. Jego ładunek zawiera:

  • suppression_id, identyfikator wpisu.
  • address, numer objęty suppresją w formacie E.164.
  • waba, konto, do którego blokada jest ograniczona, lub null, gdy obejmuje cały obszar roboczy.
  • reason i workspace_id.

Po zakończeniu suppresji nie jest emitowane żadne zdarzenie, więc zanim zaufasz przechowywanej kopii, ponownie odczytaj listę. Pełny ładunek opisano w sekcji Webhooki suppresji WhatsApp.

Następne kroki