Retrieve a Release request

GET 
/external_connections/:id/releases/:release_id

Return the details of a Release request and its phone numbers.

Path Parameters

id int64required

Identifies the resource.

release_id uuidrequired

Identifies a Release request

200: Successful response

application/json

• Schema
• Example (from schema)

Schema

data

object

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.

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

401: Unauthorized

404: Not found

Request samples

• cURL

---

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

Response samples

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