List call control applications
GET/call_control_applications
Return a list of call control applications.
Request
Query Parameters
-
connection_name
: sorts the result by theconnection_name
field in ascending order. -
-connection_name
: sorts the result by theconnection_name
field in descending order.
Possible values: >= 1
Default value: 1
The page number to load
Possible values: >= 1
and <= 250
Default value: 20
The size of the page
Default value: null
If present, applications with application_name
containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters.
Identifies the associated outbound voice profile.
Possible values: [created_at
, connection_name
, active
]
Default value: 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:
If not given, results are sorted by
created_at
Responses
200: Successful response with a list of call control applications.
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
data
object[]
Default value: true
Specifies whether the connection can be used.
Possible values: ["Latency"
, "Chicago, IL"
, "Ashburn, VA"
, "San Jose, CA"
]
Default value: "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.
A user-assigned name to help manage the application.
ISO 8601 formatted date of when the resource was created
Possible values: [RFC 2833
, Inband
, SIP INFO
]
Default value: 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.
Default value: false
Specifies whether calls to phone numbers associated with this connection should hangup after timing out.
Default value: 30
Specifies how many seconds to wait before timing out a dial command.
inbound
object
When set, this will limit the total number of inbound calls to phone numbers associated with this connection.
Default value: false
When enabled Telnyx will include Shaken/Stir data in the Webhook for new inbound calls.
Specifies a subdomain that can be used to receive Inbound calls to a Connection, in the same way a phone number is used, from a SIP endpoint. Example: the subdomain "example.sip.telnyx.com" can be called from any SIP endpoint by using the SIP URI "sip:@example.sip.telnyx.com" where the user part can be any alphanumeric value. Please note TLS encrypted calls are not allowed for subdomain calls.
Possible values: [only_my_connections
, from_anyone
]
Default value: from_anyone
This option can be enabled to receive calls from: "Anyone" (any SIP endpoint in the public Internet) or "Only my connections" (any connection assigned to the same Telnyx user).
outbound
object
When set, this will limit the total number of outbound calls to phone numbers associated with this connection.
Identifies the associated outbound voice profile.
Possible values: [call_control_application
]
Default value: call_control_application
ISO 8601 formatted date of when the resource was last updated
Possible values: [1
, 2
]
Default value: 1
Determines which webhook format will be used, Telnyx API v1 or v2.
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
.
The URL where webhooks related to this connection will be sent. Must include a scheme, such as https
.
Possible values: <= 30
meta
object
{
"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,
"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",
"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": {
"total_pages": 3,
"total_results": 55,
"page_number": 2,
"page_size": 25
}
}
400: Bad request
401: Unauthorized
404: Resource not found