Skip to main content

List all Releases

GET 
/external_connections/:id/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.

Request ​

Path Parameters

    id int64required

    Identifies the resource.

Query Parameters

    page[number] integer

    Possible values: >= 1

    Default value: 1

    The page number to load

    page[size] integer

    Possible values: >= 1 and <= 250

    Default value: 250

    The size of the page

    filter[status][eq] string[]

    Possible values: [pending_upload, pending, in_progress, complete, failed, expired, unknown]

    The status of the release to filter by

    filter[civic_address_id][eq] uuid

    The civic address ID to filter by

    filter[location_id][eq] uuid

    The location ID to filter by

    filter[phone_number][eq] E164

    The phone number to filter by

    filter[phone_number][contains] string

    The partial phone number to filter by. Requires 3-15 digits.

Responses ​

200: Successful response

Schema

    data

    object[]

  • Array [

    • ticket_id uuid

    Uniquely identifies the resource.

    tenant_id uuid
    status string

    Possible values: [pending_upload, pending, in_progress, complete, failed, expired, unknown]

    Default value: pending_upload

    Represents the status of the release on Microsoft Teams.

    error_message string

    A message set if there is an error with the upload process.

    telephone_numbers

    object[]

  • Array [

    • phone_number string

    Phone number in E164 format.

    number_id string

    Phone number ID from the Telnyx API.

  • ]

    • created_at string

    ISO 8601 formatted date indicating when the resource was created.

  • ]

    • meta

    object

    total_pages integer
    total_results integer
    page_number integer
    page_size integer

401: Unauthorized

404: Not found

422: Bad request

Request samples

curl -L 'https://api.telnyx.com/v2/external_connections/:id/releases' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

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