Accesskey5

Activeflow5

Agent11

AI34

Auth8

Billing12

Call24

Campaign14

Case10

Conference14

Contact17

Conversation11

Customer13

Email4

Extension8

Flow6

Groupcall5

Interaction2

Me1

Message4

Number9

Outdial11

Outplan6

Provider6

ProviderCall4

Queue13

RAG7

Recording4

Route5

Service Agent66

ServiceAgent9

Speaking7

Storage10

Tag5

Team6

Timeline8

Transcribe6

Transfer1

Trunk5

Webchat15

Websocket1

Call

Make an outbound call

Creates a temporary flow and initiates a call with the specified flow.

post/calls

Request body

flow_idstring uuid

The flow to execute for this call. The flow ID returned from the POST /flows or GET /flows response. Provide either flow_id or actions. If both are supplied, flow_id takes precedence and actions is ignored.

anonymous'yes' | 'no' | 'auto'

Controls anonymous caller ID for outbound PSTN calls. "yes" — always send anonymous caller ID (RFC 3323 Privacy header). "no" — never anonymize, always show real caller ID. "auto" — inherit from incoming call's Privacy header (default).

variablesobject

Optional flat key-value context seeded into the new call's flow as runtime variables, readable in the flow via ${key}. String values only. Reserved keys starting with 'voipbin.' are ignored. Max 100 keys, 64KB total, 32KB per value.

Example request

{
  "flow_id": "f1a2b3c4-d5e6-7890-1234-567890abcdef",
  "actions": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "next_id": "550e8400-e29b-41d4-a716-446655440000",
      "type": "talk",
      "tm_execute": "2026-01-15T09:30:00.000000Z"
    }
  ],
  "source": {
    "type": "tel",
    "target": "+14155551234",
    "target_name": "John Smith",
    "name": "Main Office",
    "detail": "Primary contact number"
  },
  "destinations": [
    {
      "type": "tel",
      "target": "+14155551234",
      "target_name": "John Smith",
      "name": "Main Office",
      "detail": "Primary contact number"
    }
  ],
  "anonymous": "auto",
  "variables": {
    "campaign_id": "summer-2026",
    "customer_name": "Jane Doe"
  }
}

Response

The details of the created call.

Example response

{
  "calls": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
      "owner_type": "agent",
      "owner_id": "c2d3e4f5-a6b7-8901-2cde-f01234567890",
      "flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
      "activeflow_id": "d4e5f6a7-b8c9-0123-4567-890abcdef012",
      "type": "flow",
      "master_call_id": "4d5e6f7a-8b9c-0123-def0-123456789012",
      "chained_call_ids": [
        "550e8400-e29b-41d4-a716-446655440000"
      ],
      "recording_id": "e5f6a7b8-c9d0-1234-5678-90abcdef0123",
      "recording_ids": [
        "e5f6a7b8-c9d0-1234-5678-90abcdef0123"
      ],
      "groupcall_id": "5e6f7a8b-9c0d-1234-ef01-234567890123",
      "source": {
        "type": "tel",
        "target": "+14155551234",
        "target_name": "John Smith",
        "name": "Main Office",
        "detail": "Primary contact number"
      },
      "destination": {
        "type": "tel",
        "target": "+14155551234",
        "target_name": "John Smith",
        "name": "Main Office",
        "detail": "Primary contact number"
      },
      "status": "progressing",
      "action": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "next_id": "550e8400-e29b-41d4-a716-446655440000",
        "type": "talk",
        "tm_execute": "2026-01-15T09:30:00.000000Z"
      },
      "direction": "outgoing",
      "mute_direction": "both",
      "hangup_by": "remote",
      "hangup_reason": "normal",
      "metadata": {
        "rtp_debug": true
      },
      "tm_progressing": "2026-01-15T09:30:00.000000Z",
      "tm_ringing": "2026-01-15T09:30:00.000000Z",
      "tm_hangup": "2026-01-15T09:30:00.000000Z",
      "tm_create": "2026-01-15T09:30:00.000000Z",
      "tm_update": "2026-01-15T09:30:00.000000Z",
      "tm_delete": "2026-01-15T09:30:00.000000Z"
    }
  ],
  "groupcalls": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
      "owner_type": "agent",
      "owner_id": "c2d3e4f5-a6b7-8901-2cde-f01234567890",
      "status": "progressing",
      "flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
      "source": {
        "type": "tel",
        "target": "+14155551234",
        "target_name": "John Smith",
        "name": "Main Office",
        "detail": "Primary contact number"
      },
      "destinations": [
        {
          "type": "tel",
          "target": "+14155551234",
          "target_name": "John Smith",
          "name": "Main Office",
          "detail": "Primary contact number"
        }
      ],
      "master_call_id": "4d5e6f7a-8b9c-0123-def0-123456789012",
      "master_groupcall_id": "5e6f7a8b-9c0d-1234-ef01-234567890123",
      "ring_method": "ring_all",
      "answer_method": "hangup_others",
      "answer_call_id": "550e8400-e29b-41d4-a716-446655440000",
      "call_ids": [
        "550e8400-e29b-41d4-a716-446655440000"
      ],
      "answer_groupcall_id": "5e6f7a8b-9c0d-1234-ef01-234567890123",
      "groupcall_ids": [
        "5e6f7a8b-9c0d-1234-ef01-234567890123"
      ],
      "call_count": 2,
      "groupcall_count": 1,
      "tm_create": "2026-01-15T09:30:00.000000Z",
      "tm_update": "2026-01-15T09:30:00.000000Z",
      "tm_delete": "2026-01-15T09:30:00.000000Z"
    }
  ]
}

Changes

Changed in 4 of the 54 revisions of this API.254

Jul 26, 2026d5569b31541142See the full diff
- ●
  added the new web_session enum value to the allOf[subschema #1]/calls/items/destination/type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new web_session enum value to the allOf[subschema #1]/calls/items/source/type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new web_session enum value to the allOf[subschema #1]/groupcalls/items/destinations/items/type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new web_session enum value to the allOf[subschema #1]/groupcalls/items/source/type response property for the response status 200
  response-property-enum-value-added
- ○
  added the new web_session enum value to the request property destinations/items/type
  request-property-enum-value-added
- ○
  added the new web_session enum value to the request property source/type
  request-property-enum-value-added
Jun 16, 20269d9cbd71ad4c2See the full diff
- ▲
  the actions request property's minItems was increased to 1
  request-property-min-items-increased
- ▲
  the flow_id request property type/format changed from string/ to string/uuid
  request-property-type-changed
Jun 10, 202650409c1b10f81See the full diff
- ○
  added the new optional request property variables
  new-optional-request-property
May 30, 2026995c56ba921911See the full diff
- ●
  removed the request property variables
  request-property-removed
- ○
  the flow_id request property type/format was generalized from string/uuid to string/
  request-property-type-generalized
This revision also has 20 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history