CTI | PortSIP Knowledge Base

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": 1,
  "items": [
    {
      "id": null,
      "number": null,
      "created_at": null,
      "enabled": null,
      "description": null
    }
  ]
}

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: 49

{
  "number": null,
  "enabled": null,
  "description": null
}

{
  "id": "xxxxxxxx"
}

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": null,
  "number": null,
  "created_at": null,
  "enabled": null,
  "description": null
}

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: 49

{
  "number": null,
  "enabled": null,
  "description": null
}

No content

Delete exclusive number

post

Destroy a exclusive number by it's unique ID.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

4XX

Error

post

/exclusive_numbers/{id}/destroy

POST /api/exclusive_numbers/{id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List call queues of exclusive number

get

Get a collection of call queues where exclusive number is located.

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

4XX

Error

get

/exclusive_numbers/{id}/call_queues

GET /api/exclusive_numbers/{id}/call_queues HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": null,
      "name": null,
      "extension_number": null
    }
  ]
}

List agents in call queue for exclusive number

get

Get a collection of agent extension numbers in call queue for exclusive number.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

queue_idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

4XX

Error

get

/exclusive_numbers/{id}/call_queues/{queue_id}/agents

GET /api/exclusive_numbers/{id}/call_queues/{queue_id}/agents HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": null,
      "name": null,
      "display_name": null,
      "extension_number": null
    }
  ]
}

Set agents for exclusive number

post

Set agents for exclusive number.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

queue_idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

itemsstring[]Optional

A collection of call queue agent extension numbers.

Responses

200

OK

No content

4XX

Error

post

/exclusive_numbers/{id}/call_queues/{queue_id}/agents

POST /api/exclusive_numbers/{id}/call_queues/{queue_id}/agents HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "items": [
    "101",
    "102"
  ]
}

No content

Remove all agents of call queue for exclusive number

post

Remove all agents of call queue for exclusive number.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

queue_idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

4XX

Error

post

/exclusive_numbers/{id}/call_queues/{queue_id}/destroy

POST /api/exclusive_numbers/{id}/call_queues/{queue_id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Export exclusive numbers

get

Export a collection of number blacklists to file.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/octet-stream

Responsestring · binary

4XX

Error

get

/exclusive_numbers/export

GET /api/exclusive_numbers/export HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary

List VIP numbers

get

Get a collection of VIP 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

/vip_numbers

GET /api/vip_numbers HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 1,
  "items": [
    {
      "id": null,
      "number": null,
      "longitude": null,
      "latitude": null,
      "address": null,
      "created_at": null,
      "updated_at": null,
      "expire_at": null,
      "enabled": null,
      "description": null
    }
  ]
}

Add VIP number

post

Create a new VIP number.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

numberstring · min: 1 · max: 64Optional

The VIP number, a string value contains a valid telephone number.

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

longitudestringOptional

VIP number's longitude.

latitudestringOptional

VIP number's latitude.

addressstring · max: 128Optional

The address.

expire_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 VIP number or not.

descriptionstring · max: 1024Optional

VIP number's description.

Responses

200

OK

application/json

idstringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

4XX

Error

post

/vip_numbers

POST /api/vip_numbers HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 114

{
  "number": null,
  "longitude": null,
  "latitude": null,
  "address": null,
  "expire_at": null,
  "enabled": null,
  "description": null
}

{
  "id": "xxxxxxxx"
}

Retrieve VIP number

get

Get details of the VIP 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 VIP number, a string value contains a valid telephone number.

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

longitudestringOptional

VIP number's longitude.

latitudestringOptional

VIP number's latitude.

addressstring · max: 128Optional

The address.

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

updated_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

expire_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 VIP number or not.

descriptionstring · max: 1024Optional

VIP number's description.

4XX

Error

get

/vip_numbers/{id}

GET /api/vip_numbers/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": null,
  "number": null,
  "longitude": null,
  "latitude": null,
  "address": null,
  "created_at": null,
  "updated_at": null,
  "expire_at": null,
  "enabled": null,
  "description": null
}

Update VIP number

post

Update a VIP 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 VIP number, a string value contains a valid telephone number.

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

longitudestringOptional

VIP number's longitude.

latitudestringOptional

VIP number's latitude.

addressstring · max: 128Optional

The address.

expire_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 VIP number or not.

descriptionstring · max: 1024Optional

VIP number's description.

Responses

200

OK

No content

4XX

Error

post

/vip_numbers/{id}

POST /api/vip_numbers/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 114

{
  "number": null,
  "longitude": null,
  "latitude": null,
  "address": null,
  "expire_at": null,
  "enabled": null,
  "description": null
}

No content

Delete VIP number

post

Destroy a VIP number by it's unique ID.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

4XX

Error

post

/vip_numbers/{id}/destroy

POST /api/vip_numbers/{id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Export VIP numbers

get

Export a collection of VIP numbers to file.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/octet-stream

Responsestring · binary

4XX

Error

get

/vip_numbers/export

GET /api/vip_numbers/export HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary

List call queue blacklisted numbers

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

get

/call_queue_blacklisted_numbers

GET /api/call_queue_blacklisted_numbers HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": null,
      "number": null,
      "level": null,
      "longitude": null,
      "latitude": null,
      "address": null,
      "created_at": null,
      "updated_at": null,
      "expire_at": null,
      "trigger_times": null,
      "enabled": null,
      "description": null
    }
  ]
}

Add a call queue blacklisted number

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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}

levelstring · enumRequired

Blacklisted number's level:

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

Possible values:

longitudestringOptional

Blacklisted number's longitude.

latitudestringOptional

Blacklisted number's latitude.

addressstring · max: 128Optional

The address.

expire_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

trigger_timesinteger · int32Optional

Blacklisted number have been triggered for this times.

enabledbooleanOptional

Enable the blacklisted number or not.

Default: true

descriptionstring · max: 1024Optional

Blacklisted number's description.

Responses

200

OK

application/json

idstringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

4XX

Error

post

/call_queue_blacklisted_numbers

POST /api/call_queue_blacklisted_numbers HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 148

{
  "number": null,
  "level": null,
  "longitude": null,
  "latitude": null,
  "address": null,
  "expire_at": null,
  "trigger_times": null,
  "enabled": null,
  "description": null
}

{
  "id": "xxxxxxxx"
}

Retrieve a call queue blacklisted number

get

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 blacklisted number, a string value contains a valid telephone number or extension number.

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

levelstring · enumOptional

Blacklisted number's level:

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

Possible values:

longitudestringOptional

Blacklisted number's longitude.

latitudestringOptional

Blacklisted number's latitude.

addressstring · max: 128Optional

The address.

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

updated_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

expire_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

trigger_timesinteger · int32Optional

Blacklisted number have been triggered for this times.

enabledbooleanOptional

Enable the blacklisted number or not.

Default: true

descriptionstring · max: 1024Optional

Blacklisted number's description.

4XX

Error

get

/call_queue_blacklisted_numbers/{id}

GET /api/call_queue_blacklisted_numbers/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": null,
  "number": null,
  "level": null,
  "longitude": null,
  "latitude": null,
  "address": null,
  "created_at": null,
  "updated_at": null,
  "expire_at": null,
  "trigger_times": null,
  "enabled": null,
  "description": null
}

Update a call queue blacklisted number

post

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 blacklisted number, a string value contains a valid telephone number or extension number.

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

levelstring · enumOptional

Blacklisted number's level:

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

Possible values:

longitudestringOptional

Blacklisted number's longitude.

latitudestringOptional

Blacklisted number's latitude.

addressstring · max: 128Optional

The address.

expire_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

trigger_timesinteger · int32Optional

Blacklisted number have been triggered for this times.

enabledbooleanOptional

Enable the blacklisted number or not.

Default: true

descriptionstring · max: 1024Optional

Blacklisted number's description.

Responses

200

OK

No content

4XX

Error

post

/call_queue_blacklisted_numbers/{id}

POST /api/call_queue_blacklisted_numbers/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 148

{
  "number": null,
  "level": null,
  "longitude": null,
  "latitude": null,
  "address": null,
  "expire_at": null,
  "trigger_times": null,
  "enabled": null,
  "description": null
}

No content

Delete a call queue blacklisted number

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

400

Invalid item ID

404

User not found

post

/call_queue_blacklisted_numbers/{id}/destroy

POST /api/call_queue_blacklisted_numbers/{id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Export queue blacklisted numbers

get

Export a collection of queue blacklisted numbers to file.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/octet-stream

Responsestring · binary

4XX

Error

get

/call_queue_blacklisted_numbers/export

GET /api/call_queue_blacklisted_numbers/export HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary

Retrieve call queue blacklist prompts configurations

get

Retrieve call queue blacklist prompts configurations.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

enable_level1booleanOptional

Whether to enable the the level 1 blacklist.

Default: false

level1_prompt_file_namestringOptional

The name of the file.

level1_prompt_file_sizeinteger · int64Optional

The file size in bytes.

Example: 0

level1_prompt_file_urlstringRead-onlyOptional

The relative path to file url for file downloading.

Example: /api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK

enable_level2booleanOptional

Whether to enable the the level 2 blacklist.

Default: false

level2_prompt_file_namestringOptional

The name of the file.

level2_prompt_file_sizeinteger · int64Optional

The file size in bytes.

Example: 0

level2_prompt_file_urlstringRead-onlyOptional

The relative path to file url for file downloading.

Example: /api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK

4XX

Error

get

/call_queue_blacklist_prompts

GET /api/call_queue_blacklist_prompts HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "enable_level1": null,
  "level1_prompt_file_name": null,
  "level1_prompt_file_size": null,
  "level1_prompt_file_url": null,
  "enable_level2": null,
  "level2_prompt_file_name": null,
  "level2_prompt_file_size": null,
  "level2_prompt_file_url": null
}

Update call queue blacklist prompts configurations

post

Update call queue blacklist prompts configurations.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

enable_level1booleanOptional

Whether to enable the the level 1 blacklist.

Default: false

level1_prompt_file_idstringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

enable_level2booleanOptional

Whether to enable the the level 2 blacklist.

Default: false

level2_prompt_file_idstringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

No content

4XX

Error

post

/call_queue_blacklist_prompts

POST /api/call_queue_blacklist_prompts HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 101

{
  "enable_level1": null,
  "level1_prompt_file_id": null,
  "enable_level2": null,
  "level2_prompt_file_id": null
}

No content

Retrieve monitor server

get

Retrieve monitor server information.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

enabledbooleanOptional

Enable monitor server or not.

extension_numberstring · min: 3 · max: 64Optional

The extension number.

Pattern: [0-9]{3,64}

4XX

Error

get

/monitor

GET /api/monitor HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "enabled": null,
  "extension_number": null
}

Update monitor server

post

Update monitor server

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

enabledbooleanOptional

Enable monitor server or not.

extension_numberstring · min: 3 · max: 64Optional

The extension number.

Pattern: [0-9]{3,64}

Responses

200

OK

No content

4XX

Error

post

/monitor

POST /api/monitor HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "enabled": null,
  "extension_number": null
}

No content

List monitor groups

get

List monitor groups

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

filterstringOptional

Use the filter query parameter to retrieve just a subset of a collection.

searchstringOptional

Use the search query parameter to restrict the results of a request to match a search criterion.

orderbystringOptional

Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.

skipinteger · int32Optional

Use the skip query parameter to set the number of items to skip at the start of a collection.

Default: 0

topinteger · int32 · min: 1 · max: 100Optional

Use the top query parameter to specify the page size of the result set.

Default: 100

Responses

200

OK

application/json

countinteger · int64Optional

Total number of resource.

Example: 100

4XX

Error

get

/monitor_groups

GET /api/monitor_groups HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 1,
  "items": [
    {
      "id": null,
      "name": null,
      "enabled": null,
      "description": null
    }
  ]
}

Create a monitor group

post

Create a new monitor group.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

namestring · min: 1 · max: 64Optional

Name of monitor group

enabledbooleanOptional

Enable monitor group or not.

descriptionstring · max: 1024Optional

Description for monitor group

Responses

201

Created monitor group

application/json

4XX

Error

post

/monitor_groups

POST /api/monitor_groups HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "name": null,
  "enabled": null,
  "description": null
}

{
  "id": "xxxxxxxx"
}

Retrieve a monitor group

get

Retrieves details of a monitor group.

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

namestring · min: 1 · max: 64Optional

Name of monitor group

enabledbooleanOptional

Enable monitor group or not.

descriptionstring · max: 1024Optional

Description for monitor group

4XX

Error

get

/monitor_groups/{id}

GET /api/monitor_groups/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": null,
  "name": null,
  "enabled": null,
  "description": null
}

Update an monitor group.

post

Update an monitor group

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

namestring · min: 1 · max: 64Optional

Name of monitor group

enabledbooleanOptional

Enable monitor group or not.

descriptionstring · max: 1024Optional

Description for monitor group

Responses

200

OK

No content

4XX

Error

post

/monitor_groups/{id}

POST /api/monitor_groups/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "name": null,
  "enabled": null,
  "description": null
}

No content

Delete an monitor group

post

Delete a monitor group.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

4XX

Error

post

/monitor_groups/{id}/destroy

POST /api/monitor_groups/{id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List monitor group members

get

Retrieve a collection of monitor group members.

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

4XX

Error

get

/monitor_groups/{id}/members

GET /api/monitor_groups/{id}/members HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": null,
      "name": null,
      "display_name": null,
      "extension_number": null
    }
  ]
}

Add monitor group member

post

Add user member into monitor group.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

extension_numberstring · min: 3 · max: 64Required

The extension number.

Pattern: [0-9]{3,64}

Responses

200

OK

No content

4XX

Error

post

/monitor_groups/{id}/members/{extension_number}

POST /api/monitor_groups/{id}/members/{extension_number} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Delete monitor group member

post

Delete an monitor group member.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

extension_numberstring · min: 3 · max: 64Required

The extension number.

Pattern: [0-9]{3,64}

Responses

204

No Content

4XX

Error

post

/monitor_groups/{id}/members/{extension_number}/destroy

POST /api/monitor_groups/{id}/members/{extension_number}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List monitor group manager

get

Retrieve a collection of monitor group managers.

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

4XX

Error

get

/monitor_groups/{id}/managers

GET /api/monitor_groups/{id}/managers HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": null,
      "name": null,
      "display_name": null,
      "extension_number": null
    }
  ]
}

Add monitor group manager

post

Add user into monitor group manager list.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

extension_numberstring · min: 3 · max: 64Required

The extension number.

Pattern: [0-9]{3,64}

Responses

200

OK

No content

4XX

Error

post

/monitor_groups/{id}/managers/{extension_number}

POST /api/monitor_groups/{id}/managers/{extension_number} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Delete monitor group manager

post

Delete an manager from monitor group manager list.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

extension_numberstring · min: 3 · max: 64Required

The extension number.

Pattern: [0-9]{3,64}

Responses

204

No Content

4XX

Error

post

/monitor_groups/{id}/managers/{extension_number}/destroy

POST /api/monitor_groups/{id}/managers/{extension_number}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

hashtagList exclusive numbers

hashtagCreate exclusive number

hashtagRetrieve a exclusive number

hashtagUpdate exclusive number

hashtagDelete exclusive number

hashtagList call queues of exclusive number

hashtagList agents in call queue for exclusive number

hashtagSet agents for exclusive number

hashtagRemove all agents of call queue for exclusive number

hashtagExport exclusive numbers

hashtagList VIP numbers

hashtagAdd VIP number

hashtagRetrieve VIP number

hashtagUpdate VIP number

hashtagDelete VIP number

hashtagExport VIP numbers

hashtagList call queue blacklisted numbers

hashtagAdd a call queue blacklisted number

hashtagRetrieve a call queue blacklisted number

hashtagUpdate a call queue blacklisted number

hashtagDelete a call queue blacklisted number

hashtagExport queue blacklisted numbers

hashtagRetrieve call queue blacklist prompts configurations

hashtagUpdate call queue blacklist prompts configurations

hashtagRetrieve monitor server

hashtagUpdate monitor server

hashtagList monitor groups

hashtagCreate a monitor group

hashtagRetrieve a monitor group

hashtagUpdate an monitor group.

hashtagDelete an monitor group

hashtagList monitor group members

hashtagAdd monitor group member

hashtagDelete monitor group member

hashtagList monitor group manager

hashtagAdd monitor group manager

hashtagDelete monitor group manager

List exclusive numbers

Create exclusive number

Retrieve a exclusive number

Update exclusive number

Delete exclusive number

List call queues of exclusive number

List agents in call queue for exclusive number

Set agents for exclusive number

Remove all agents of call queue for exclusive number

Export exclusive numbers

List VIP numbers

Add VIP number

Retrieve VIP number

Update VIP number

Delete VIP number

Export VIP numbers

List call queue blacklisted numbers

Add a call queue blacklisted number

Retrieve a call queue blacklisted number

Update a call queue blacklisted number

Delete a call queue blacklisted number

Export queue blacklisted numbers

Retrieve call queue blacklist prompts configurations

Update call queue blacklist prompts configurations

Retrieve monitor server

Update monitor server

List monitor groups

Create a monitor group

Retrieve a monitor group

Update an monitor group.

Delete an monitor group

List monitor group members

Add monitor group member

Delete monitor group member

List monitor group manager

Add monitor group manager

Delete monitor group manager