Sign in

v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB
External Connections

Creates an External Connection

Creates a new External Connection based on the parameters sent in the request. The external_sip_connection and outbound voice profile id are required. Once created, you can assign phone numbers to your application using the /phone_numbers endpoint.

post/external_connections

Request body

activeboolean

Specifies whether the connection can be used.

external_sip_connection'zoom' required

The service that will be consuming this connection.

tagsstring[]

Tags associated with the connection.

webhook_event_failover_urlstring uri nullable

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_urlstring uri

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

webhook_timeout_secsinteger nullable

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

Example request

{
  "active": false,
  "external_sip_connection": "zoom",
  "outbound": {
    "outbound_voice_profile_id": "1911630617284445511"
  }
}

Response

Successful response

Example response

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