{
  "opencollection": "1.0.0",
  "info": {
    "name": "Telnyx Access Tokens External Connections API",
    "version": "2.0.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "External Connections",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List all External Connections",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/external_connections",
            "params": [
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Filter parameter for external connections (deepObject style). Supports filtering by connection_name, external_sip_connection, id, created_at, and phone_number."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]"
              }
            ]
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "Creates an External Connection",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/external_connections",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "List all log messages",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/external_connections/log_messages",
            "params": [
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Filter parameter for log messages (deepObject style). Supports filtering by external_connection_id and telephone_number with eq/contains operations."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]"
              }
            ]
          },
          "docs": "Retrieve a list of log messages for all external connections associated with your account."
        },
        {
          "info": {
            "name": "Retrieve a log message",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/external_connections/log_messages/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the resource."
              }
            ]
          },
          "docs": "Retrieve a log message for an external connection associated with your account."
        },
        {
          "info": {
            "name": "Dismiss a log message",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.telnyx.com/v2/external_connections/log_messages/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the resource."
              }
            ]
          },
          "docs": "Dismiss a log message for an external connection associated with your account."
        },
        {
          "info": {
            "name": "Retrieve an External Connection",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/external_connections/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the resource."
              }
            ]
          },
          "docs": "Return the details of an existing External Connection inside the 'data' attribute of the response."
        },
        {
          "info": {
            "name": "Update an External Connection",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.telnyx.com/v2/external_connections/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the resource."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates settings of an existing External Connection based on the parameters of the request."
        },
        {
          "info": {
            "name": "Deletes an External Connection",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.telnyx.com/v2/external_connections/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the resource."
              }
            ]
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "List all civic addresses and locations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/external_connections/:id/civic_addresses",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the resource."
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Filter parameter for civic addresses (deepObject style). Supports filtering by country."
              }
            ]
          },
          "docs": "Returns the civic addresses and locations from Microsoft Teams."
        },
        {
          "info": {
            "name": "Retrieve a Civic Address",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/external_connections/:id/civic_addresses/:address_id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the resource."
              },
              {
                "name": "address_id",
                "value": "",
                "type": "path",
                "description": "Identifies a civic address or a location."
              }
            ]
          },
          "docs": "Return the details of an existing Civic Address with its Locations inside the 'data' attribute of the response."
        },
        {
          "info": {
            "name": "Update a location's static emergency address",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.telnyx.com/v2/external_connections/:id/locations/:location_id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the external connection"
              },
              {
                "name": "location_id",
                "value": "",
                "type": "path",
                "description": "The ID of the location to update"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update a location's static emergency address"
        },
        {
          "info": {
            "name": "List all phone numbers",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/external_connections/:id/phone_numbers",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the resource."
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Filter parameter for phone numbers (deepObject style). Supports filtering by phone_number, civic_address_id, and location_id with eq/contains operations."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]"
              }
            ]
          },
          "docs": "Returns a list of all active phone numbers associated with the given external connection."
        },
        {
          "info": {
            "name": "Retrieve a phone number",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/external_connections/:id/phone_numbers/:phone_number_id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the resource."
              },
              {
                "name": "phone_number_id",
                "value": "",
                "type": "path",
                "description": "A phone number's ID via the Telnyx API"
              }
            ]
          },
          "docs": "Return the details of a phone number associated with the given external connection."
        },
        {
          "info": {
            "name": "Update a phone number",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.telnyx.com/v2/external_connections/:id/phone_numbers/:phone_number_id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the resource."
              },
              {
                "name": "phone_number_id",
                "value": "",
                "type": "path",
                "description": "A phone number's ID via the Telnyx API"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Asynchronously update settings of the phone number associated with the given external connection."
        },
        {
          "info": {
            "name": "List all Releases",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/external_connections/:id/releases",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the resource."
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Filter parameter for releases (deepObject style). Supports filtering by status, civic_address_id, location_id, and phone_number with eq/contains operations."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]"
              }
            ]
          },
          "docs": "Returns a list of your Releases for the given external connection. These are automatically created when you change the `connection_id` of a phone number that is currently on Microsoft Teams."
        },
        {
          "info": {
            "name": "Retrieve a Release request",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/external_connections/:id/releases/:release_id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the resource."
              },
              {
                "name": "release_id",
                "value": "",
                "type": "path",
                "description": "Identifies a Release request"
              }
            ]
          },
          "docs": "Return the details of a Release request and its phone numbers."
        },
        {
          "info": {
            "name": "List all Upload requests",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/external_connections/:id/uploads",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the resource."
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Filter parameter for uploads (deepObject style). Supports filtering by status, civic_address_id, location_id, and phone_number with eq/contains operations."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]"
              }
            ]
          },
          "docs": "Returns a list of your Upload requests for the given external connection."
        },
        {
          "info": {
            "name": "Creates an Upload request",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/external_connections/:id/uploads",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the resource."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new Upload request to Microsoft teams with the included phone numbers. Only one of civic_address_id or location_id must be provided, not both. The maximum allowed phone numbers for the numbers_ids array is 1000."
        },
        {
          "info": {
            "name": "Refresh the status of all Upload requests",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/external_connections/:id/uploads/refresh",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the resource."
              }
            ]
          },
          "docs": "Forces a recheck of the status of all pending Upload requests for the given external connection in the background."
        },
        {
          "info": {
            "name": "Get the count of pending upload requests",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/external_connections/:id/uploads/status",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the resource."
              }
            ]
          },
          "docs": "Returns the count of all pending upload requests for the given external connection."
        },
        {
          "info": {
            "name": "Retrieve an Upload request",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/external_connections/:id/uploads/:ticket_id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the resource."
              },
              {
                "name": "ticket_id",
                "value": "",
                "type": "path",
                "description": "Identifies an Upload request"
              }
            ]
          },
          "docs": "Return the details of an Upload request and its phone numbers."
        },
        {
          "info": {
            "name": "Retry an Upload request",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/external_connections/:id/uploads/:ticket_id/retry",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the resource."
              },
              {
                "name": "ticket_id",
                "value": "",
                "type": "path",
                "description": "Identifies an Upload request"
              }
            ]
          },
          "docs": "If there were any errors during the upload process, this endpoint will retry the upload request. In some cases this will reattempt the existing upload request, in other cases it may create a new upload request. Please check the ticket_id in the response to determine if a new upload request was created."
        },
        {
          "info": {
            "name": "Refresh Operator Connect integration",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/operator_connect/actions/refresh"
          },
          "docs": "This endpoint will make an asynchronous request to refresh the Operator Connect integration with Microsoft Teams for the current user. This will create new external connections on the user's account if needed, and/or report the integration results as [log messages](https://developers.telnyx.com/api-reference/external-connections/list-all-log-messages#list-all-log-messages)."
        }
      ]
    }
  ],
  "bundled": true
}