Skip to main content

List all Upload requests

GET 

/external_connections/:id/uploads

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

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, success, error]

    The status of the upload 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
    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.

  • ]

  • ]

  • meta

    object

    total_pages integer
    total_results integer
    page_number integer
    page_size integer

401: Unauthorized

404: Not found

422: Bad request

Loading...