Allo

Get call flow

Returns the call flow for a phone number. By default returns the published flow (or an in-memory synthesis of the legacy IVR if none is published); pass…

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

Behavior

Returns the call flow for a phone number. The {number} path parameter is the Allo phone number in E.164 format (e.g. +14155551234).

By default this returns the published flow. If the number has no published flow, Allo returns an in-memory synthesis of the legacy IVR configuration with status: "SYNTHESIZED" (nothing is persisted). Pass ?status=draft to fetch the working draft instead.

Fields

  • status — DRAFT, PUBLISHED, or SYNTHESIZED.
  • lock_version — optimistic-concurrency token. Pass it back when saving a draft.
  • number — E.164 of the line this flow routes (null for a SYNTHESIZED flow).
  • confirmation_url — present only on a DRAFT: the link where a signed-in user reviews and publishes it. See Save call flow draft.
  • definition — the opaque call flow tree document (camelCase keys), rooted at entry_node_id.

Errors

  • 404 PHONE_NUMBER_NOT_FOUND — the number is not one of your account's numbers. List them with GET /v2/api/numbers.

Authorization

Authorizationstring · headerrequired

Api-Key ak_live_…

Path parameters

numberstringrequired

Allo phone number in E.164 format

Query parameters

statusenum<string>

Pass draft to fetch the working draft instead of the published flow.

draftpublished

Responses

200The call flow
dataobject

A version of a phone number's call flow.

11 fields
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).

401
404
429