import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: 'My API Key',
});
const upload = await client.externalConnections.uploads.retrieve('7b6a6449-b055-45a6-81f6-f6f0dffa4cc6', {
id: 'id',
});
console.log(upload.data);{
"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"
}
]
}
}Return the details of an Upload request and its phone numbers.
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: 'My API Key',
});
const upload = await client.externalConnections.uploads.retrieve('7b6a6449-b055-45a6-81f6-f6f0dffa4cc6', {
id: 'id',
});
console.log(upload.data);{
"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"
}
]
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Identifies the resource.
"1293384261075731499"
Identifies an Upload request
"7b6a6449-b055-45a6-81f6-f6f0dffa4cc6"
Successful response
Show child attributes
Uniquely identifies the resource.
"542c3bca-d247-42bc-8fe7-e01d16ecd761"
"ea175aba-f47c-4702-9400-efaa42688048"
"c37e5036-1e87-42e6-86a2-b3e8dd39a2ad"
Represents the status of the upload on Microsoft Teams.
pending_upload, pending, in_progress, partial_success, success, error "error"
Available usages for the numbers in the upload on Microsoft Teams.
calling_user_assignment, first_party_app_assignment A code returned by Microsoft Teams if there is an error with the upload process.
A message set if there is an error with the upload process.
Show child attributes
Uniquely identifies the resource.
"542c3bca-d247-42bc-8fe7-e01d16ecd761"
Phone number in E164 format.
Represents the status of the phone number entry upload on Microsoft Teams.
pending_upload, pending, in_progress, success, error "error"
A code returned by Microsoft Teams if there is an error with the phone number entry upload.
internal_error, unable_to_retrieve_default_location, unknown_country_code, unable_to_retrieve_location, unable_to_retrieve_partner_info, unable_to_match_geography_entry "internal_error"
A message returned by Microsoft Teams if there is an error with the upload process.
Identifies the civic address assigned to the phone number entry.
Identifies the location assigned to the phone number entry.
Represents the status of the phone number entry upload on Telnyx.
pending_assignment, in_progress, all_internal_jobs_completed, release_requested, release_completed, error "error"
Was this page helpful?