Call queue blacklisted numbers

PreviousExport NextDestroy

Was this helpful?

List call queue blacklisted numbers

get

/call_queue_blacklisted_numbers

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

4XX

{
  "items": [
    {
      "number": "text",
      "longitude": "text",
      "latitude": "text",
      "address": "text",
      "trigger_times": 1,
      "enabled": true,
      "description": "text",
      "level": "FIRST",
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "created_at": "2017-07-21T17:32:28Z",
      "updated_at": "2017-07-21T17:32:28Z",
      "expire_at": "2017-07-21T17:32:28Z"
    }
  ]
}

Add a call queue blacklisted number

post

/call_queue_blacklisted_numbers

Authorizations

Body

numberstring · min: 1 · max: 64required

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

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

longitudestring

Blacklisted number's longitude.

latitudestring

Blacklisted number's latitude.

addressstring · max: 128

The address.

trigger_timesinteger · int32

Blacklisted number have been triggered for this times.

enabledboolean · default: true

Enable the blacklisted number or not.

descriptionstring · max: 1024

Blacklisted number's description.

levelstring · enumrequired

Blacklisted number's level:

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

Options: FIRST, SECOND

expire_atall of

Blacklisted number's expire time.

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/call_queue_blacklisted_numbers' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "number": "text",
    "longitude": "text",
    "latitude": "text",
    "address": "text",
    "trigger_times": 1,
    "enabled": true,
    "description": "text",
    "level": "FIRST",
    "expire_at": "2017-07-21T17:32:28Z"
  }'

200

4XX

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Retrieve a call queue blacklisted number

get

/call_queue_blacklisted_numbers/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of blacklisted number.

The unique ID of the resource.

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

4XX

{
  "number": "text",
  "longitude": "text",
  "latitude": "text",
  "address": "text",
  "trigger_times": 1,
  "enabled": true,
  "description": "text",
  "level": "FIRST",
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "created_at": "2017-07-21T17:32:28Z",
  "updated_at": "2017-07-21T17:32:28Z",
  "expire_at": "2017-07-21T17:32:28Z"
}

Update a call queue blacklisted number

post

/call_queue_blacklisted_numbers/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of blacklisted number.

The unique ID of the resource.

Body

numberstring · min: 1 · max: 64

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

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

longitudestring

Blacklisted number's longitude.

latitudestring

Blacklisted number's latitude.

addressstring · max: 128

The address.

trigger_timesinteger · int32

Blacklisted number have been triggered for this times.

enabledboolean · default: true

Enable the blacklisted number or not.

descriptionstring · max: 1024

Blacklisted number's description.

levelstring · enum

Blacklisted number's level:

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

Options: FIRST, SECOND

expire_atall of

Blacklisted number's expire time.

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

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/call_queue_blacklisted_numbers/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "number": "text",
    "longitude": "text",
    "latitude": "text",
    "address": "text",
    "trigger_times": 1,
    "enabled": true,
    "description": "text",
    "level": "FIRST",
    "expire_at": "2017-07-21T17:32:28Z"
  }'

200

4XX

No body