CTI

Manage CTI functions.

List exclusive numbers

get

Get a collection of exclusive numbers

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

get

/exclusive_numbers

HTTPcURLJavaScriptPython

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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

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

4XX

Error

post

/exclusive_numbers

HTTPcURLJavaScriptPython

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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of exclusive number.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

4XX

Error

get

/exclusive_numbers/{id}

HTTPcURLJavaScriptPython

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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of exclusive number.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

application/json

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}

HTTPcURLJavaScriptPython

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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of exclusive number.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

4XX

Error

post

/exclusive_numbers/{id}/destroy

HTTPcURLJavaScriptPython

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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of exclusive number.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

4XX

Error

get

/exclusive_numbers/{id}/call_queues

HTTPcURLJavaScriptPython

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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of exclusive number.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

queue_idall ofRequired

The unique ID of call queue.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

4XX

Error

get

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

HTTPcURLJavaScriptPython

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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of exclusive number.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

queue_idall ofRequired

The unique ID of call queue.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

application/json

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

HTTPcURLJavaScriptPython

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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of exclusive number.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

queue_idall ofRequired

The unique ID of call queue.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

4XX

Error

post

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

HTTPcURLJavaScriptPython

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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/octet-stream

Responsestring · binary

4XX

Error

get

/exclusive_numbers/export

HTTPcURLJavaScriptPython

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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

get

/vip_numbers

HTTPcURLJavaScriptPython

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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

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_atall ofOptional

VIP number's expire time.

string · 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

4XX

Error

post

/vip_numbers

HTTPcURLJavaScriptPython

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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of VIP number.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

4XX

Error

get

/vip_numbers/{id}

HTTPcURLJavaScriptPython

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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of VIP number.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

application/json

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_atall ofOptional

VIP number's expire time.

string · 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}

HTTPcURLJavaScriptPython

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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of VIP number.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

4XX

Error

post

/vip_numbers/{id}/destroy

HTTPcURLJavaScriptPython

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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/octet-stream

Responsestring · binary

4XX

Error

get

/vip_numbers/export

HTTPcURLJavaScriptPython

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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

get

/call_queue_blacklisted_numbers

HTTPcURLJavaScriptPython

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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

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_atall ofOptional

Blacklisted number's expire time.

string · 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

4XX

Error

post

/call_queue_blacklisted_numbers

HTTPcURLJavaScriptPython

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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of blacklisted number.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

4XX

Error

get

/call_queue_blacklisted_numbers/{id}

HTTPcURLJavaScriptPython

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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of blacklisted number.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

application/json

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_atall ofOptional

Blacklisted number's expire time.

string · 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}

HTTPcURLJavaScriptPython

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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of blacklisted number.

stringOptional

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

HTTPcURLJavaScriptPython

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

bearer

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

HTTPcURLJavaScriptPython

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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

get

/call_queue_blacklist_prompts

HTTPcURLJavaScriptPython

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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

enable_level1booleanOptional

Whether to enable the the level 1 blacklist.

Default: false

level1_prompt_file_idall ofOptional

The unique ID of the file.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

enable_level2booleanOptional

Whether to enable the the level 2 blacklist.

Default: false

level2_prompt_file_idall ofOptional

The unique ID of the file.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

No content

4XX

Error

post

/call_queue_blacklist_prompts

HTTPcURLJavaScriptPython

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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

get

/monitor

HTTPcURLJavaScriptPython

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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

enabledbooleanOptional

Enable monitor server or not.

extension_numberall ofOptional

The extension number of monitor server.

string · min: 3 · max: 64Optional

The extension number.

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

Responses

200

OK

No content

4XX

Error

post

/monitor

HTTPcURLJavaScriptPython

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

bearer

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

4XX

Error

get

/monitor_groups

HTTPcURLJavaScriptPython

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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

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

HTTPcURLJavaScriptPython

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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of monitor group.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

4XX

Error

get

/monitor_groups/{id}

HTTPcURLJavaScriptPython

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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of monitor group.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

application/json

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}

HTTPcURLJavaScriptPython

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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of monitor group.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

4XX

Error

post

/monitor_groups/{id}/destroy

HTTPcURLJavaScriptPython

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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of monitor group.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

4XX

Error

get

/monitor_groups/{id}/members

HTTPcURLJavaScriptPython

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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of monitor group.

stringOptional

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}

HTTPcURLJavaScriptPython

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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of monitor group.

stringOptional

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

HTTPcURLJavaScriptPython

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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of monitor group.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

4XX

Error

get

/monitor_groups/{id}/managers

HTTPcURLJavaScriptPython

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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of monitor group.

stringOptional

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}

HTTPcURLJavaScriptPython

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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of monitor group.

stringOptional

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

HTTPcURLJavaScriptPython

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

No content