Exclusive numbers

List exclusive numbers

get

Get a collection of exclusive numbers

Authorizations
Responses
200
OK
application/json
get
GET /api/exclusive_numbers HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Create exclusive number

post

Add a new exclusive number

Authorizations
Body
numberstring · min: 1 · max: 64Optional

The telephone number.

enabledbooleanOptional

Enable the exclusive number or not.

Default: true
descriptionstring · max: 1024Optional

Exclusive number's description.

Responses
200
OK
application/json
post
POST /api/exclusive_numbers HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "number": "text",
  "enabled": true,
  "description": "text"
}
{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Retrieve a exclusive number

get

Get details of a exclusive number

Authorizations
Path parameters
idall ofRequired

The unique ID of exclusive number.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200
OK
application/json
get
GET /api/exclusive_numbers/{id} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Update exclusive number

post

Update properties of a exclusive number.

Authorizations
Path parameters
idall ofRequired

The unique ID of exclusive number.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Body
numberstring · min: 1 · max: 64Optional

The telephone number.

enabledbooleanOptional

Enable the exclusive number or not.

Default: true
descriptionstring · max: 1024Optional

Exclusive number's description.

Responses
200
OK
post
POST /api/exclusive_numbers/{id} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "number": "text",
  "enabled": true,
  "description": "text"
}
No content
PreviousAgentsNextDestroy