Sign inGet Started

bird amb routing-rules create

Usage

Contoh kode
bird amb routing-rules create [flags]

Description

Create an Apple Messages for Business routing rule
Creates a routing rule for one of your Apple Messages for Business brands. Set is_default to make it the rule that catches a conversation matching nothing else. A business can have only one default rule, and creating a second while one exists returns a 409.
Build the request from flags, a JSON AMBRoutingRuleCreate body via --body-file ("-" reads stdin), or both — a flag overrides the matching body field. Run --example to print a ready-to-edit body, or --dry-run to print the resolved request without sending it.

Examples

Contoh kode
# print the body shape (no credentials needed)
bird amb routing-rules create --example

# the body it prints:
Contoh kode
{
  "business_id": "abz_01krdgeqcxet5s7t44vh8rt9mg",
  "is_default": false,
  "match_intent_id": "order_status",
  "match_kind": "intent",
  "precedence": 10,
  "queue": "billing"
}

Options

Request

NameDescription
--body-fileRead the JSON request body from this file; "-" reads stdin
--examplePrint a complete example request body, then exit
--dry-runPrint the resolved request without sending it, then exit
--idempotency-keyDeduplication key; a retry with the same key won't act twice

Options

NameDescription
--business-idThe Apple Messages for Business brand this rule belongs to. (required; or in --body-file)
--match-kindWhat a routing rule matches against the entry point that started the conversation. - intent matches on the entry point's intent alone: match_intent_id is set and match_group_id is null. - group matches on the entry point's group alone: match_group_id is set and match_intent_id is null. - both matches only when the entry point carries the given intent and the given group together, so match_intent_id and match_group_id are both set. There are two match fields rather than one because both needs to carry an intent and a group at once. Possible values: intent, group, both. (required; or in --body-file)
--match-intent-idThe entry point intent to match, as sent in Apple's intentID. Required when match_kind is intent or both, and rejected when it is group.
--match-group-idThe entry point group to match, as sent in Apple's groupID. Required when match_kind is group or both, and rejected when it is intent.
--queueThe queue a matching conversation is filed into. Your console lists whichever values your rules use. (required; or in --body-file)
--precedence <n>Evaluation order among this business's rules. The highest-precedence rule a conversation matches wins. Omit it to default to 0.
--is-defaultSet to make this the rule that catches a conversation matching nothing else. A business can have only one; creating a second while one exists returns a 409.
--response-schemaPrint the fields this command returns, then exit
NameDescription
bird amb routing-rules deleteDelete an Apple Messages for Business routing rule
bird amb routing-rules getGet an Apple Messages for Business routing rule
bird amb routing-rules listList Apple Messages for Business routing rules
bird amb routing-rules updateUpdate an Apple Messages for Business routing rule

Sumber daya terkait

Lanjutkan dengan dokumentasi, panduan, dan contoh untuk topik ini. Sumber daya tersedia dalam bahasa Inggris.

Dapatkan ringkasan implementasi