Assignees

List provider assignees

get

Get a collection of assignees of provider.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of trunk.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

4XX

Error

get

/providers/{id}/assignees

HTTPcURLJavaScriptPython

GET /api/providers/{id}/assignees HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Check provider assignee

get

Check if a provider is assigned to the tenant.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of trunk.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

tenant_idall ofRequired

The unique ID of tenant.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

did_numbersstringOptional

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 · int32Optional

The max number of concurrent calls.

404

Not Found

get

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

HTTPcURLJavaScriptPython

GET /api/providers/{id}/assignees/{tenant_id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Assign provider

post

Assign provider to tenant.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of trunk.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

tenant_idall ofRequired

The unique ID of tenant.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

application/json

did_numbersstringOptional

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 · int32Optional

The max number of concurrent calls.

Responses

204

No Content

4XX

Error

post

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

HTTPcURLJavaScriptPython

POST /api/providers/{id}/assignees/{tenant_id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

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

No content