Exclusive numbers

List exclusive numbers

Get a collection of exclusive numbers

GEThttp://127.0.0.1:8888/api/exclusive_numbers

Response

Body

countinteger (int64)

Total number of resource.

Example: 100

itemsarray of object

Request

const response = await fetch('http://127.0.0.1:8888/api/exclusive_numbers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "count": 100,
  "items": [
    {
      "id": {},
      "number": "text",
      "created_at": {},
      "enabled": true,
      "description": "text"
    }
  ]
}

Create exclusive number

Add a new exclusive number

POSThttp://127.0.0.1:8888/api/exclusive_numbers

Body

numberstring

The telephone number.

enabledboolean

Enable the exclusive number or not.

descriptionstring

Exclusive number's description.

Response

Body

idstring

The unique ID of the resource.

Example: "NzAwNTUxOTA5NzczMTQ4MTYw"

Request

const response = await fetch('http://127.0.0.1:8888/api/exclusive_numbers', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Retrieve a exclusive number

Get details of a exclusive number

GEThttp://127.0.0.1:8888/api/exclusive_numbers/{id}

Path parameters

id*all of

The unique ID of exclusive number.

Response

Body

idall of

The unique ID of exclusive number.

numberstring

The telephone number.

created_atall of

Exclusive number created at this time.

enabledboolean

Enable the exclusive number or not.

descriptionstring

Exclusive number's description.

Request

const response = await fetch('http://127.0.0.1:8888/api/exclusive_numbers/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Update exclusive number

Update properties of a exclusive number.

POSThttp://127.0.0.1:8888/api/exclusive_numbers/{id}

Path parameters

id*all of

The unique ID of exclusive number.

Body

numberstring

The telephone number.

enabledboolean

Enable the exclusive number or not.

descriptionstring

Exclusive number's description.

Response

Request

const response = await fetch('http://127.0.0.1:8888/api/exclusive_numbers/{id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

PreviousAgents NextDestroy