Skip to main content

Retrieve an External Connection

GET 

/external_connections/:id

Return the details of an existing External Connection inside the 'data' attribute of the response.

Request

Path Parameters

    id int64required

    Identifies the resource.

Responses

200: Successful response

Schema

    data

    object

    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.

401: Unauthorized

404: Resource not found

422: Bad request

Loading...