v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB

Call Control Applications

List call control applications

Return a list of call control applications.

get/call_control_applications

Query parameters

application_session_idstring uuid

The unique identifier of the call session. A session may include multiple call leg events.

connection_idstring

The unique identifier of the conection.

failedboolean

Delivery failed or not.

fromstring

Filter by From number.

leg_idstring uuid

The unique identifier of an individual call leg.

namestring

If present, conferences will be filtered to those with a matching name attribute. Matching is case-sensitive

outbound.outbound_voice_profile_idstring

Identifies the associated outbound voice profile.

product'call_control' | 'fax' | 'texml'

Filter by product.

status'init' | 'in_progress' | 'completed'

If present, conferences will be filtered by status.

tostring

Filter by To number.

type'command' | 'webhook'

Event type

Consolidated filter parameter (deepObject style). Originally: filter[application_name][contains], filter[outbound.outbound_voice_profile_id], filter[leg_id], filter[application_session_id], filter[connection_id], filter[product], filter[failed], filter[from], filter[to], filter[name], filter[type], filter[occurred_at][eq/gt/gte/lt/lte], filter[status]

{
  "from": "+12025550142",
  "occurred_at": {
    "eq": "2019-03-29T11:10:00Z",
    "gt": "2019-03-29T11:10:00Z",
    "gte": "2019-03-29T11:10:00Z",
    "lt": "2019-03-29T11:10:00Z",
    "lte": "2019-03-29T11:10:00Z"
  },
  "outbound.outbound_voice_profile_id": "1293384261075731499",
  "product": "texml",
  "to": "+12025550142",
  "type": "webhook"
}

afterstring

Opaque identifier of next page

beforestring

Opaque identifier of previous page

limitinteger

Limit of records per single page

numberinteger

The page number to load

sizeinteger

The size of the page

Consolidated page parameter (deepObject style). Originally: page[after], page[before], page[limit], page[size], page[number]

sort'created_at' | 'connection_name' | 'active'

Example:connection_name

Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the <code> -</code> prefix.<br/><br/> That is: <ul>

<li> <code>connection_name</code>: sorts the result by the <code>connection_name</code> field in ascending order. </li> <li> <code>-connection_name</code>: sorts the result by the <code>connection_name</code> field in descending order. </li> </ul> <br/> If not given, results are sorted by <code>created_at</code> in descending order.

Response

Successful response with a list of call control applications.

Example response

{
  "data": [
    {
      "active": false,
      "anchorsite_override": "Latency",
      "application_name": "call-router",
      "call_cost_in_webhooks": false,
      "created_at": "2018-02-02T22:25:27.521Z",
      "dtmf_type": "Inband",
      "first_command_timeout": true,
      "first_command_timeout_secs": 10,
      "id": "1293384261075731499",
      "inbound": {
        "channel_limit": 10,
        "shaken_stir_enabled": true,
        "sip_subdomain": "example",
        "sip_subdomain_receive_settings": "only_my_connections"
      },
      "outbound": {
        "channel_limit": 10,
        "outbound_voice_profile_id": "1293384261075731499"
      },
      "record_type": "call_control_application",
      "redact_dtmf_debug_logging": true,
      "updated_at": "2018-02-02T22:25:27.521Z",
      "webhook_api_version": "1",
      "webhook_event_failover_url": "https://failover.example.com",
      "webhook_event_url": "https://example.com",
      "webhook_timeout_secs": 25
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}