Skip to main content

Creates an Upload request

POST 
/external_connections/:id/uploads

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.

Request​

Path Parameters

    id int64required

    Identifies the resource.

Body

required

Parameters that can be set when creating an Upload request.

    number_ids string[]
    usage string

    Possible values: [calling_user_assignment, first_party_app_assignment]

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

    additional_usages string[]

    Possible values: [calling_user_assignment, first_party_app_assignment]

    location_id uuid

    Identifies the location to assign all phone numbers to.

    civic_address_id uuid

    Identifies the civic address to assign all phone numbers to.

Responses​

202: Successful response

Schema

    success boolean

    Describes wether or not the operation was successful

    ticket_id uuid

    Ticket id of the upload request

401: Unauthorized

404: Not found

413: Payload too large. The maximum allowed phone numbers for the numbers_ids array is 1000.

422: Unprocessable Entity

504: Gateway Timeout

Request samples

curl -L 'https://api.telnyx.com/v2/external_connections/:id/uploads' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "number_ids": [
    "3920457616934164700",
    "3920457616934164701",
    "3920457616934164702",
    "3920457616934164703"
  ],
  "usage": "first_party_app_assignment",
  "location_id": "67ea7693-9cd5-4a68-8c76-abb3aa5bf5d2"
}'

Response samples

{
  "success": true,
  "ticket_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}