Creates an Upload request

Creates a new Upload request to Microsoft teams with the included phone numbers. Only one of civic_address_id or location_id must be provided, not both. The maximum allowed phone numbers for the numbers_ids array is 1000.

POST /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
});

const upload = await client.externalConnections.uploads.create('1293384261075731499', {
  number_ids: [
    '3920457616934164700',
    '3920457616934164701',
    '3920457616934164702',
    '3920457616934164703',
  ],
});

console.log(upload.ticket_id);

202

{
  "success": true,
  "ticket_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

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"

Body

application/json

Parameters that can be set when creating an Upload request.

number_ids · string[] · required

Minimum array length: 1

Phone number ID from the Telnyx API.

usage · enum<string>

The use case of the upload request. NOTE: calling_user_assignment is not supported for toll free numbers.

Available options: calling_user_assignment, first_party_app_assignment

additional_usages · enum<string>[]

Additional use cases of the upload request. If not provided, all supported usages will be used.

Available options: calling_user_assignment, first_party_app_assignment

location_id · string<uuid>

Identifies the location to assign all phone numbers to.

civic_address_id · string<uuid>

Identifies the civic address to assign all phone numbers to.

Response

202

application/json

Successful response

success · boolean

Describes wether or not the operation was successful

ticket_id · string<uuid>

Ticket id of the upload request