Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

CTI

Manage CTI functions.

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
get/exclusive_numbers
GET /api/exclusive_numbers HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 1,
  "items": [
    {
      "id": "xxxxxx",
      "number": "000000",
      "created_at": "2020-01-01T00:00:00Z",
      "enabled": true,
      "description": ""
    }
  ]
}

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
idstringOptionalExample: NzAwNTUxOTA5NzczMTQ4MTYw
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: 51

{
  "number": "000000",
  "enabled": true,
  "description": ""
}
{
  "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
idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200

OK

application/json
idstringOptionalExample: 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.

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

{
  "id": "xxxxxx",
  "number": "000000",
  "created_at": "2020-01-01T00:00:00Z",
  "enabled": true,
  "description": ""
}

Update exclusive number

post

Update properties of a exclusive number.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequiredExample: 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
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: 51

{
  "number": "000000",
  "enabled": true,
  "description": ""
}
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
idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
204

No Content

No content
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
idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200

OK

application/json
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": "xxxxxx",
      "name": "example",
      "extension_number": "101"
    }
  ]
}

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
idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw
queue_idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200

OK

application/json
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": "xxxxxx",
      "name": "example",
      "display_name": "example",
      "extension_number": "101"
    }
  ]
}

Set agents for exclusive number

post

Set agents for exclusive number.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw
queue_idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw
Body
itemsstring[]Optional

A collection of call queue agent extension numbers.

Responses
200

OK

No content
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
idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw
queue_idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
204

No Content

No content
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
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
get/vip_numbers
GET /api/vip_numbers HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 1,
  "items": [
    {
      "id": "xxxxxx",
      "number": "000000",
      "longitude": "",
      "latitude": "",
      "address": "",
      "created_at": "2020-01-01T00:00:00Z",
      "updated_at": "2020-01-01T00:00:00Z",
      "expire_at": "2020-01-01T00:00:00Z",
      "enabled": true,
      "description": ""
    }
  ]
}

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
idstringOptionalExample: NzAwNTUxOTA5NzczMTQ4MTYw
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: 128

{
  "number": "000000",
  "longitude": "",
  "latitude": "",
  "address": "",
  "expire_at": "2020-01-01T00:00:00Z",
  "enabled": true,
  "description": ""
}
{
  "id": "xxxxxxxx"
}

Retrieve VIP number

get

Get details of the VIP number.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200

OK

application/json
idstringOptionalExample: 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.

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

{
  "id": "xxxxxx",
  "number": "000000",
  "longitude": "",
  "latitude": "",
  "address": "",
  "created_at": "2020-01-01T00:00:00Z",
  "updated_at": "2020-01-01T00:00:00Z",
  "expire_at": "2020-01-01T00:00:00Z",
  "enabled": true,
  "description": ""
}

Update VIP number

post

Update a VIP number.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequiredExample: 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
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: 128

{
  "number": "000000",
  "longitude": "",
  "latitude": "",
  "address": "",
  "expire_at": "2020-01-01T00:00:00Z",
  "enabled": true,
  "description": ""
}
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
idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
204

No Content

No content
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
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
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": "xxxxxx",
      "number": "000000",
      "level": "FIRST",
      "longitude": "",
      "latitude": "",
      "address": "",
      "created_at": "2020-01-01T00:00:00Z",
      "updated_at": "2020-01-01T00:00:00Z",
      "expire_at": "2020-01-01T00:00:00Z",
      "trigger_times": 1,
      "enabled": true,
      "description": ""
    }
  ]
}

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
idstringOptionalExample: NzAwNTUxOTA5NzczMTQ4MTYw
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: 162

{
  "number": "000000",
  "level": "FIRST",
  "longitude": "",
  "latitude": "",
  "address": "",
  "expire_at": "2020-01-01T00:00:00Z",
  "trigger_times": 1,
  "enabled": true,
  "description": ""
}
{
  "id": "xxxxxxxx"
}

Retrieve a call queue blacklisted number

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200

OK

application/json
idstringOptionalExample: 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.

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": "xxxxxx",
  "number": "000000",
  "level": "FIRST",
  "longitude": "",
  "latitude": "",
  "address": "",
  "created_at": "2020-01-01T00:00:00Z",
  "updated_at": "2020-01-01T00:00:00Z",
  "expire_at": "2020-01-01T00:00:00Z",
  "trigger_times": 1,
  "enabled": true,
  "description": ""
}

Update a call queue blacklisted number

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequiredExample: 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
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: 162

{
  "number": "000000",
  "level": "FIRST",
  "longitude": "",
  "latitude": "",
  "address": "",
  "expire_at": "2020-01-01T00:00:00Z",
  "trigger_times": 1,
  "enabled": true,
  "description": ""
}
No content

Delete a call queue blacklisted number

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
204

No Content

No content
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
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
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": true,
  "level1_prompt_file_name": "example",
  "level1_prompt_file_size": 100,
  "level1_prompt_file_url": "",
  "enable_level2": true,
  "level2_prompt_file_name": "example",
  "level2_prompt_file_size": 100,
  "level2_prompt_file_url": ""
}

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_idstringOptionalExample: NzAwNTUxOTA5NzczMTQ4MTYw
enable_level2booleanOptional

Whether to enable the the level 2 blacklist.

Default: false
level2_prompt_file_idstringOptionalExample: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200

OK

No content
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: 109

{
  "enable_level1": true,
  "level1_prompt_file_id": "xxxxxx",
  "enable_level2": true,
  "level2_prompt_file_id": "xxxxxx"
}
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}
get/monitor
GET /api/monitor HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "enabled": true,
  "extension_number": "101"
}

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
post/monitor
POST /api/monitor HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "enabled": true,
  "extension_number": "101"
}
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
get/monitor_groups
GET /api/monitor_groups HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 1,
  "items": [
    {
      "id": "xxxxxx",
      "name": "example",
      "enabled": true,
      "description": ""
    }
  ]
}

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
idstringOptionalExample: NzAwNTUxOTA5NzczMTQ4MTYw
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: 50

{
  "name": "example",
  "enabled": true,
  "description": ""
}
{
  "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
idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200

OK

application/json
idstringOptionalExample: NzAwNTUxOTA5NzczMTQ4MTYw
namestring · min: 1 · max: 64Optional

Name of monitor group

enabledbooleanOptional

Enable monitor group or not.

descriptionstring · max: 1024Optional

Description for monitor group

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

{
  "id": "xxxxxx",
  "name": "example",
  "enabled": true,
  "description": ""
}

Update an monitor group.

post

Update an monitor group

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequiredExample: 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
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: 50

{
  "name": "example",
  "enabled": true,
  "description": ""
}
No content

Delete an monitor group

post

Delete a monitor group.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
204

No Content

No content
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
idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200

OK

application/json
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": "xxxxxx",
      "name": "example",
      "display_name": "example",
      "extension_number": "101"
    }
  ]
}

Add monitor group member

post

Add user member into monitor group.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw
extension_numberstring · min: 3 · max: 64Required

The extension number.

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

OK

No content
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
idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw
extension_numberstring · min: 3 · max: 64Required

The extension number.

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

No Content

No content
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
idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200

OK

application/json
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": "xxxxxx",
      "name": "example",
      "display_name": "example",
      "extension_number": "101"
    }
  ]
}

Add monitor group manager

post

Add user into monitor group manager list.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw
extension_numberstring · min: 3 · max: 64Required

The extension number.

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

OK

No content
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
idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw
extension_numberstring · min: 3 · max: 64Required

The extension number.

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

No Content

No content
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
PreviousCall Queues
NextCall Sessions

Last updated

Was this helpful?