Exclusive numbers

List exclusive numbers

get

Get a collection of exclusive numbers

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

countinteger · int64Optional

Total number of resource.

Example: 100

4XX

Error

get/exclusive_numbers

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

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

idstringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

4XX

Error

post/exclusive_numbers

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

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

idstringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

numberstring · min: 1 · max: 64Optional

The telephone number.

created_atstring · date_timeOptional

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Example: 2017-07-21T17:32:28Z

enabledbooleanOptional

Enable the exclusive number or not.

Default: true

descriptionstring · max: 1024Optional

Exclusive number's description.

4XX

Error

get/exclusive_numbers/{id}

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

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

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

No content

4XX

Error

post/exclusive_numbers/{id}

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