Call Control Applications API

Call Control applications operations API

List call control applications

Return a list of call control applications.

SecuritybearerAuth
Request
query Parameters
page[number]
integer >= 1
Default: 1

The page number to load

page[size]
integer [ 1 .. 250 ]
Default: 20

The size of the page

filter[application_name][contains]
string
Default: "null"

If present, applications with application_name containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters.

filter[outbound_voice_profile_id]
string <int64>

Identifies the associated outbound voice profile.

Example: filter[outbound_voice_profile_id]=1293384261075731499
sort
string
Default: "created_at"

Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.

That is:

  • connection_name: sorts the result by the connection_name field in ascending order.

  • -connection_name: sorts the result by the connection_name field in descending order.

If not given, results are sorted by created_at in descending order.
Enum: "created_at" "connection_name" "active"
Example: sort=connection_name
Responses
200

Successful response with a list of call control applications.

Response Schema: application/json
Array of objects (Call Control Application)
object (PaginationMeta)
400

Bad request

401

Unauthorized response. Happens when the current user is not a manager account.

404

Resource not found

get/call_control_applications
Request samples 
import telnyx
telnyx.api_key = "YOUR_API_KEY"

telnyx.CallControlApplication.list(page={"number":1,"size":20})
Response samples
application/json
{
  • "data": [
    • {
      • "active": false,
      • "anchorsite_override": "\"Latency\"",
      • "application_name": "call-router",
      • "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,
        • "sip_subdomain": "example",
        • "sip_subdomain_receive_settings": "only_my_connections"
        },
      • "outbound": {
        • "channel_limit": 10,
        • "outbound_voice_profile_id": "1293384261075731499"
        },
      • "record_type": "call_control_application",
      • "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
    }
}

Create a call control application

Create a call control application.

SecuritybearerAuth
Request
Request Body schema: application/json
required

Create call control application request.

active
boolean
Default: true

Specifies whether the connection can be used.

anchorsite_override
string
Default: "\"Latency\""

Latency directs Telnyx to route media through the site with the lowest round-trip time to the user's connection. Telnyx calculates this time using ICMP ping messages. This can be disabled by specifying a site to handle all media.

Enum: "\"Latency\"" "\"Chicago, IL\"" "\"Ashburn, VA\"" "\"San Jose, CA\""
application_name
required
string

A user-assigned name to help manage the application.

dtmf_type
string
Default: "RFC 2833"

Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF digits sent to Telnyx will be accepted in all formats.

Enum: "RFC 2833" "Inband" "SIP INFO"
first_command_timeout
boolean
Default: false

Specifies whether calls to phone numbers associated with this connection should hangup after timing out.

first_command_timeout_secs
integer
Default: 30

Specifies how many seconds to wait before timing out a dial command.

object (CallControlApplicationInbound)
object (CallControlApplicationOutbound)
webhook_api_version
string
Default: "1"

Determines which webhook format will be used, Telnyx API v1 or v2.

Enum: "1" "2"
webhook_event_failover_url
string <url>
Default: ""

The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'.

webhook_event_url
required
string <url>

The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.

webhook_timeout_secs
integer [ 0 .. 30 ]
Default: null

Specifies how many seconds to wait before timing out a webhook.

Responses
201

Successful response with details about a call control application.

Response Schema: application/json
object (CallControlApplication)
active
boolean
Default: true

Specifies whether the connection can be used.

anchorsite_override
string
Default: "\"Latency\""

Latency directs Telnyx to route media through the site with the lowest round-trip time to the user's connection. Telnyx calculates this time using ICMP ping messages. This can be disabled by specifying a site to handle all media.

Enum: "\"Latency\"" "\"Chicago, IL\"" "\"Ashburn, VA\"" "\"San Jose, CA\""
application_name
string

A user-assigned name to help manage the application.

created_at
string

ISO 8601 formatted date of when the resource was created

dtmf_type
string
Default: "RFC 2833"

Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF digits sent to Telnyx will be accepted in all formats.

Enum: "RFC 2833" "Inband" "SIP INFO"
first_command_timeout
boolean
Default: false

Specifies whether calls to phone numbers associated with this connection should hangup after timing out.

first_command_timeout_secs
integer
Default: 30

Specifies how many seconds to wait before timing out a dial command.

id
string <int64>
object (CallControlApplicationInbound)
object (CallControlApplicationOutbound)
record_type
string
Default: "call_control_application"
Value: "call_control_application"
updated_at
string

ISO 8601 formatted date of when the resource was last updated

webhook_api_version
string
Default: "1"

Determines which webhook format will be used, Telnyx API v1 or v2.

Enum: "1" "2"
webhook_event_failover_url
string <url>
Default: ""

The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as https.

webhook_event_url
string <url>

The URL where webhooks related to this connection will be sent. Must include a scheme, such as https.

webhook_timeout_secs
integer [ 0 .. 30 ]
Default: null
422

Bad Request

post/call_control_applications
Request samples
application/json
{
  • "active": false,
  • "anchorsite_override": "\"Latency\"",
  • "application_name": "call-router",
  • "dtmf_type": "Inband",
  • "first_command_timeout": true,
  • "first_command_timeout_secs": 10,
  • "inbound": {
    • "channel_limit": 10,
    • "sip_subdomain": "example",
    • "sip_subdomain_receive_settings": "only_my_connections"
    },
  • "outbound": {
    • "channel_limit": 10,
    • "outbound_voice_profile_id": "1293384261075731499"
    },
  • "webhook_api_version": "1",
  • "webhook_event_failover_url": "https://failover.example.com",
  • "webhook_event_url": "https://example.com",
  • "webhook_timeout_secs": 25
}
Response samples
application/json
{
  • "data": {
    • "active": false,
    • "anchorsite_override": "\"Latency\"",
    • "application_name": "call-router",
    • "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,
      • "sip_subdomain": "example",
      • "sip_subdomain_receive_settings": "only_my_connections"
      },
    • "outbound": {
      • "channel_limit": 10,
      • "outbound_voice_profile_id": "1293384261075731499"
      },
    • "record_type": "call_control_application",
    • "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
    }
}

Delete a call control application

Deletes a call control application.

SecuritybearerAuth
Request
path Parameters
id
required
string <int64>

Identifies the resource.

Example: 1293384261075731499
Responses
200

Successful response with details about a call control application.

Response Schema: application/json
object (CallControlApplication)
active
boolean
Default: true

Specifies whether the connection can be used.

anchorsite_override
string
Default: "\"Latency\""

Latency directs Telnyx to route media through the site with the lowest round-trip time to the user's connection. Telnyx calculates this time using ICMP ping messages. This can be disabled by specifying a site to handle all media.

Enum: "\"Latency\"" "\"Chicago, IL\"" "\"Ashburn, VA\"" "\"San Jose, CA\""
application_name
string

A user-assigned name to help manage the application.

created_at
string

ISO 8601 formatted date of when the resource was created

dtmf_type
string
Default: "RFC 2833"

Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF digits sent to Telnyx will be accepted in all formats.

Enum: "RFC 2833" "Inband" "SIP INFO"
first_command_timeout
boolean
Default: false

Specifies whether calls to phone numbers associated with this connection should hangup after timing out.

first_command_timeout_secs
integer
Default: 30

Specifies how many seconds to wait before timing out a dial command.

id
string <int64>
object (CallControlApplicationInbound)
object (CallControlApplicationOutbound)
record_type
string
Default: "call_control_application"
Value: "call_control_application"
updated_at
string

ISO 8601 formatted date of when the resource was last updated

webhook_api_version
string
Default: "1"

Determines which webhook format will be used, Telnyx API v1 or v2.

Enum: "1" "2"
webhook_event_failover_url
string <url>
Default: ""

The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as https.

webhook_event_url
string <url>

The URL where webhooks related to this connection will be sent. Must include a scheme, such as https.

webhook_timeout_secs
integer [ 0 .. 30 ]
Default: null
401

Unauthorized response. Happens when the current user is not a manager account.

404

Resource not found

422

Bad request

delete/call_control_applications/{id}
Request samples 
import telnyx
telnyx.api_key = "YOUR_API_KEY"

res = telnyx.CallControlApplication.retrieve('id')
res.delete()
Response samples
application/json
{
  • "data": {
    • "active": false,
    • "anchorsite_override": "\"Latency\"",
    • "application_name": "call-router",
    • "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,
      • "sip_subdomain": "example",
      • "sip_subdomain_receive_settings": "only_my_connections"
      },
    • "outbound": {
      • "channel_limit": 10,
      • "outbound_voice_profile_id": "1293384261075731499"
      },
    • "record_type": "call_control_application",
    • "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
    }
}

Retrieve a call control application

Retrieves the details of an existing call control application.

SecuritybearerAuth
Request
path Parameters
id
required
string <int64>

Identifies the resource.

Example: 1293384261075731499
Responses
200

Successful response with details about a call control application.

Response Schema: application/json
object (CallControlApplication)
active
boolean
Default: true

Specifies whether the connection can be used.

anchorsite_override
string
Default: "\"Latency\""

Latency directs Telnyx to route media through the site with the lowest round-trip time to the user's connection. Telnyx calculates this time using ICMP ping messages. This can be disabled by specifying a site to handle all media.

Enum: "\"Latency\"" "\"Chicago, IL\"" "\"Ashburn, VA\"" "\"San Jose, CA\""
application_name
string

A user-assigned name to help manage the application.

created_at
string

ISO 8601 formatted date of when the resource was created

dtmf_type
string
Default: "RFC 2833"

Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF digits sent to Telnyx will be accepted in all formats.

Enum: "RFC 2833" "Inband" "SIP INFO"
first_command_timeout
boolean
Default: false

Specifies whether calls to phone numbers associated with this connection should hangup after timing out.

first_command_timeout_secs
integer
Default: 30

Specifies how many seconds to wait before timing out a dial command.

id
string <int64>
object (CallControlApplicationInbound)
object (CallControlApplicationOutbound)
record_type
string
Default: "call_control_application"
Value: "call_control_application"
updated_at
string

ISO 8601 formatted date of when the resource was last updated

webhook_api_version
string
Default: "1"

Determines which webhook format will be used, Telnyx API v1 or v2.

Enum: "1" "2"
webhook_event_failover_url
string <url>
Default: ""

The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as https.

webhook_event_url
string <url>

The URL where webhooks related to this connection will be sent. Must include a scheme, such as https.

webhook_timeout_secs
integer [ 0 .. 30 ]
Default: null
401

Unauthorized response. Happens when the current user is not a manager account.

404

Resource not found

422

Bad request

get/call_control_applications/{id}
Request samples 
import telnyx
telnyx.api_key = "YOUR_API_KEY"

telnyx.CallControlApplication.retrieve("id")
Response samples
application/json
{
  • "data": {
    • "active": false,
    • "anchorsite_override": "\"Latency\"",
    • "application_name": "call-router",
    • "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,
      • "sip_subdomain": "example",
      • "sip_subdomain_receive_settings": "only_my_connections"
      },
    • "outbound": {
      • "channel_limit": 10,
      • "outbound_voice_profile_id": "1293384261075731499"
      },
    • "record_type": "call_control_application",
    • "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
    }
}

Update a call control application

Updates settings of an existing call control application.

SecuritybearerAuth
Request
path Parameters
id
required
string <int64>

Identifies the resource.

Example: 1293384261075731499
Request Body schema: application/json
required

Update call control application request.

active
boolean
Default: true

Specifies whether the connection can be used.

anchorsite_override
string
Default: "\"Latency\""

Latency directs Telnyx to route media through the site with the lowest round-trip time to the user's connection. Telnyx calculates this time using ICMP ping messages. This can be disabled by specifying a site to handle all media.

Enum: "\"Latency\"" "\"Chicago, IL\"" "\"Ashburn, VA\"" "\"San Jose, CA\""
application_name
required
string

A user-assigned name to help manage the application.

dtmf_type
string
Default: "RFC 2833"

Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF digits sent to Telnyx will be accepted in all formats.

Enum: "RFC 2833" "Inband" "SIP INFO"
first_command_timeout
boolean
Default: false

Specifies whether calls to phone numbers associated with this connection should hangup after timing out.

first_command_timeout_secs
integer
Default: 30

Specifies how many seconds to wait before timing out a dial command.

object (CallControlApplicationInbound)
object (CallControlApplicationOutbound)
webhook_api_version
string
Default: "1"

Determines which webhook format will be used, Telnyx API v1 or v2.

Enum: "1" "2"
webhook_event_failover_url
string <url>
Default: ""

The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'.

webhook_event_url
required
string <url>

The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.

webhook_timeout_secs
integer [ 0 .. 30 ]
Default: null

Specifies how many seconds to wait before timing out a webhook.

Responses
200

Successful response with details about a call control application.

Response Schema: application/json
object (CallControlApplication)
active
boolean
Default: true

Specifies whether the connection can be used.

anchorsite_override
string
Default: "\"Latency\""

Latency directs Telnyx to route media through the site with the lowest round-trip time to the user's connection. Telnyx calculates this time using ICMP ping messages. This can be disabled by specifying a site to handle all media.

Enum: "\"Latency\"" "\"Chicago, IL\"" "\"Ashburn, VA\"" "\"San Jose, CA\""
application_name
string

A user-assigned name to help manage the application.

created_at
string

ISO 8601 formatted date of when the resource was created

dtmf_type
string
Default: "RFC 2833"

Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF digits sent to Telnyx will be accepted in all formats.

Enum: "RFC 2833" "Inband" "SIP INFO"
first_command_timeout
boolean
Default: false

Specifies whether calls to phone numbers associated with this connection should hangup after timing out.

first_command_timeout_secs
integer
Default: 30

Specifies how many seconds to wait before timing out a dial command.

id
string <int64>
object (CallControlApplicationInbound)
object (CallControlApplicationOutbound)
record_type
string
Default: "call_control_application"
Value: "call_control_application"
updated_at
string

ISO 8601 formatted date of when the resource was last updated

webhook_api_version
string
Default: "1"

Determines which webhook format will be used, Telnyx API v1 or v2.

Enum: "1" "2"
webhook_event_failover_url
string <url>
Default: ""

The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as https.

webhook_event_url
string <url>

The URL where webhooks related to this connection will be sent. Must include a scheme, such as https.

webhook_timeout_secs
integer [ 0 .. 30 ]
Default: null
401

Unauthorized response. Happens when the current user is not a manager account.

404

Resource not found

422

Bad request

patch/call_control_applications/{id}
Request samples
application/json
{
  • "active": false,
  • "anchorsite_override": "\"Latency\"",
  • "application_name": "call-router",
  • "dtmf_type": "Inband",
  • "first_command_timeout": true,
  • "first_command_timeout_secs": 10,
  • "inbound": {
    • "channel_limit": 10,
    • "sip_subdomain": "example",
    • "sip_subdomain_receive_settings": "only_my_connections"
    },
  • "outbound": {
    • "channel_limit": 10,
    • "outbound_voice_profile_id": "1293384261075731499"
    },
  • "webhook_api_version": "1",
  • "webhook_event_failover_url": "https://failover.example.com",
  • "webhook_event_url": "https://example.com",
  • "webhook_timeout_secs": 25
}
Response samples
application/json
{
  • "data": {
    • "active": false,
    • "anchorsite_override": "\"Latency\"",
    • "application_name": "call-router",
    • "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,
      • "sip_subdomain": "example",
      • "sip_subdomain_receive_settings": "only_my_connections"
      },
    • "outbound": {
      • "channel_limit": 10,
      • "outbound_voice_profile_id": "1293384261075731499"
      },
    • "record_type": "call_control_application",
    • "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
    }
}