Assignees

PreviousExport NextDestroy

Was this helpful?

List provider assignees

Get a collection of assignees of provider.

get

/providers/{id}/assignees

Authorizations

Path parameters

idall ofrequired

The unique ID of trunk.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://HOSTNAME:8887/api/providers/{id}/assignees' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

{
  "items": [
    {
      "did_numbers": "text",
      "concurrency": 1,
      "tenant_id": "NzAwNTUxOTA5NzczMTQ4MTYw"
    }
  ]
}

Check provider assignee

Check if a provider is assigned to the tenant.

get

/providers/{id}/assignees/{tenant_id}

Authorizations

Path parameters

idall ofrequired

The unique ID of trunk.

tenant_idall ofrequired

The unique ID of tenant.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://HOSTNAME:8887/api/providers/{id}/assignees/{tenant_id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

404

{
  "did_numbers": "text",
  "concurrency": 1
}

Assign provider

Assign provider to tenant.

post

/providers/{id}/assignees/{tenant_id}

Authorizations

Path parameters

idall ofrequired

The unique ID of trunk.

tenant_idall ofrequired

The unique ID of tenant.

Body

did_numbersstring

The semicolon-separated list of DID/DDI pool number range or DID/DDI number. Assign a DID/DDI pool number range or DID/DDI number to the tenant. For example: 3000;12000-18000. The DID/DDI pool number range should not overlap with other tenant DID/DDI pool number ranges and numbers.

concurrencyinteger · int32

The max number of concurrent calls.

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/providers/{id}/assignees/{tenant_id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json'

204

4XX

No body

No Content