Allo

Get call flow draft

Returns the working draft of a phone number's call flow. Unlike GET /v2/api/numbers/ /call flow?status=draft , this endpoint does NOT fall back to the…

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

Behavior

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

Unlike Get call flow with ?status=draft, this endpoint does not fall back to the published flow (or the legacy-IVR synthesis) when no draft exists — it returns 404 CALL_FLOW_DRAFT_NOT_FOUND.

The response includes a confirmation_url — the link where a signed-in user reviews and publishes this draft. To publish it directly instead, call Publish call flow with the lock_version from this response.

Errors

  • 404 CALL_FLOW_DRAFT_NOT_FOUND — the number has no working draft. Create one with PUT /v2/api/numbers/{number}/call_flow/draft.
  • 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

Responses

200The working draft
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