Allo

Lister les options de menu

Met à plat l'arbre du menu téléphonique du call flow publié de la ligne. Les brouillons sont ignorés. Chaque option donne :

GET/v2/api/numbers/{number}/menu_options

Comportement

Met à plat l'arbre du menu téléphonique du call flow publié de la ligne. Les brouillons sont ignorés. Chaque option donne :

  • path : les choix de menu depuis le premier menu jusqu'à cette option.
  • digits : le même chemin en touches, par exemple 1>2.
  • label : le nom de l'option dans le call flow.
  • condition : une condition MENU_BRANCH prête à l'emploi pour cette option. C'est toujours une MENU_BRANCH.

Une ligne sans menu téléphonique retourne une liste vide, de même qu'une ligne dont les appels ne sont pas routés par le moteur de call flow. Les conditions de menu ne sont acceptées que sur les lignes où cette liste n'est pas vide, et seulement avec des chemins qui en viennent. Sur toute autre ligne, utilisez une source sur toute la ligne, avec des conditions vides.

Utilisez-le seulement pour construire une branche sur mesure. Dans le cas courant, partez de Obtenir les suggestions de boîtes.

Combiner plusieurs options

Une ligne apparaît une seule fois dans sources, avec au plus une MENU_BRANCH. Pour couvrir plusieurs options d'une même ligne, concaténez les branches de leurs conditions dans une seule MENU_BRANCH :

{
  "allo_number": "+33612345678",
  "conditions": [
    {
      "type": "MENU_BRANCH",
      "branches": [
        [{"node_id": "node-1", "digit": "1"}, {"node_id": "node-3", "digit": "2"}],
        [{"node_id": "node-1", "digit": "2"}]
      ],
      "include_no_choice": false
    }
  ]
}

Erreurs

StatutCodeQuand
403ALLO_NUMBER_FORBIDDENL'appelant n'a pas accès à cette ligne

Autorisation

Authorizationstring · headerrequis

Api-Key ak_live_…

Paramètres de chemin

numberstringrequis

Allo line in E.164 format. URL-encode the + as %2B.

Réponses

200Menu options
dataobject[]
5 champs
node_idstringrequis

The menu node of the last step.

pathobject[]requis

Menu choices from the first menu down to this option.

2 champs
node_idstringrequis

ID of the phone-menu node in the line's published call flow.

digitstringrequis

Key pressed at that menu.

digitsstringrequis

The same path as keys, separated by >.

labelstringrequis
conditionobjectrequis

Narrows a source to calls that went through part of the line's phone menu. A source holds at most 10 conditions, and an inbox at most 60 menu steps in all.

401
403
429