Keyword-Regeln von WhatsApp
Bird liefert den Keyword-Katalog mit. Antwortet ein Empfänger mit STOP an eine Ihrer Nummern, die eingehende Nachrichten empfangen können, wird er ohne Einrichtung Ihrerseits abgemeldet. START macht die Abmeldung rückgängig. Eine eigene Regel überschreibt die Standardregel von Bird für den Geltungsbereich, den sie abdeckt.
Diese Seite beschreibt, was Bird erkennt, wie eine eingehende Nachricht abgeglichen wird und wie Sie den Wortlaut ändern oder Keywords hinzufügen. Im Dashboard finden Sie dasselbe auf der Seite Keywords.

Was Bird standardmäßig erkennt
Neun Wörter erfassen eine Abmeldung:
stop, stop all, stopall, unsubscribe, cancel, end, quit, revoke, optout
Zwei machen sie rückgängig: start und unstop.
Abgeglichen wird die gesamte Nachricht, nicht ein Teil davon. Da cancel und end Keywords sind, ist dieser Unterschied wichtig: "cancel my 3pm delivery" ist eine gewöhnliche Nachricht und kein Widerruf der Einwilligung. Groß- und Kleinschreibung, Akzente, mehrfache Leerzeichen und Satzzeichen am Ende werden ignoriert, daher stimmen Stop! und STOP beide überein. Satzzeichen vor oder innerhalb des Wortes werden nicht ignoriert, daher stimmt #stop nicht überein.
Wo Keywords nicht abgeglichen werden
Ein Keyword in einer Gruppennachricht wird übersprungen, sodass sich ein Teilnehmer dort nicht per Antwort abmelden kann. Berücksichtigen Sie die ausdrückliche Abmeldung eines Gruppenmitglieds in Ihrer eigenen Versandlogik.
Wann die Präferenz gespeichert wird
Die Klassifizierung läuft parallel zum Ereignis whatsapp.received und nicht davor. Eine Integration, die dieses Ereignis beobachtet, kann daher ein STOP sehen, bevor die dadurch gespeicherte Präferenz existiert. Wenn Ihr Handler auf die eingehende Nachricht reagiert, indem er etwas sendet, lesen Sie die Datensätze des Empfängers erneut, statt sich auf die Reihenfolge der Ereignisse zu verlassen.
Sehen, was gilt
GET /v1/whatsapp/keyword-rules beschreibt, wie Antworten an Ihre Nummern verarbeitet werden. Ohne Filter liefert der Aufruf eine Zeile pro Geltungsbereich: Ihre Regel, wo Sie eine haben, und die Regel von Bird, wo Sie keine haben. Eine eigene Regel ohne waba ersetzt die Regel von Bird für dieselbe Operation und dasselbe Land. Grenzen Sie das Ergebnis mit country, waba, operation oder scope ein:
scope=systemliefert den Katalog von Bird, einschließlich der Standardregel, die eine Ihrer Regeln überschreibt.scope=workspaceliefert Ihre eigenen Regeln.
const rules = await bird.whatsapp.keywordRules.list({ operation: "opt_out" });
for (const rule of rules.data ?? []) {
console.log(rule.scope, rule.effective_keywords);
}rules = client.whatsapp.keyword_rules.list(operation="opt_out")
for rule in rules.data or []:
print(rule.scope, rule.effective_keywords)rules, err := client.Whatsapp.KeywordRules.List(context.Background(), bird.WhatsappKeywordRulesListParams{
Operation: "opt_out", // omit for both operations, Bird's rules and your own
})
if err != nil {
log.Fatal(err)
}
for _, rule := range rules.Data {
fmt.Println(rule.Scope, rule.EffectiveKeywords)
}$rules = $bird->whatsapp->keywordRules->list(['operation' => 'opt_out']);
foreach ($rules->getData() ?? [] as $rule) {
echo $rule->getScope(), ' ', implode(',', $rule->getEffectiveKeywords() ?? []), PHP_EOL;
}bird whatsapp keyword-rules listcurl "https://us1.platform.bird.com/v1/whatsapp/keyword-rules?operation=opt_out" \
-H "Authorization: Bearer $BIRD_API_KEY"Die Regeln werden von der spezifischsten an zurückgegeben. In dieser Reihenfolge wird eine eingehende Nachricht mit ihnen abgeglichen. Jede Regel enthält effective_keywords: die Keywords von Bird für diese Operation und dieses Land, ohne die von Ihnen entfernten und mit den von Ihnen hinzugefügten.
Bei einer eigenen Regel ohne country zeigt effective_keywords die weltweiten Keywords von Bird, denn die Regel hat kein Land, und das Land des Absenders ist erst bekannt, wenn eine Nachricht eintrifft. Diese Regel gleicht mit den Keywords von Bird für das Land des Absenders ab, die umfangreicher sein können. Setzen Sie ein country in Ihrer Regel, um genau zu sehen, womit diese Absender abgeglichen werden.
country ist das Land des Absenders, ermittelt aus dessen eigener Telefonnummer und nicht aus der Nummer, an die er geschrieben hat. Es ist die Länderangabe, die WhatsApp übermittelt. Ein Absender, der über eine unternehmensbezogene Benutzer-ID identifiziert wird, hat kein Land. Seine Nachricht überspringt daher die länderbezogenen Regeln und wird stattdessen mit einer weltweiten Regel abgeglichen.
Die Antwort ändern
Die Standardantworten von Bird sind korrekt, aber allgemein gehalten. Um in Ihrem eigenen Namen zu antworten, erstellen Sie eine Regel:
const rule = await bird.whatsapp.keywordRules.create({
operation: "opt_out",
country: "US", // the SENDER's country, from their own number
reply: "You're off the list. ACME Courier won't message you again.",
});
// effective_keywords is Bird's set plus any of your own.
console.log(rule.id, rule.effective_keywords);rule = client.whatsapp.keyword_rules.create(
operation="opt_out",
country="US", # the SENDER's country, from their own number
reply="You're off the list. ACME Courier won't message you again.",
)
# effective_keywords is Bird's set plus any of your own.
print(rule.id, rule.effective_keywords)rule, err := client.Whatsapp.KeywordRules.Create(context.Background(), bird.WhatsappKeywordRulesCreateParams{
Operation: "opt_out",
Country: bird.String("US"), // the SENDER's country, from their own number
Reply: bird.String("You're off the list. ACME Courier won't message you again."),
})
if err != nil {
log.Fatal(err)
}
// EffectiveKeywords is Bird's set plus any of your own.
fmt.Println(rule.Id, rule.EffectiveKeywords)$rule = $bird->whatsapp->keywordRules->create(
(new WhatsAppKeywordRuleCreate())
->setOperation('opt_out')
->setCountry('US')
->setReply("You're off the list. ACME Courier won't message you again."),
);
// getEffectiveKeywords() is Bird's set plus any of your own.
echo $rule->getId(), ' ', implode(',', $rule->getEffectiveKeywords() ?? []);bird whatsapp keyword-rules create \
--country US \
--keywords 'no more texts' \
--keywords 'remove me' \
--operation opt_out \
--reply "You're off the list. ACME Courier won't message you again." \
--waba 102290129340398curl -X POST https://us1.platform.bird.com/v1/whatsapp/keyword-rules \
-H "Authorization: Bearer $BIRD_API_KEY" \
-H "Content-Type: application/json" \
-d '{"operation":"opt_out","country":"US","reply":"You'"'"'re off the list. ACME Courier won'"'"'t message you again."}'Ihre Regel ersetzt die Antwort von Bird für diesen Geltungsbereich und behält die Schlüsselwörter von Bird bei. Ihre keywords ergänzen diese, statt sie zu ersetzen. Ein Schlüsselwort, das Bird später hinzufügt, greift daher ohne Änderung Ihrerseits.
Wenn Sie keine Antwort senden, das Opt-out aber trotzdem erfassen möchten, lassen Sie reply beim Erstellen der Regel weg. Um eine bestehende Regel stummzuschalten, setzen Sie reply in einem JSON-Body bei der unten beschriebenen Aktualisierung auf null. Ein CLI-Flag kann null nicht übertragen.

Eigene Schlüsselwörter hinzufügen
// Omitting keywords leaves the set alone; an empty array clears your additions
// back to Bird's. reply: null switches the auto-reply off and still records
// the opt-out.
const rule = await bird.whatsapp.keywordRules.update("wkr_01m2kj8x4te9p0rr7e5w2n1abc", {
keywords: ["no more texts", "remove me"],
});
console.log(rule.effective_keywords);# Omitting keywords leaves the set alone; an empty list clears your additions
# back to Bird's.
rule = client.whatsapp.keyword_rules.update(
"wkr_01m2kj8x4te9p0rr7e5w2n1abc", keywords=["no more texts", "remove me"]
)
print(rule.effective_keywords)// Omitting keywords leaves the set alone; an empty slice clears your
// additions back to Bird's.
rule, err := client.Whatsapp.KeywordRules.Update(context.Background(),
"wkr_01m2kj8x4te9p0rr7e5w2n1abc", bird.WhatsappKeywordRulesUpdateParams{
Keywords: []string{"no more texts", "remove me"},
})
if err != nil {
log.Fatal(err)
}
fmt.Println(rule.EffectiveKeywords)// Omitting keywords leaves the set alone; an empty array clears your additions
// back to Bird's.
$rule = $bird->whatsapp->keywordRules->update(
'wkr_01m2kj8x4te9p0rr7e5w2n1abc',
(new WhatsAppKeywordRuleUpdate())->setKeywords(['no more texts', 'remove me']),
);
echo implode(',', $rule->getEffectiveKeywords() ?? []);bird whatsapp keyword-rules update <id> \
--keywords 'no more texts' \
--reply "You're off the list. ACME Courier won't message you again."curl -X PATCH https://us1.platform.bird.com/v1/whatsapp/keyword-rules/wkr_01m2kj8x4te9p0rr7e5w2n1abc \
-H "Authorization: Bearer $BIRD_API_KEY" \
-H "Content-Type: application/json" \
-d '{"keywords":["no more texts"]}'Wenn Sie keywords weglassen, bleiben Ihre Ergänzungen unverändert. Wenn Sie ein leeres Array senden, werden sie entfernt, und es gilt wieder der Satz von Bird.
Schlüsselwörter von Bird entfernen
In manchen Konversationen werden cancel oder stop als gewöhnliche Wörter gebraucht, etwa in einem Bot-Ablauf, in dem cancel bedeutet, diesen Schritt abzubrechen. Tragen Sie diese Wörter in Ihrer Regel unter excluded_keywords ein:
curl -X POST https://us1.platform.bird.com/v1/whatsapp/keyword-rules \
-H "Authorization: Bearer $BIRD_API_KEY" \
-H "Content-Type: application/json" \
-d '{"operation":"opt_out","waba":"102290129340398","excluded_keywords":["cancel","end"]}'Eine Nachricht, die genau aus einem dieser Wörter besteht, löst dann für die von der Regel erfassten Personen keine Abmeldung und keine Antwort aus. Die Nachricht erreicht Sie weiterhin wie gewohnt, und die Regel von Bird greift nicht ersatzweise. Um alle Keywords von Bird abzuschalten, schließen Sie jedes einzelne aus. Ein Keyword, das Bird später hinzufügt, greift trotzdem, sofern Ihre Regel es nicht bereits ausschließt. Wenn Sie Keywords entfernen, müssen Sie die damit ausgedrückten Abmeldungen selbst berücksichtigen. Metas eigener Opt-out-Button in Marketingvorlagen funktioniert weiterhin.
Bei einer Aktualisierung ersetzt excluded_keywords den Satz entfernter Keywords. Ein leeres Array entfernt keine, und wenn Sie das Feld weglassen, bleibt der Satz unverändert. Ein Keyword kann nicht gleichzeitig hinzugefügt und ausgeschlossen werden. Jedes ausgeschlossene Keyword muss eines der Keywords von Bird für die Operation der Regel sein. Bei einer Regel mit country muss es eines der Keywords von Bird für dieses Land sein oder, wenn Bird für dieses Land keine hat, eines der weltweiten Keywords von Bird. Bird lehnt jedes andere Wort mit 422 ab, denn sonst würde die Regel dieses Wort entfernen, sobald Bird es später hinzufügt.
Geltungsbereich von Regeln und Duplikate
Eine Regel lässt sich mit waba auf ein WhatsApp Business Account, mit country auf ein Absenderland, auf beides oder auf keines davon eingrenzen. Pro Kombination aus Vorgang, Land und Account können Sie eine Regel anlegen. Ein zweiter Schreibvorgang für dieselbe Kombination gibt einen Duplikatfehler zurück.
Bird lehnt eine Regel ab, die stop an opt_in bindet, unabhängig davon, ob das Wort aus dem Katalog von Bird oder aus einer anderen Ihrer Regeln stammt. So kann ein Opt-out-Wort nie eine Einwilligung erteilen.
Eine Regel löschen
Wenn Sie Ihre Regel löschen, übernimmt die nächste Regel in der Abgleichsreihenfolge diesen Geltungsbereich. Das ist nicht immer eine Ihrer eigenen Regeln. Die Reihenfolge lautet:
- Ihre Regel für ein Konto und ein Land.
- Ihre Regel für das Konto.
- Ihre Regel für das Land.
- Die Regel von Bird für das Land des Absenders.
- Ihre weltweite Regel.
- Die weltweite Regel von Bird.
Wenn Sie Ihre Regel für ein Land löschen, übernimmt daher zuerst die Regel von Bird für dieses Land den Geltungsbereich, noch vor Ihrer eigenen weltweiten Regel:
// The next rule in the ladder answers the scope, which is another rule of yours if you hold a less specific one.
await bird.whatsapp.keywordRules.delete("wkr_01m2kj8x4te9p0rr7e5w2n1abc");# The next rule in the ladder answers the scope, which is another rule of yours if you hold a less specific one.
client.whatsapp.keyword_rules.delete("wkr_01m2kj8x4te9p0rr7e5w2n1abc")if err := client.Whatsapp.KeywordRules.Delete(context.Background(),
"wkr_01m2kj8x4te9p0rr7e5w2n1abc"); err != nil {
log.Fatal(err)
}// The next rule in the ladder answers the scope, which is another rule of yours if you hold a less specific one.
$bird->whatsapp->keywordRules->delete('wkr_01m2kj8x4te9p0rr7e5w2n1abc');bird whatsapp keyword-rules delete <id> --yescurl -X DELETE https://us1.platform.bird.com/v1/whatsapp/keyword-rules/wkr_01m2kj8x4te9p0rr7e5w2n1abc \
-H "Authorization: Bearer $BIRD_API_KEY"Wenn Sie eine Regel löschen, gelten Wortlaut und Keyword-Satz der Regel, die in dieser Reihenfolge als Nächstes kommt. Ist das eine Ihrer Regeln, die stop ausschließt, bewirkt STOP auch dort nichts.
Nächste Schritte
- Präferenzen: die Einträge, die ein Keyword erzeugt, und welche davon Sie rückgängig machen können.
- Unterdrückungen: die Adressen, die Ihr Workspace direkt blockiert.
Verwandte Ressourcen
Weiter mit der Dokumentation, Anleitungen und Beispielen zu diesem Thema.