Phone Numbers

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 ?status=draft to return the working draft instead.

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

Request

  • Base URL
    https://api.withallo.com
  • URL
    https://api.withallo.com/v2/api/numbers/{number}/call_flow
  • Auth
    API key in header Authorization

Path parameters

numberstring required
Example:+14155551234

Allo phone number in E.164 format

Query parameters

status'draft' | 'published'

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

Response

The call flow

Example response

{
  "data": {
    "id": "cflv-abc123",
    "flow_id": "cflw-abc123",
    "version": 3,
    "status": "PUBLISHED",
    "schema_version": 1,
    "engine_subset": "FULL_FLOW",
    "number": "+14155551234",
    "confirmation_url": "https://app.withallo.com/call-flow-draft/cflv-abc123",
    "entry_node_id": "node-22"
  }
}

Changes