List SMS keyword rules

GET

/v1/sms/keyword-rules

const rules = await bird.smsKeywordRules.list({ country: "NL" });
for (const rule of rules.data) {
  console.log(rule.operation, rule.keywords);
}

rules = client.sms_keyword_rules.list(country="NL")
for rule in rules.data:
    print(rule.operation, rule.keywords)

rules, err := client.SmsKeywordRules.List(context.Background(), bird.SmsKeywordRulesListParams{
	Country: "NL", // omit for every country Bird's catalogue covers, plus your own rules
})
if err != nil {
	log.Fatal(err)
}
for _, rule := range rules.Data {
	fmt.Println(rule.Operation, rule.Keywords)
}

$rules = $bird->smsKeywordRules->list(['country' => 'NL']);
foreach ($rules->getData() ?? [] as $rule) {
    echo $rule->getOperation(), ' ', implode(',', $rule->getKeywords() ?? []), PHP_EOL;
}

bird sms keyword-rules list

curl -X GET "https://us1.platform.bird.com/v1/sms/keyword-rules" \
  -H "Authorization: Bearer $TOKEN"

Returns what happens when someone replies to your numbers: Bird's default keyword rules and any you have created, ordered most specific first. Where Bird's catalogue covers a country, opt-out, opt-in and help are answered with no setup on your side.

Unfiltered, you get Bird's whole catalogue alongside your own rules. Use country, number, operation and scope to narrow that; scope=system browses Bird's catalogue alone. Pass number to see the rules for one number in the order they are applied, and add from_country to see what a sender from another country gets. The set is small and returned in full; this list is not paginated.

Coverage is per country. Filter by country to see what applies there: where the catalogue holds no rules, no keyword is recognised, nothing is answered, and no opt-out is recorded, so honouring opt-outs in that country is yours to handle. You can still add your own custom keywords for it, while opt-out, opt-in and help rules can only be created for a country the catalogue covers.

Parâmetros de consulta

country

string

Keep only rules that apply in this country, as an ISO 3166-1 alpha-2 code. Omit for every country Bird's catalogue covers, plus your own rules.

number

string

Keep only the rules that apply to this number of yours, in E.164 format or as a short code, ordered the way they are applied to an inbound message.

from_country

string

The country a sender is messaging from, as an ISO 3166-1 alpha-2 code. Use it with number to see what someone in that country gets, which can differ from what a local sender gets. Ignored without number.

operation

string

Keep only rules for this operation. Omit for all of them.

Possible values (may grow over time): stop, start, help, custom

scope

string

Keep only Bird's defaults (system) or only the rules you created (workspace). Omit for both.

Possible values: system, workspace

Payload de resposta

data

array of object

obrigatório

The keyword rules that apply to your workspace, Bird's defaults 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.

Mostrar atributos secundários

data.id

string

obrigatório

Identifier of a keyword rule. An sks_ id is one of Bird's defaults, which you can read but not change; an skw_ id is a rule your workspace created.

data.scope

string

obrigatório

Whether the rule is one of Bird's defaults (system) or one your workspace created (workspace). A workspace rule takes precedence over Bird's default for the same country, so it is how you replace a reply without losing the keywords Bird ships.

Possible values: system, workspace

data.operation

string

obrigatório

What Bird does when an inbound message matches one of the rule's keywords. "stop" unsubscribes the sender, "start" resubscribes them, and "help" replies with your support information. Those three are what carriers and regulators expect a number to honour, so Bird ships keywords for them wherever its catalogue covers the country, and you cannot change what they do. "custom" carries no built-in behaviour: it matches keywords you choose and sends the reply you write, which is how campaign keywords like PIZZA are handled. Open enum: additional operations may be added over time, so treat an unrecognized value as a future operation rather than an error.

Possible values (may grow over time): stop, start, help, custom

data.country

nullable string

The country the rule applies in, as an ISO 3166-1 alpha-2 code. A rule for NL covers messages received on your Dutch numbers, and messages from a subscriber whose own number is Dutch whichever of your numbers they text. A rule for the country a message arrives in wins over a rule for the country its sender is in, and both win over Bird's own keywords; number confines a rule to one number. Null means the rule applies worldwide, which is allowed for custom operations only.

data.language

nullable string

The language this rule covers, in countries where Bird ships keywords in more than one. Canada has separate English and French rules, so a Canadian rule names which one it replaces and the other keeps Bird's reply. Null in countries with a single set.

data.number

nullable string

Narrows the rule to one of your numbers in E.164 format, instead of every number you hold in the country. Null means it applies to all of them.

data.keywords

array of string

obrigatório

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

data.effective_keywords

array of string

obrigatório

Every keyword that matches this rule: Bird's keywords for the same operation, country and language, plus the ones you added. This is what an inbound message is compared against. Keywords Bird adds later join it without you changing anything.

data.reply

nullable string

The message sent back when one of the keywords matches. Null when the auto-reply is switched off, which reply_disabled_at distinguishes from a rule that has not been given one.

data.reply_suffix

nullable string

Text appended to your reply that you cannot change: the rates and opt-out wording carriers require on a help response. Your reply is sent in front of it, and both count against the length a single message allows. Null when the operation carries none.

data.reply_disabled_at

nullable string

When the auto-reply for this rule was switched off, or null if it is on. Switching it off records that you send this reply from your own system, which is what Bird points to if a carrier asks why no reply went out.

data.mandatory

boolean

obrigatório

Whether what this operation does is fixed. When true you can change the reply but not the behaviour. An opt-out keyword always unsubscribes the sender, whichever rule matched it, because carriers and regulators require it.

data.created_at

string

obrigatório

When the rule was created.

data.updated_at

string

obrigatório

When the rule was last changed. On one of Bird's defaults this is when Bird last changed the keywords or the reply for that country.

const rules = await bird.smsKeywordRules.list({ country: "NL" });
for (const rule of rules.data) {
  console.log(rule.operation, rule.keywords);
}

rules = client.sms_keyword_rules.list(country="NL")
for rule in rules.data:
    print(rule.operation, rule.keywords)

rules, err := client.SmsKeywordRules.List(context.Background(), bird.SmsKeywordRulesListParams{
	Country: "NL", // omit for every country Bird's catalogue covers, plus your own rules
})
if err != nil {
	log.Fatal(err)
}
for _, rule := range rules.Data {
	fmt.Println(rule.Operation, rule.Keywords)
}

$rules = $bird->smsKeywordRules->list(['country' => 'NL']);
foreach ($rules->getData() ?? [] as $rule) {
    echo $rule->getOperation(), ' ', implode(',', $rule->getKeywords() ?? []), PHP_EOL;
}

bird sms keyword-rules list

curl -X GET "https://us1.platform.bird.com/v1/sms/keyword-rules" \
  -H "Authorization: Bearer $TOKEN"