Call queue blacklisted numbers

List call queue blacklisted numbers

GEThttp://127.0.0.1:8888/api/call_queue_blacklisted_numbers

Response

2004XX

OK

Body

application/json

itemsarray of object

Request

JavaScriptCurlPython

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

Response

200

{
  "items": [
    {
      "id": {},
      "number": "text",
      "level": "FIRST",
      "longitude": "text",
      "latitude": "text",
      "address": "text",
      "created_at": {},
      "updated_at": {},
      "expire_at": {},
      "enabled": true,
      "description": "text"
    }
  ]
}

Add a call queue blacklisted number

POSThttp://127.0.0.1:8888/api/call_queue_blacklisted_numbers

Body

application/json

number*string

The blacklisted number, a string value contains a valid telephone number or extension number.

Pattern: [0-9+]{1,64}

level*enum

Blacklisted number's level:

• FIRST: A first level blacklisted number.
• SECOND: A second level blacklisted number.

FIRSTSECOND

longitudestring

Blacklisted number's longitude.

latitudestring

Blacklisted number's latitude.

addressstring

The address.

expire_atall of

Blacklisted number's expire time.

trigger_timesinteger (int32)

Blacklisted number have been triggered for this times.

enabledboolean

Enable the blacklisted number or not.

descriptionstring

Blacklisted number's description.

Response

2004XX

OK

Body

application/json

idstring

The unique ID of the resource.

Example: "NzAwNTUxOTA5NzczMTQ4MTYw"

Request

JavaScriptCurlPython

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

Response

200

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Retrieve a call queue blacklisted number

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

Path parameters

id*all of

The unique ID of blacklisted number.

Response

2004XX

OK

Body

application/json

idall of

The unique ID of blacklisted number.

numberstring

The blacklisted number, a string value contains a valid telephone number or extension number.

Pattern: [0-9+]{1,64}

levelenum

Blacklisted number's level:

• FIRST: A first level blacklisted number.
• SECOND: A second level blacklisted number.

FIRSTSECOND

longitudestring

Blacklisted number's longitude.

latitudestring

Blacklisted number's latitude.

addressstring

The address.

created_atall of

The creation time of blacklisted number.

updated_atall of

Blacklisted number's modified time.

expire_atall of

Blacklisted number's expire time.

trigger_timesinteger (int32)

Blacklisted number have been triggered for this times.

enabledboolean

Enable the blacklisted number or not.

descriptionstring

Blacklisted number's description.

Request

JavaScriptCurlPython

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

Response

200

{
  "id": {},
  "number": "text",
  "level": "FIRST",
  "longitude": "text",
  "latitude": "text",
  "address": "text",
  "created_at": {},
  "updated_at": {},
  "expire_at": {},
  "enabled": true,
  "description": "text"
}

Update a call queue blacklisted number

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

Path parameters

id*all of

The unique ID of blacklisted number.

Body

application/json

numberstring

The blacklisted number, a string value contains a valid telephone number or extension number.

Pattern: [0-9+]{1,64}

levelenum

Blacklisted number's level:

• FIRST: A first level blacklisted number.
• SECOND: A second level blacklisted number.

FIRSTSECOND

longitudestring

Blacklisted number's longitude.

latitudestring

Blacklisted number's latitude.

addressstring

The address.

expire_atall of

Blacklisted number's expire time.

trigger_timesinteger (int32)

Blacklisted number have been triggered for this times.

enabledboolean

Enable the blacklisted number or not.

descriptionstring

Blacklisted number's description.

Response

2004XX

OK

Request

JavaScriptCurlPython

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