Skip to main content

List all External Connections

GET 

/external_connections

This endpoint returns a list of your External Connections inside the 'data' attribute of the response. External Connections are used by Telnyx customers to seamless configure SIP trunking integrations with Telnyx Partners, through External Voice Integrations in Mission Control Portal.

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: 250

    The size of the page

    filter[connection_name][contains] string

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

    filter[external_sip_connection] string

    Possible values: [zoom, operator_connect]

    If present, connections with external_sip_connection matching the given value will be returned.

    filter[id] string

    If present, connections with id matching the given value will be returned.

    filter[created_at] string

    If present, connections with created_at date matching the given YYYY-MM-DD date will be returned.

    filter[phone_number][contains] string

    If present, connections associated with the given phone_number will be returned. A full match is necessary with a e164 format.

Responses

200: Successful response

Schema

    data

    object[]

  • Array [

  • id int64

    Uniquely identifies the resource.

    record_type string

    Identifies the type of the resource.

    active Connection Active

    Default value: true

    Specifies whether the connection can be used.

    credential_active Credential Active

    Default value: false

    If the credential associated with this service is active.

    external_sip_connection External SIP Connection

    Possible values: [zoom, operator_connect]

    Default value: zoom

    The service that will be consuming this connection.

    webhook_event_url url

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

    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_api_version string

    Possible values: [1, 2]

    Default value: 1

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

    webhook_timeout_secs integernullable

    Possible values: <= 30

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

    inbound

    object

    channel_limit integer

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

    outbound

    object

    channel_limit integer

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

    outbound_voice_profile_id int64

    Identifies the associated outbound voice profile.

    created_at string

    ISO 8601 formatted date indicating when the resource was created.

    updated_at string

    ISO 8601 formatted date indicating when the resource was updated.

  • ]

  • meta

    object

    total_pages integer
    total_results integer
    page_number integer
    page_size integer

400: Bad request

401: Unauthorized

404: Resource not found

Loading...