List all Releases

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.

GET /external_connections/{id}/releases

JavaScript

JavaScript

import Telnyx from 'telnyx';

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

// Automatically fetches more pages as needed.
for await (const releaseListResponse of client.externalConnections.releases.list(
  '1293384261075731499',
)) {
  console.log(releaseListResponse.tenant_id);
}

200

{
  "data": [
    {
      "ticket_id": "542c3bca-d247-42bc-8fe7-e01d16ecd761",
      "tenant_id": "ea175aba-f47c-4702-9400-efaa42688048",
      "status": "pending",
      "error_message": "<string>",
      "telephone_numbers": [
        {
          "phone_number": "<string>",
          "number_id": "<string>"
        }
      ],
      "created_at": "2018-02-02T22:25:27.521Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

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"

Query Parameters

filter · object

Filter parameter for releases (deepObject style). Supports filtering by status, civic_address_id, location_id, and phone_number with eq/contains operations.

Show child attributes

page · object

Consolidated page parameter (deepObject style). Originally: page[size], page[number]

Show child attributes

Response

200

application/json

Successful response

data · Phone Number Release · object[]

Show child attributes

meta · Pagination Meta · object

Show child attributes