Renvoie le flux d'appel d'un numéro de téléphone. Le paramètre de chemin est le numéro Allo au format E.164 (ex. +14155551234 ).
GET/v2/api/numbers/{number}/call_flow
Comportement
Renvoie le flux d'appel d'un numéro de téléphone. Le paramètre de chemin {number} est le numéro Allo au format E.164 (ex. +14155551234).
Par défaut, cette route renvoie le flux publié. Si le numéro n'a aucun flux publié, Allo renvoie une synthèse en mémoire de la configuration IVR héritée avec status: "SYNTHESIZED" (rien n'est persisté). Passez ?status=draft pour récupérer le brouillon de travail.
Champs
status — DRAFT, PUBLISHED ou SYNTHESIZED.
lock_version — jeton de concurrence optimiste. Renvoyez-le lors de l'enregistrement d'un brouillon.
number — E.164 de la ligne routée par ce flux (null pour un flux SYNTHESIZED).
definition — le document opaque de l'arbre du flux d'appel (clés en camelCase), enraciné à entry_node_id.
Erreurs
404 PHONE_NUMBER_NOT_FOUND — le numéro ne fait pas partie des numéros de votre compte. Listez-les avec GET /v2/api/numbers.
Autorisation
Authorizationstring · headerrequis
Api-Key ak_live_…
Paramètres de chemin
numberstringrequis
Allo phone number in E.164 format
Paramètres de requête
statusenum<string>
Pass draft to fetch the working draft instead of the published flow.
draftpublished
Réponses
200The call flow
dataobject
A version of a phone number's call flow.
11 champs
idstring | null
The call flow version ID. Null for a synthesized (never-persisted) flow.
flow_idstring | null
The parent call flow ID. Null for a synthesized flow.
versioninteger
Monotonic version number within the flow.
statusenum<string>
DRAFT (working copy), PUBLISHED (live), or SYNTHESIZED (in-memory representation of a legacy IVR-only line).
DRAFTPUBLISHEDSYNTHESIZED
lock_versioninteger
Optimistic-concurrency token; pass it back on the next draft save.
schema_versioninteger
The call flow schema version this definition conforms to.
engine_subsetenum<string>
FULL_FLOW runs the whole tree on live calls. NESTED_IVR runs only the root phone menu: its keys that lead to a nested menu, a condition or a voicemail node do nothing.
NESTED_IVRFULL_FLOW
numberstring | null
E.164 of the line this flow routes. Null for a never-persisted SYNTHESIZED flow.
confirmation_urlstring | null
A link where a signed-in user reviews this draft and publishes it. Present only on a DRAFT (a PUBLISHED or SYNTHESIZED version has nothing to confirm). Use it when a person should approve the change; to go live without one, call POST /v2/api/numbers/{number}/call_flow/publish. Treat it as opaque: pass it through verbatim, and never construct or parse it.
entry_node_idstring
The id of the entry node in definition.nodes.
definitionobject
The call flow tree document (opaque; camelCase keys).