v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014102371.0 MB

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"
    }
  ]
}