Call Control

The Audian Call Control API provides comprehensive tools for making, receiving, and managing phone calls through callflows, channels, and real-time actions.

Base URL

https://api.audian.com:8443/v2/accounts/{ACCOUNT_ID}

Authentication

All requests require the X-Auth-Token header:

curl -X GET "https://api.audian.com:8443/v2/accounts/{ACCOUNT_ID}/callflows" \
  -H "X-Auth-Token: {AUTH_TOKEN}" \
  -H "Accept: application/json"

Core Components

Callflows

Callflows define how calls are routed and handled. They determine what happens when a call arrives at a number.

curl -X GET "https://api.audian.com:8443/v2/accounts/{ACCOUNT_ID}/callflows?paginate=false" \
  -H "X-Auth-Token: {AUTH_TOKEN}" \
  -H "Accept: application/json"

Response

{
  "auth_token": "eyJhbGciOiJSUzI1...",
  "data": [
    {
      "id": "callflow_abc123",
      "name": "Main Line",
      "numbers": ["+14155552671"],
      "flow": {
        "module": "ring_group",
        "data": {
          "endpoints": ["device_xyz789"]
        }
      }
    }
  ],
  "request_id": "req_xyz789",
  "status": "success"
}

Create Callflow

curl -X PUT "https://api.audian.com:8443/v2/accounts/{ACCOUNT_ID}/callflows" \
  -H "X-Auth-Token: {AUTH_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "data": {
      "name": "Support Line",
      "numbers": ["+14155552672"],
      "flow": {
        "module": "ring_group",
        "data": {
          "endpoints": [
            {"endpoint_type": "device", "id": "device_abc123"},
            {"endpoint_type": "user", "id": "user_xyz789"}
          ],
          "strategy": "simultaneous",
          "timeout": 30
        }
      }
    }
  }'

Channels (Active Calls)

View and control active calls:

curl -X GET "https://api.audian.com:8443/v2/accounts/{ACCOUNT_ID}/channels" \
  -H "X-Auth-Token: {AUTH_TOKEN}" \
  -H "Accept: application/json"

Response

{
  "auth_token": "eyJhbGciOiJSUzI1...",
  "data": [
    {
      "uuid": "channel_uuid_123",
      "direction": "inbound",
      "destination": "+14155552671",
      "caller_id_number": "+14155559999",
      "answered": true,
      "timestamp": "2026-02-04T10:30:00Z"
    }
  ],
  "status": "success"
}

Call Flow Modules

Audian supports various call handling modules:

Module	Description
ring_group	Ring multiple endpoints
user	Route to a specific user
device	Route to a specific device
voicemail	Send to voicemail
menu	IVR menu
temporal_route	Time-based routing
callflow	Nest another callflow

Ring Group Strategies

Strategy	Description
simultaneous	Ring all endpoints at once
single	Ring endpoints one at a time
weighted_random	Randomly distribute calls

Create IVR Menu

curl -X PUT "https://api.audian.com:8443/v2/accounts/{ACCOUNT_ID}/callflows" \
  -H "X-Auth-Token: {AUTH_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "data": {
      "name": "Main IVR",
      "numbers": ["+14155552671"],
      "flow": {
        "module": "menu",
        "data": {
          "id": "menu_abc123"
        },
        "children": {
          "1": {
            "module": "ring_group",
            "data": {"endpoints": ["device_sales"]}
          },
          "2": {
            "module": "ring_group",
            "data": {"endpoints": ["device_support"]}
          },
          "_": {
            "module": "voicemail",
            "data": {"id": "vmbox_main"}
          }
        }
      }
    }
  }'

Transfer a Call

curl -X POST "https://api.audian.com:8443/v2/accounts/{ACCOUNT_ID}/channels/{CHANNEL_UUID}" \
  -H "X-Auth-Token: {AUTH_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "data": {
      "action": "transfer",
      "target": "+14155552673"
    }
  }'

Hangup a Call

curl -X DELETE "https://api.audian.com:8443/v2/accounts/{ACCOUNT_ID}/channels/{CHANNEL_UUID}" \
  -H "X-Auth-Token: {AUTH_TOKEN}"

Call States

State	Description
ringing	Call is ringing
answered	Call is connected
bridged	Call is bridged to another party
held	Call is on hold
transferring	Call is being transferred
completed	Call has ended

Quick Reference

Action	Method	Endpoint
List callflows	GET	/v2/accounts/{id}/callflows
Create callflow	PUT	/v2/accounts/{id}/callflows
Update callflow	POST	/v2/accounts/{id}/callflows/{callflow_id}
Delete callflow	DELETE	/v2/accounts/{id}/callflows/{callflow_id}
List channels	GET	/v2/accounts/{id}/channels
Control channel	POST	/v2/accounts/{id}/channels/{uuid}
Hangup channel	DELETE	/v2/accounts/{id}/channels/{uuid}

Topics

• Callflows - Define call routing
• IVR Menus - Interactive voice response
• Ring Groups - Group calling
• Time-Based Routing - Schedule-based routing
• Call Recording - Record calls