Update an External Connection

PATCH 
/external_connections/:id

Updates settings of an existing External Connection based on the parameters of the request.

Request

Path Parameters

id int64required

Identifies the resource.

application/json

Body

required

Parameters to be updated for the External Connection

active Connection Active (boolean)

Default value: true

Specifies whether the connection can be used.

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

Responses

200: Successful response

application/json

• Schema
• Example (from schema)

Schema

data

object

id int64

Uniquely identifies the resource.

record_type string

Identifies the type of the resource.

active Connection Active (boolean)

Default value: true

Specifies whether the connection can be used.

credential_active Credential Active (boolean)

If the credential associated with this service is active.

external_sip_connection External SIP Connection (string)

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.

{
  "data": {
    "id": "1930241863466354012",
    "record_type": "external_connection",
    "external_sip_connection": "zoom",
    "credential_active": false,
    "active": false,
    "created_at": "2022-06-29T19:23:59Z",
    "updated_at": "2022-06-29T19:39:47Z",
    "outbound": {
      "outbound_voice_profile_id": "1911630617284445511"
    }
  }
}

401: Unauthorized

404: Resource not found

422: Bad request

Loading...