Sign inGet Started
Commencer
Guides
Référence API
SDK
CLI
Base de connaissances
Changelog

List Apple Messages for Business routing rules

GET
/v1/amb/routing-rules
const result = await bird.amb.routingRules.list({
  business_account_id: "abz_01krdgeqcxet5s7t44vh8rt9mg",
});
console.log(result);
Réponse200
{
  "data": [
    {
      "created_at": "2026-05-20T09:14:52Z",
      "updated_at": "2026-05-25T16:42:01Z",
      "id": "arr_01krdgeqcxet5s7t44vh8rt9mg",
      "business_account_id": "abz_01krdgeqcxet5s7t44vh8rt9mg",
      "match_kind": "intent",
      "match_intent_id": "order_status",
      "match_group_id": "support",
      "queue": "billing",
      "precedence": 10,
      "is_default": false
    }
  ]
}

Returns the workspace's Apple Messages for Business routing rules, highest precedence first. Rules run when a conversation is created, when a closed conversation reopens, and when a customer writes to a resolved conversation, matching its group and intent to a queue. A message without a group or intent routes on the conversation's stored values. Later messages while the conversation is open in the inbox retain its queue.

Paramètres de requête

business_account_idstring

Keep only routing rules belonging to this business. Omit to return rules across all businesses in the workspace.

Contenu de la réponse

data
array of object
obligatoire

The workspace's routing rules, optionally filtered by business, highest precedence first and ties broken by id. Rules are evaluated within their business in this order. The set is returned in full; this list is not paginated.

Afficher les attributs enfants
data.created_at
string
obligatoire
data.updated_at
string
obligatoire
data.id
string
obligatoire

Unique identifier for the routing rule.

data.business_account_id
string
obligatoire

The Apple Messages for Business brand this rule belongs to.

data.match_kind
string
obligatoire

What 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

data.match_intent_id
nullable string

The entry point intent this rule matches, as sent in Apple's intentID. Set when match_kind is intent or both, null when it is group.

data.match_group_id
nullable string

The entry point group this rule matches, as sent in Apple's groupID. Set when match_kind is group or both, null when it is intent.

data.queue
string
obligatoire

The queue a matching conversation is filed into. A queue is a label your console filters by rather than a resource you create ahead of time, so any value routes.

data.precedence
integer
obligatoire

Evaluation order among this business's rules. The highest-precedence rule a conversation matches wins; rules tied on precedence are evaluated by their id.

data.is_default
boolean
obligatoire

Whether this rule catches a conversation that matches nothing else. A business has at most one. A conversation created or reopened while none exists routes to an empty queue, which the console lists as unrouted.

Ressources associées

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

Obtenir un guide d'implémentation