Deletes an External Connection

Permanently deletes an External Connection. Deletion may be prevented if the application is in use by phone numbers, is active, or if it is an Operator Connect connection. To remove an Operator Connect integration please contact Telnyx support.

DELETE /external_connections/{id}

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const externalConnection = await client.externalConnections.delete('1293384261075731499');

console.log(externalConnection.data);

200

{
  "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"
    }
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

Identifies the resource.

Example:

"1293384261075731499"

Response

200

application/json

Successful response

data · External Connection · object

Show child attributes

Example:

{
  "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"
  }
}