List all Upload requests

Returns a list of your Upload requests for the given external connection.

GET /external_connections/{id}/uploads

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 upload of client.externalConnections.uploads.list('1293384261075731499')) {
  console.log(upload.location_id);
}

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": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "internal_status": "error"
        }
      ]
    }
  ],
  "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 uploads (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 · Upload · object[]

Show child attributes

meta · Pagination Meta · object

Show child attributes