Skip to main content

List call control applications

GET 
/call_control_applications

Return a list of call control applications.

Request​

Query Parameters

    page[number] integer

    Possible values: >= 1

    Default value: 1

    The page number to load

    page[size] integer

    Possible values: >= 1 and <= 250

    Default value: 20

    The size of the page

    filter[application_name][contains] string

    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.

    filter[outbound.outbound_voice_profile_id] int64

    Identifies the associated outbound voice profile.

    sort string

    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:

    • 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.

Responses​

200: Successful response with a list of call control applications.

Schema

    data

    object[]

  • Array [

    • active boolean

    Default value: true

    Specifies whether the connection can be used.

    anchorsite_override string

    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.

    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

    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.

    first_command_timeout boolean

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

    first_command_timeout_secs integer

    Default value: 30

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

    id int64

    inbound

    object

    channel_limit integer

    When set, this will limit the total number of inbound calls to phone numbers associated with this connection.

    shaken_stir_enabled boolean

    When enabled Telnyx will include Shaken/Stir data in the Webhook for new inbound calls.

    sip_subdomain string

    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.

    sip_subdomain_receive_settings string

    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

    channel_limit integer

    When set, this will limit the total number of outbound calls to phone numbers associated with this connection.

    outbound_voice_profile_id int64

    Identifies the associated outbound voice profile.

    record_type string

    Possible values: [call_control_application]

    Default value: call_control_application

    updated_at string

    ISO 8601 formatted date of when the resource was last updated

    webhook_api_version string

    Possible values: [1, 2]

    Default value: 1

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

    webhook_event_failover_url urlnullable

    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 url

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

    webhook_timeout_secs integernullable

    Possible values: <= 30

  • ]

    • meta

    object

    total_pages integer
    total_results integer
    page_number integer
    page_size integer

400: Bad request

401: Unauthorized

404: Resource not found

Loading...