Retrieve an Upload request

GET 
/external_connections/:id/uploads/:ticket_id

Return the details of an Upload request and its phone numbers.

Path Parameters

id int64required

Identifies the resource.

ticket_id uuidrequired

Identifies an Upload request

200: Successful response

application/json

• Schema
• Example (from schema)

Schema

data

object

ticket_id uuid

Uniquely identifies the resource.

tenant_id uuid

location_id uuid

status string

Possible values: [pending_upload, pending, in_progress, partial_success, success, error]

Default value: pending_upload

Represents the status of the upload on Microsoft Teams.

available_usages string[]

Possible values: [calling_user_assignment, first_party_app_assignment]

error_code string

A code returned by Microsoft Teams if there is an error with the upload process.

error_message string

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

tn_upload_entries

object[]

Array [

number_id uuid

Uniquely identifies the resource.

phone_number string

Phone number in E164 format.

status string

Possible values: [pending_upload, pending, in_progress, success, error]

Default value: pending_upload

Represents the status of the phone number entry upload on Microsoft Teams.

error_code string

Possible values: [internal_error, unable_to_retrieve_default_location, unknown_country_code, unable_to_retrieve_location, unable_to_retrieve_partner_info, unable_to_match_geography_entry]

A code returned by Microsoft Teams if there is an error with the phone number entry upload.

error_message string

A message returned by Microsoft Teams if there is an error with the upload process.

civic_address_id uuid

Identifies the civic address assigned to the phone number entry.

location_id uuid

Identifies the location assigned to the phone number entry.

internal_status string

Possible values: [pending_assignment, in_progress, all_internal_jobs_completed, release_requested, release_completed, error]

Default value: pending_assignment

Represents the status of the phone number entry upload on Telnyx.

]

{
  "data": {
    "ticket_id": "542c3bca-d247-42bc-8fe7-e01d16ecd761",
    "tenant_id": "ea175aba-f47c-4702-9400-efaa42688048",
    "location_id": "c37e5036-1e87-42e6-86a2-b3e8dd39a2ad",
    "status": "error",
    "available_usages": [
      "calling_user_assignment"
    ],
    "error_code": "string",
    "error_message": "string",
    "tn_upload_entries": [
      {
        "number_id": "542c3bca-d247-42bc-8fe7-e01d16ecd761",
        "phone_number": "string",
        "status": "error",
        "error_code": "internal_error",
        "error_message": "string",
        "civic_address_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "location_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "internal_status": "error"
      }
    ]
  }
}

401: Unauthorized

404: Not found

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/v2/external_connections/:id/uploads/:ticket_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",
    "location_id": "c37e5036-1e87-42e6-86a2-b3e8dd39a2ad",
    "status": "error",
    "available_usages": [
      "calling_user_assignment"
    ],
    "error_code": "string",
    "error_message": "string",
    "tn_upload_entries": [
      {
        "number_id": "542c3bca-d247-42bc-8fe7-e01d16ecd761",
        "phone_number": "string",
        "status": "error",
        "error_code": "internal_error",
        "error_message": "string",
        "civic_address_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "location_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "internal_status": "error"
      }
    ]
  }
}