Exclusive numbers

PreviousAgents NextDestroy

Was this helpful?

List exclusive numbers

Get a collection of exclusive numbers

get

/exclusive_numbers

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://HOSTNAME:8887/api/exclusive_numbers' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

{
  "count": 100,
  "items": [
    {
      "number": "text",
      "enabled": true,
      "description": "text",
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "created_at": "2017-07-21T17:32:28Z"
    }
  ]
}

Create exclusive number

Add a new exclusive number

post

/exclusive_numbers

Authorizations

Body

numberstring · min: 1 · max: 64

The telephone number.

enabledboolean · default: true

Enable the exclusive number or not.

descriptionstring · max: 1024

Exclusive number's description.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/exclusive_numbers' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"enabled":true}'

200

4XX

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Retrieve a exclusive number

Get details of a exclusive number

get

/exclusive_numbers/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of exclusive number.

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

4XX

{
  "number": "text",
  "enabled": true,
  "description": "text",
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "created_at": "2017-07-21T17:32:28Z"
}

Update exclusive number

Update properties of a exclusive number.

post

/exclusive_numbers/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of exclusive number.

Body

numberstring · min: 1 · max: 64

The telephone number.

enabledboolean · default: true

Enable the exclusive number or not.

descriptionstring · max: 1024

Exclusive number's description.

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/exclusive_numbers/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"enabled":true}'

200

4XX

No body