NetBird
sms_keyword_rules_create
Replace the default opt-out, opt-in, or help reply for one country, or add a `custom` keyword. A workspace rule takes precedence over the default for that country. Opt-out and opt-in keywords cannot be assigned to another operation.
Remote bird/mcp
Remote (network-hosted)
Other tools also called sms_keyword_rules_create?
See providers with this name
Input Schema
{
"type": "object",
"properties": {
"reply": {
"type": [
"null",
"string"
],
"description": "The message to send back when a keyword matches, except on a confirm rule, which never sends one whatever this is set to. Set it to null together with confirmed_self_managed to send nothing at all."
},
"number": {
"type": [
"null",
"string"
],
"description": "Narrows the rule to one number you hold, in E.164 format or as a short code. Omit to cover every number you hold in the country. The number must be one of yours and able to receive messages."
},
"country": {
"type": [
"null",
"string"
],
"description": "The country this rule applies in, as an ISO 3166-1 alpha-2 code. It matches a message two ways: one received on any of your numbers in this country, and one sent by a subscriber whose own number is in it, wherever they text you. Rules for the country a message arrives in always outrank rules for the country its sender is in; within each, your rule wins over Bird's keywords for that country. To confine a rule to one of your numbers, set number instead. Required for stop, start and help, because those replace what Bird ships for one country and a worldwide rule would replace every country's. Omit it only for custom, which then applies everywhere you send. Derived from number when you supply an E.164 number and leave this out; a short code carries no country, so a rule for one must name it."
},
"keywords": {
"type": [
"null",
"array"
],
"items": {
"type": "string"
},
"description": "Extra keywords to match, on top of the ones Bird already ships for this operation and country. Omit to keep Bird's keywords and change only the reply, including keywords Bird adds later. You cannot remove one of Bird's keywords, and a keyword Bird has bound to another operation cannot be reused here. Required for custom, which inherits none."
},
"language": {
"type": [
"null",
"string"
],
"description": "Which language this rule replaces, in countries where Bird ships keywords in more than one. Required there and rejected elsewhere. Listing the country's rules shows whether it applies and which languages are available."
},
"operation": {
"type": "string",
"description": "What Bird does when an inbound message matches the rule. - stop unsubscribes the sender from further messages. - start resubscribes them. - help replies with your support information. - info replies with your program information. It behaves exactly as help does and is separate so a country whose INFO answer must differ from its HELP answer can carry both. Where Bird ships no info rule for a country, INFO is one of that country's help keywords and answers with the help reply. - confirm marks a double opt-in reply. It sends nothing today, so answer it from your own handler. - custom replies with the text you configured and has no other effect. Bird's built-in rules fix the operation for stop, start and help; you can change their reply but not what they do. The same holds for info in any country where Bird ships an info rule. This is an open enum. Accept unrecognized values."
},
"idempotency_key": {
"type": "string",
"description": "Client-supplied deduplication key; a retry with the same key replays the original result instead of acting twice."
},
"confirmed_self_managed": {
"type": [
"null",
"boolean"
],
"description": "Set this with reply: null to confirm you send this reply from your own system, which switches Bird's auto-reply off for the rule. Required to send no reply, and rejected when a reply is given, so the two can never disagree."
}
}
}