Sign inGet Started

List WhatsApp keyword rules

GET
/v1/whatsapp/keyword-rules
const rules = await bird.whatsapp.keywordRules.list({ operation: "opt_out" });
for (const rule of rules.data ?? []) {
  console.log(rule.scope, rule.effective_keywords);
}
Réponse200
{
  "data": [
    {
      "id": "wkr_01krdgeqcxet5s7t44vh8rt9mg",
      "scope": "workspace",
      "operation": "opt_out",
      "country": "US",
      "waba": "102290129340398",
      "keywords": [
        "no more texts",
        "remove me"
      ],
      "excluded_keywords": [],
      "effective_keywords": [
        "stop",
        "unsubscribe",
        "optout",
        "no more texts",
        "remove me"
      ],
      "reply": "You're off the list. ACME Courier won't message you again.",
      "created_at": "2026-09-15T10:04:00Z",
      "updated_at": "2026-09-15T10:04:00Z"
    }
  ]
}

Returns the keyword rules that apply to inbound messages, most specific first. Bird's own rules are included, so opt-out and opt-in work on every inbound-capable number before you configure anything. A rule of yours with no waba replaces Bird's rule for the same operation and country, so that Bird rule is left out and yours carries its keywords in effective_keywords.

Use the filters to narrow the full, unpaginated list. Set scope=system for Bird's rules only, including the ones yours replace, or scope=workspace for the ones you created.

Paramètres de requête

countrystring

Keep only rules that apply to someone messaging from this country, as an ISO 3166-1 alpha-2 code. Omit for every rule, whichever country it covers.

wabastring

Keep only the rules that apply to this WhatsApp Business Account of yours, identified by its WhatsApp-issued account ID or by the waa_ ID Bird gives it. Either form finds the same rules.

operationstring

Keep only rules for this operation. Omit for all of them. Open on the same terms as the response, so an operation Bird gains later can be filtered for without a client update; one Bird does not answer matches nothing rather than failing.

Possible values (may grow over time): opt_in, opt_out

scopestring

Keep only Bird's own rules (system) or only the rules you created (workspace). Omit for both, in which case a Bird rule that one of yours replaces is left out.

Possible values: system, workspace

Contenu de la réponse

data
array of object
obligatoire

The keyword rules that apply to your workspace, Bird's own included. Ordered most specific first, so the first rule whose keywords match an inbound message is the one that runs. The set is small and returned in full; this list is not paginated.

Afficher les attributs enfants
data.id
string
obligatoire
data.scope
string
obligatoire

Whether the rule is one Bird ships (system) or one your workspace created (workspace). Both kinds carry a wkr_ ID and can be read; only a workspace rule can be changed or deleted. A workspace rule takes precedence over Bird's at the same grain, so it is how you replace a reply without losing the keywords Bird ships.

Possible values: system, workspace

data.operation
string
obligatoire

What Bird does when an inbound message matches the rule.

  • opt_out records that the sender no longer consents to receive any messages from your WhatsApp Business Account, including transactional ones. Typing the word is the person's own statement, so it covers everything, unlike WhatsApp's built-in marketing opt-out control, which stops marketing alone.
  • opt_in records that they consent again.

A rule's operation is fixed once created, and a keyword belongs to exactly one operation, so a keyword Bird ships for opt_out cannot be reused for opt_in.

This is an open enum. Accept unrecognized values: SMS already answers help, info, confirm and custom, and WhatsApp gains an operation without a new API version. Sending one Bird does not answer yet is refused with E15082.

Possible values (may grow over time): opt_in, opt_out

data.country
nullable string

The country the rule applies in, as an ISO 3166-1 alpha-2 code. It is the country of the person who messaged you, worked out from their phone number, not the country of the account they messaged. Null means the rule applies worldwide, which is what Bird's own rules do. A rule for a country outranks a worldwide rule for the people it covers.

data.waba
nullable string

The WhatsApp Business Account the rule is limited to, identified by its WhatsApp-issued account ID, or null when it covers every account in your workspace. Bird's own rules are always null.

data.keywords
array of string
obligatoire

The keywords this rule adds. For one of Bird's own rules this is the full set Bird ships. For a rule you created it is only what you added on top: it never restates Bird's keywords, so effective_keywords is what actually matches.

data.excluded_keywords
array of string
obligatoire

Bird's keywords this rule removes from the set it inherits. Rules are tried most specific first, and a rule of yours with neither country nor waba comes after Bird's rule for the sender's country, as effective_keywords explains. When this rule answers a message that is exactly an excluded keyword, no one is opted in or out, no reply is sent, and no later rule acts on it, whether Bird's or another of yours that matches the same keyword. A more specific rule that answers first is unaffected. A rule with no country inherits Bird's keywords for each sender's country, so its exclusions apply only to senders whose set has the keyword. Excluding every one of Bird's keywords switches them off where this rule answers, though a keyword Bird adds later still matches unless it is already excluded. It changes no other rule's keywords. Always empty on one of Bird's own rules.

data.effective_keywords
array of string
obligatoire

Every keyword that matches this rule: Bird's keywords for the same operation and country, minus excluded_keywords, plus the ones you added. This is what an inbound message is compared against, and the whole message has to equal one of them. Keywords Bird adds later join it without you changing anything.

For a rule of yours with no country, this list is not the whole set it matches: such a rule compares against Bird's keywords for the sender's country, which the list cannot show because it does not know who is writing, so it shows Bird's worldwide keywords instead. Which rule answers decides whether that matters. Yours with no country and no waba sits below Bird's own country rule, so when a sender in a country Bird ships a rule for writes one of Bird's keywords, that rule answers and your reply is not used. A keyword you added reaches your rule only when no earlier rule matches it, and for a given sender the matched set can differ from this list in either direction. Yours with a waba and no country sits above it, so those senders match that country's keywords and get your reply, which is more keywords than this list names. Set a country on your own rule to see and extend exactly the set those senders match. A system rule is unaffected: each matches only its own keywords, and the ladder checks Bird's country rules separately from its worldwide one.

data.reply
nullable string

The message sent back when one of the keywords matches, or null when no reply is sent. The reply goes out on the conversation the inbound message opened.

data.created_at
string
obligatoire

When the rule was created. On one of Bird's own rules this is when Bird last shipped a change to it.

data.updated_at
string
obligatoire

When the rule was last changed. On one of Bird's own rules this is when Bird last shipped a change to it.

Poursuivez avec la documentation, les guides et les exemples sur ce sujet.