# CTI
Manage CTI functions.
## List exclusive numbers
> Get a collection of exclusive numbers
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.3"},"tags":[{"name":"CTI","description":"Manage CTI functions.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/exclusive_numbers":{"get":{"tags":["CTI"],"operationId":"listExclusiveNumbers","summary":"List exclusive numbers","description":"Get a collection of exclusive numbers\n","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","format":"int64","minimum":0,"description":"Total number of resource.\n"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of exclusive number.\n"},"number":{"type":"string","minLength":1,"maxLength":64,"description":"The telephone number.\n"},"created_at":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"Exclusive number created at this time.\n"},"enabled":{"type":"boolean","default":true,"description":"Enable the exclusive number or not.\n"},"description":{"type":"string","maxLength":1024,"description":"Exclusive number's description.\n"}}}}}}}}},"4XX":{"description":"Error"}}}}}}
```
## Create exclusive number
> Add a new exclusive number
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.3"},"tags":[{"name":"CTI","description":"Manage CTI functions.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/exclusive_numbers":{"post":{"tags":["CTI"],"operationId":"createExclusiveNumber","summary":"Create exclusive number","description":"Add a new exclusive number\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"number":{"type":"string","minLength":1,"maxLength":64,"description":"The telephone number.\n"},"enabled":{"type":"boolean","default":true,"description":"Enable the exclusive number or not.\n"},"description":{"type":"string","maxLength":1024,"description":"Exclusive number's description.\n"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the resource.\n"}}}}}},"4XX":{"description":"Error"}}}}}}
```
## Retrieve a exclusive number
> Get details of a exclusive number
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.3"},"tags":[{"name":"CTI","description":"Manage CTI functions.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/exclusive_numbers/{id}":{"get":{"tags":["CTI"],"operationId":"showExclusiveNumber","summary":"Retrieve a exclusive number","description":"Get details of a exclusive number\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of exclusive number.\n"},"description":"The unique ID of the exclusive number."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of exclusive number.\n"},"number":{"type":"string","minLength":1,"maxLength":64,"description":"The telephone number.\n"},"created_at":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"Exclusive number created at this time.\n"},"enabled":{"type":"boolean","default":true,"description":"Enable the exclusive number or not.\n"},"description":{"type":"string","maxLength":1024,"description":"Exclusive number's description.\n"}}}}}},"4XX":{"description":"Error"}}}}}}
```
## Update exclusive number
> Update properties of a exclusive number.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.3"},"tags":[{"name":"CTI","description":"Manage CTI functions.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/exclusive_numbers/{id}":{"post":{"tags":["CTI"],"operationId":"updateExclusiveNumber","summary":"Update exclusive number","description":"Update properties of a exclusive number.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of exclusive number.\n"},"description":"The unique ID of the exclusive number."}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"number":{"type":"string","minLength":1,"maxLength":64,"description":"The telephone number.\n"},"enabled":{"type":"boolean","default":true,"description":"Enable the exclusive number or not.\n"},"description":{"type":"string","maxLength":1024,"description":"Exclusive number's description.\n"}}}}}},"responses":{"200":{"description":"OK"},"4XX":{"description":"Error"}}}}}}
```
## Delete exclusive number
> Destroy a exclusive number by it's unique ID.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.3"},"tags":[{"name":"CTI","description":"Manage CTI functions.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/exclusive_numbers/{id}/destroy":{"post":{"tags":["CTI"],"operationId":"deleteExclusiveNumber","summary":"Delete exclusive number","description":"Destroy a exclusive number by it's unique ID.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of exclusive number.\n"},"description":"The unique ID of the call queue exclusive number."}],"responses":{"204":{"description":"No Content"},"4XX":{"description":"Error"}}}}}}
```
## List call queues of exclusive number
> Get a collection of call queues where exclusive number is located.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.3"},"tags":[{"name":"CTI","description":"Manage CTI functions.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/exclusive_numbers/{id}/call_queues":{"get":{"tags":["CTI"],"operationId":"listExclusiveNumberCallQueues","summary":"List call queues of exclusive number","description":"Get a collection of call queues where exclusive number is located.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of exclusive number.\n"},"description":"The unique ID the exclusive number."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of call queue.\n"},"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of call queue.\n"},"extension_number":{"type":"string","minLength":3,"maxLength":64,"pattern":"[0-9]{3,64}","description":"The extension number.\n"}}}}}}}}},"4XX":{"description":"Error"}}}}}}
```
## List agents in call queue for exclusive number
> Get a collection of agent extension numbers in call queue for exclusive number.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.3"},"tags":[{"name":"CTI","description":"Manage CTI functions.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/exclusive_numbers/{id}/call_queues/{queue_id}/agents":{"get":{"tags":["CTI"],"operationId":"listAgentsOfExclusiveNumberInQueue","summary":"List agents in call queue for exclusive number","description":"Get a collection of agent extension numbers in call queue for exclusive number.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of exclusive number.\n"},"description":"The unique ID the exclusive number."},{"name":"queue_id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of call queue.\n"},"description":"The unique ID the call queue."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of user.\n"},"name":{"type":"string","minLength":1,"maxLength":64,"description":"The user's account name. \nOnly letters, numbers, and the following special characters can be added: underscore, dash, single quote, and period (_, -, ', and .). \nUsername cannot start or end with period (.). \n`admin`, `system`, `administrator`, and `root` are reserved names for system admin only with case ignored.\n"},"display_name":{"type":"string","maxLength":1024,"description":"The display name of user.\n"},"extension_number":{"type":"string","minLength":3,"maxLength":64,"pattern":"[0-9]{3,64}","description":"The extension number.\n"}}}}}}}}},"4XX":{"description":"Error"}}}}}}
```
## Set agents for exclusive number
> Set agents for exclusive number.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.3"},"tags":[{"name":"CTI","description":"Manage CTI functions.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/exclusive_numbers/{id}/call_queues/{queue_id}/agents":{"post":{"tags":["CTI"],"operationId":"setAgentsForExclusiveNumber","summary":"Set agents for exclusive number","description":"Set agents for exclusive number.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of exclusive number.\n"},"description":"The unique ID the exclusive number."},{"name":"queue_id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of call queue.\n"},"description":"The unique ID the call queue."}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"string","minLength":3,"maxLength":64,"pattern":"[0-9]{3,64}","description":"The extension number.\n"},"description":"A collection of call queue agent extension numbers.\n"}}}}}},"responses":{"200":{"description":"OK"},"4XX":{"description":"Error"}}}}}}
```
## Remove all agents of call queue for exclusive number
> Remove all agents of call queue for exclusive number.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.3"},"tags":[{"name":"CTI","description":"Manage CTI functions.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/exclusive_numbers/{id}/call_queues/{queue_id}/destroy":{"post":{"tags":["CTI"],"operationId":"removeAllAgentsOfQueueForExclusiveNumber","summary":"Remove all agents of call queue for exclusive number","description":"Remove all agents of call queue for exclusive number.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of exclusive number.\n"},"description":"The unique ID the exclusive number."},{"name":"queue_id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of call queue.\n"},"description":"The unique ID the call queue."}],"responses":{"204":{"description":"No Content"},"4XX":{"description":"Error"}}}}}}
```
## Export exclusive numbers
> Export a collection of number blacklists to file.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.3"},"tags":[{"name":"CTI","description":"Manage CTI functions.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/exclusive_numbers/export":{"get":{"tags":["CTI"],"operationId":"exportExclusiveNumbers","summary":"Export exclusive numbers","description":"Export a collection of number blacklists to file.\n","responses":{"200":{"description":"OK","headers":{"Content-Disposition":{"schema":{"type":"string"},"description":"the format is `attachment; filename=\"example\"`"}},"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"4XX":{"description":"Error"}}}}}}
```
## List VIP numbers
> Get a collection of VIP numbers.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.3"},"tags":[{"name":"CTI","description":"Manage CTI functions.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/vip_numbers":{"get":{"tags":["CTI"],"operationId":"listVipNumbers","summary":"List VIP numbers","description":"Get a collection of VIP numbers.\n","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","format":"int64","minimum":0,"description":"Total number of resource.\n"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of VIP number.\n"},"number":{"type":"string","minLength":1,"maxLength":64,"pattern":"[0-9+]{1,64}","description":"The VIP number, a string value contains a valid telephone number.\n"},"longitude":{"type":"string","description":"VIP number's longitude.\n"},"latitude":{"type":"string","description":"VIP number's latitude.\n"},"address":{"type":"string","maxLength":128,"description":"The address.\n"},"created_at":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"Exclusive number created at this time.\n"},"updated_at":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"VIP number's modified time.\n"},"expire_at":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"VIP number's expire time.\n"},"enabled":{"type":"boolean","description":"Enable the VIP number or not.\n"},"description":{"type":"string","maxLength":1024,"description":"VIP number's description.\n"}}}}}}}}},"4XX":{"description":"Error"}}}}}}
```
## Add VIP number
> Create a new VIP number.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.3"},"tags":[{"name":"CTI","description":"Manage CTI functions.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/vip_numbers":{"post":{"tags":["CTI"],"operationId":"CreateVipNumber","summary":"Add VIP number","description":"Create a new VIP number.\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"number":{"type":"string","minLength":1,"maxLength":64,"pattern":"[0-9+]{1,64}","description":"The VIP number, a string value contains a valid telephone number.\n"},"longitude":{"type":"string","description":"VIP number's longitude.\n"},"latitude":{"type":"string","description":"VIP number's latitude.\n"},"address":{"type":"string","maxLength":128,"description":"The address.\n"},"expire_at":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"VIP number's expire time.\n"},"enabled":{"type":"boolean","description":"Enable the VIP number or not.\n"},"description":{"type":"string","maxLength":1024,"description":"VIP number's description.\n"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of VIP number.\n"}}}}}},"4XX":{"description":"Error"}}}}}}
```
## Retrieve VIP number
> Get details of the VIP number.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.3"},"tags":[{"name":"CTI","description":"Manage CTI functions.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/vip_numbers/{id}":{"get":{"tags":["CTI"],"operationId":"showVipNumber","summary":"Retrieve VIP number","description":"Get details of the VIP number.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of VIP number.\n"},"description":"The unique ID of the VIP number."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of VIP number.\n"},"number":{"type":"string","minLength":1,"maxLength":64,"pattern":"[0-9+]{1,64}","description":"The VIP number, a string value contains a valid telephone number.\n"},"longitude":{"type":"string","description":"VIP number's longitude.\n"},"latitude":{"type":"string","description":"VIP number's latitude.\n"},"address":{"type":"string","maxLength":128,"description":"The address.\n"},"created_at":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"Exclusive number created at this time.\n"},"updated_at":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"VIP number's modified time.\n"},"expire_at":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"VIP number's expire time.\n"},"enabled":{"type":"boolean","description":"Enable the VIP number or not.\n"},"description":{"type":"string","maxLength":1024,"description":"VIP number's description.\n"}}}}}},"4XX":{"description":"Error"}}}}}}
```
## Update VIP number
> Update a VIP number.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.3"},"tags":[{"name":"CTI","description":"Manage CTI functions.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/vip_numbers/{id}":{"post":{"tags":["CTI"],"operationId":"updateVipNumber","summary":"Update VIP number","description":"Update a VIP number.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of VIP number.\n"},"description":"The unique ID of the VIP number."}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"number":{"type":"string","minLength":1,"maxLength":64,"pattern":"[0-9+]{1,64}","description":"The VIP number, a string value contains a valid telephone number.\n"},"longitude":{"type":"string","description":"VIP number's longitude.\n"},"latitude":{"type":"string","description":"VIP number's latitude.\n"},"address":{"type":"string","maxLength":128,"description":"The address.\n"},"expire_at":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"VIP number's expire time.\n"},"enabled":{"type":"boolean","description":"Enable the VIP number or not.\n"},"description":{"type":"string","maxLength":1024,"description":"VIP number's description.\n"}}}}}},"responses":{"200":{"description":"OK"},"4XX":{"description":"Error"}}}}}}
```
## Delete VIP number
> Destroy a VIP number by it's unique ID.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.3"},"tags":[{"name":"CTI","description":"Manage CTI functions.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/vip_numbers/{id}/destroy":{"post":{"tags":["CTI"],"operationId":"deleteVipNumber","summary":"Delete VIP number","description":"Destroy a VIP number by it's unique ID.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of VIP number.\n"},"description":"The unique ID of the VIP number."}],"responses":{"204":{"description":"No Content"},"4XX":{"description":"Error"}}}}}}
```
## Export VIP numbers
> Export a collection of VIP numbers to file.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.3"},"tags":[{"name":"CTI","description":"Manage CTI functions.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/vip_numbers/export":{"get":{"tags":["CTI"],"operationId":"exportVipNumbers","summary":"Export VIP numbers","description":"Export a collection of VIP numbers to file.\n","responses":{"200":{"description":"OK","headers":{"Content-Disposition":{"schema":{"type":"string"},"description":"the format is `attachment; filename=\"example\"`"}},"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"4XX":{"description":"Error"}}}}}}
```
## GET /call\_queue\_blacklisted\_numbers
> List call queue blacklisted numbers
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.3"},"tags":[{"name":"CTI","description":"Manage CTI functions.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/call_queue_blacklisted_numbers":{"get":{"tags":["CTI"],"operationId":"listQueueBlacklistedNumbers","summary":"List call queue blacklisted numbers","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of blacklisted number.\n"},"number":{"type":"string","minLength":1,"maxLength":64,"pattern":"[0-9+]{1,64}","description":"The blacklisted number, a string value contains a valid telephone number or extension number.\n"},"level":{"type":"string","enum":["FIRST","SECOND"],"description":"Blacklisted number's level:\n- `FIRST`: A first level blacklisted number.\n- `SECOND`: A second level blacklisted number.\n"},"longitude":{"type":"string","description":"Blacklisted number's longitude.\n"},"latitude":{"type":"string","description":"Blacklisted number's latitude.\n"},"address":{"type":"string","maxLength":128,"description":"The address.\n"},"created_at":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"The creation time of blacklisted number.\n"},"updated_at":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"Blacklisted number's modified time.\n"},"expire_at":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"Blacklisted number's expire time.\n"},"trigger_times":{"type":"integer","format":"int32","minimum":0,"description":"Blacklisted number have been triggered for this times.\n"},"enabled":{"type":"boolean","default":true,"description":"Enable the blacklisted number or not.\n"},"description":{"type":"string","minLength":0,"maxLength":1024,"description":"Blacklisted number's description.\n"}}}}}}}}},"4XX":{"description":"Error"}}}}}}
```
## POST /call\_queue\_blacklisted\_numbers
> Add a call queue blacklisted number
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.3"},"tags":[{"name":"CTI","description":"Manage CTI functions.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/call_queue_blacklisted_numbers":{"post":{"tags":["CTI"],"operationId":"createQueueBlacklistedNumber","summary":"Add a call queue blacklisted number","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"number":{"type":"string","minLength":1,"maxLength":64,"pattern":"[0-9+]{1,64}","description":"The blacklisted number, a string value contains a valid telephone number or extension number.\n"},"level":{"type":"string","enum":["FIRST","SECOND"],"description":"Blacklisted number's level:\n- `FIRST`: A first level blacklisted number.\n- `SECOND`: A second level blacklisted number.\n"},"longitude":{"type":"string","description":"Blacklisted number's longitude.\n"},"latitude":{"type":"string","description":"Blacklisted number's latitude.\n"},"address":{"type":"string","maxLength":128,"description":"The address.\n"},"expire_at":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"Blacklisted number's expire time.\n"},"trigger_times":{"type":"integer","format":"int32","minimum":0,"description":"Blacklisted number have been triggered for this times.\n"},"enabled":{"type":"boolean","default":true,"description":"Enable the blacklisted number or not.\n"},"description":{"type":"string","minLength":0,"maxLength":1024,"description":"Blacklisted number's description.\n"}},"required":["number","level"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the resource.\n"}}}}}},"4XX":{"description":"Error"}}}}}}
```
## GET /call\_queue\_blacklisted\_numbers/{id}
> Retrieve a call queue blacklisted number
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.3"},"tags":[{"name":"CTI","description":"Manage CTI functions.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/call_queue_blacklisted_numbers/{id}":{"get":{"tags":["CTI"],"operationId":"showQueueBlacklistedNumber","summary":"Retrieve a call queue blacklisted number","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of blacklisted number.\n"},"description":"The unique ID of the blacklisted number."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of blacklisted number.\n"},"number":{"type":"string","minLength":1,"maxLength":64,"pattern":"[0-9+]{1,64}","description":"The blacklisted number, a string value contains a valid telephone number or extension number.\n"},"level":{"type":"string","enum":["FIRST","SECOND"],"description":"Blacklisted number's level:\n- `FIRST`: A first level blacklisted number.\n- `SECOND`: A second level blacklisted number.\n"},"longitude":{"type":"string","description":"Blacklisted number's longitude.\n"},"latitude":{"type":"string","description":"Blacklisted number's latitude.\n"},"address":{"type":"string","maxLength":128,"description":"The address.\n"},"created_at":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"The creation time of blacklisted number.\n"},"updated_at":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"Blacklisted number's modified time.\n"},"expire_at":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"Blacklisted number's expire time.\n"},"trigger_times":{"type":"integer","format":"int32","minimum":0,"description":"Blacklisted number have been triggered for this times.\n"},"enabled":{"type":"boolean","default":true,"description":"Enable the blacklisted number or not.\n"},"description":{"type":"string","minLength":0,"maxLength":1024,"description":"Blacklisted number's description.\n"}}}}}},"4XX":{"description":"Error"}}}}}}
```
## POST /call\_queue\_blacklisted\_numbers/{id}
> Update a call queue blacklisted number
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.3"},"tags":[{"name":"CTI","description":"Manage CTI functions.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/call_queue_blacklisted_numbers/{id}":{"post":{"tags":["CTI"],"operationId":"updateQueueBlacklistedNumber","summary":"Update a call queue blacklisted number","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of blacklisted number.\n"},"description":"The unique ID of the call queue blacklisted number."}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"number":{"type":"string","minLength":1,"maxLength":64,"pattern":"[0-9+]{1,64}","description":"The blacklisted number, a string value contains a valid telephone number or extension number.\n"},"level":{"type":"string","enum":["FIRST","SECOND"],"description":"Blacklisted number's level:\n- `FIRST`: A first level blacklisted number.\n- `SECOND`: A second level blacklisted number.\n"},"longitude":{"type":"string","description":"Blacklisted number's longitude.\n"},"latitude":{"type":"string","description":"Blacklisted number's latitude.\n"},"address":{"type":"string","maxLength":128,"description":"The address.\n"},"expire_at":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"Blacklisted number's expire time.\n"},"trigger_times":{"type":"integer","format":"int32","minimum":0,"description":"Blacklisted number have been triggered for this times.\n"},"enabled":{"type":"boolean","default":true,"description":"Enable the blacklisted number or not.\n"},"description":{"type":"string","minLength":0,"maxLength":1024,"description":"Blacklisted number's description.\n"}}}}}},"responses":{"200":{"description":"OK"},"4XX":{"description":"Error"}}}}}}
```
## POST /call\_queue\_blacklisted\_numbers/{id}/destroy
> Delete a call queue blacklisted number
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.3"},"tags":[{"name":"CTI","description":"Manage CTI functions.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/call_queue_blacklisted_numbers/{id}/destroy":{"post":{"tags":["CTI"],"operationId":"deleteQueueBlacklistedNumber","summary":"Delete a call queue blacklisted number","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of blacklisted number.\n"},"description":"The unique ID of the call queue blacklisted number."}],"responses":{"204":{"description":"No Content"},"400":{"description":"Invalid item ID"},"404":{"description":"User not found"}}}}}}
```
## Export queue blacklisted numbers
> Export a collection of queue blacklisted numbers to file.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.3"},"tags":[{"name":"CTI","description":"Manage CTI functions.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/call_queue_blacklisted_numbers/export":{"get":{"tags":["CTI"],"operationId":"exportQueueBlacklistedNumbers","summary":"Export queue blacklisted numbers","description":"Export a collection of queue blacklisted numbers to file.\n","responses":{"200":{"description":"OK","headers":{"Content-Disposition":{"schema":{"type":"string"},"description":"the format is `attachment; filename=\"example\"`"}},"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"4XX":{"description":"Error"}}}}}}
```
## Retrieve call queue blacklist prompts configurations
> Retrieve call queue blacklist prompts configurations.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.3"},"tags":[{"name":"CTI","description":"Manage CTI functions.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/call_queue_blacklist_prompts":{"get":{"tags":["CTI"],"operationId":"getCallQueueBlacklistPrompts","summary":"Retrieve call queue blacklist prompts configurations","description":"Retrieve call queue blacklist prompts configurations.\n","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"enable_level1":{"type":"boolean","default":false,"description":"Whether to enable the the level 1 blacklist.\n"},"level1_prompt_file_name":{"type":"string","description":"The name of the file.\n"},"level1_prompt_file_size":{"type":"integer","format":"int64","minimum":0,"description":"The file size in bytes.\n"},"level1_prompt_file_url":{"type":"string","readOnly":true,"description":"The relative path to file url for file downloading.\n"},"enable_level2":{"type":"boolean","default":false,"description":"Whether to enable the the level 2 blacklist.\n"},"level2_prompt_file_name":{"type":"string","description":"The name of the file.\n"},"level2_prompt_file_size":{"type":"integer","format":"int64","minimum":0,"description":"The file size in bytes.\n"},"level2_prompt_file_url":{"type":"string","readOnly":true,"description":"The relative path to file url for file downloading.\n"}}}}}},"4XX":{"description":"Error"}}}}}}
```
## Update call queue blacklist prompts configurations
> Update call queue blacklist prompts configurations.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.3"},"tags":[{"name":"CTI","description":"Manage CTI functions.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/call_queue_blacklist_prompts":{"post":{"tags":["CTI"],"operationId":"updateCallQueueBlacklistPrompts","summary":"Update call queue blacklist prompts configurations","description":"Update call queue blacklist prompts configurations.\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"enable_level1":{"type":"boolean","default":false,"description":"Whether to enable the the level 1 blacklist.\n"},"level1_prompt_file_id":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of the file.\n"},"enable_level2":{"type":"boolean","default":false,"description":"Whether to enable the the level 2 blacklist.\n"},"level2_prompt_file_id":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of the file.\n"}}}}}},"responses":{"200":{"description":"OK"},"4XX":{"description":"Error"}}}}}}
```
## Retrieve monitor server
> Retrieve monitor server information.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.3"},"tags":[{"name":"CTI","description":"Manage CTI functions.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/monitor":{"get":{"tags":["CTI"],"operationId":"showMonitorServer","summary":"Retrieve monitor server","description":"Retrieve monitor server information.\n","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Enable monitor server or not.\n"},"extension_number":{"allOf":[{"type":"string","minLength":3,"maxLength":64,"pattern":"[0-9]{3,64}","description":"The extension number.\n"}],"description":"The extension number of monitor server.\n"}}}}}},"4XX":{"description":"Error"}}}}}}
```
## Update monitor server
> Update monitor server
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.3"},"tags":[{"name":"CTI","description":"Manage CTI functions.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/monitor":{"post":{"tags":["CTI"],"operationId":"updateMonitorServer","summary":"Update monitor server","description":"Update monitor server\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Enable monitor server or not.\n"},"extension_number":{"allOf":[{"type":"string","minLength":3,"maxLength":64,"pattern":"[0-9]{3,64}","description":"The extension number.\n"}],"description":"The extension number of monitor server.\n"}}}}}},"responses":{"200":{"description":"OK"},"4XX":{"description":"Error"}}}}}}
```
## List monitor groups
> List monitor groups
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.3"},"tags":[{"name":"CTI","description":"Manage CTI functions.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/monitor_groups":{"get":{"tags":["CTI"],"operationId":"listMonitorGroups","summary":"List monitor groups","description":"List monitor groups\n","parameters":[{"name":"filter","in":"query","required":false,"schema":{"type":"string"},"description":"Use the `filter` query parameter to retrieve just a subset of a collection.\n"},{"name":"search","in":"query","required":false,"schema":{"type":"string"},"description":"Use the `search` query parameter to restrict the results of a request to match a search criterion.\n"},{"name":"orderby","in":"query","required":false,"schema":{"type":"string"},"description":"Use the `orderby` query parameter to specify the sort order of the items returned from server. \nThe default order is ascending order.\n"},{"name":"skip","in":"query","required":false,"schema":{"type":"integer","format":"int32","minimum":0,"default":0},"description":"Use the `skip` query parameter to set the number of items to skip at the start of a collection.\n"},{"name":"top","in":"query","required":false,"schema":{"type":"integer","format":"int32","minimum":1,"maximum":100,"default":100},"description":"Use the `top` query parameter to specify the page size of the result set.\n"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","format":"int64","minimum":0,"description":"Total number of resource.\n"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of monitor group.\n"},"name":{"type":"string","minLength":1,"maxLength":64,"description":"Name of monitor group\n"},"enabled":{"type":"boolean","description":"Enable monitor group or not.\n"},"description":{"type":"string","maxLength":1024,"description":"Description for monitor group\n"}}}}}}}}},"4XX":{"description":"Error"}}}}}}
```
## Create a monitor group
> Create a new monitor group.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.3"},"tags":[{"name":"CTI","description":"Manage CTI functions.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/monitor_groups":{"post":{"tags":["CTI"],"operationId":"createMonitorGroup","summary":"Create a monitor group","description":"Create a new monitor group.\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"Name of monitor group\n"},"enabled":{"type":"boolean","description":"Enable monitor group or not.\n"},"description":{"type":"string","maxLength":1024,"description":"Description for monitor group\n"}}}}}},"responses":{"201":{"description":"Created monitor group","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of monitor group.\n"}}}}}},"4XX":{"description":"Error"}}}}}}
```
## Retrieve a monitor group
> Retrieves details of a monitor group.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.3"},"tags":[{"name":"CTI","description":"Manage CTI functions.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/monitor_groups/{id}":{"get":{"tags":["CTI"],"operationId":"showMonitorGroup","summary":"Retrieve a monitor group","description":"Retrieves details of a monitor group.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of monitor group.\n"},"description":"The unique ID of the monitor group."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of monitor group.\n"},"name":{"type":"string","minLength":1,"maxLength":64,"description":"Name of monitor group\n"},"enabled":{"type":"boolean","description":"Enable monitor group or not.\n"},"description":{"type":"string","maxLength":1024,"description":"Description for monitor group\n"}}}}}},"4XX":{"description":"Error"}}}}}}
```
## Update an monitor group.
> Update an monitor group
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.3"},"tags":[{"name":"CTI","description":"Manage CTI functions.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/monitor_groups/{id}":{"post":{"tags":["CTI"],"operationId":"updateMonitorGroup","summary":"Update an monitor group.","description":"Update an monitor group\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of monitor group.\n"},"description":"The unique ID of the monitor group."}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"Name of monitor group\n"},"enabled":{"type":"boolean","description":"Enable monitor group or not.\n"},"description":{"type":"string","maxLength":1024,"description":"Description for monitor group\n"}}}}}},"responses":{"200":{"description":"OK"},"4XX":{"description":"Error"}}}}}}
```
## Delete an monitor group
> Delete a monitor group.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.3"},"tags":[{"name":"CTI","description":"Manage CTI functions.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/monitor_groups/{id}/destroy":{"post":{"tags":["CTI"],"operationId":"deleteMonitorGroup","summary":"Delete an monitor group","description":"Delete a monitor group.","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of monitor group.\n"},"description":"The unique ID of the monitor group."}],"responses":{"204":{"description":"No Content"},"4XX":{"description":"Error"}}}}}}
```
## List monitor group members
> Retrieve a collection of monitor group members.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.3"},"tags":[{"name":"CTI","description":"Manage CTI functions.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/monitor_groups/{id}/members":{"get":{"tags":["CTI"],"operationId":"listMonitorGroupMembers","summary":"List monitor group members","description":"Retrieve a collection of monitor group members.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of monitor group.\n"},"description":"The unique ID of the monitor group."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of user.\n"},"name":{"type":"string","minLength":1,"maxLength":64,"description":"The user's account name. \nOnly letters, numbers, and the following special characters can be added: underscore, dash, single quote, and period (_, -, ', and .). \nUsername cannot start or end with period (.). \n`admin`, `system`, `administrator`, and `root` are reserved names for system admin only with case ignored.\n"},"display_name":{"type":"string","maxLength":1024,"description":"The display name of user.\n"},"extension_number":{"type":"string","minLength":3,"maxLength":64,"pattern":"[0-9]{3,64}","description":"The extension number.\n"}}}}}}}}},"4XX":{"description":"Error"}}}}}}
```
## Add monitor group member
> Add user member into monitor group.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.3"},"tags":[{"name":"CTI","description":"Manage CTI functions.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/monitor_groups/{id}/members/{extension_number}":{"post":{"tags":["CTI"],"operationId":"createMonitorGroupMember","summary":"Add monitor group member","description":"Add user member into monitor group.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of monitor group.\n"},"description":"The unique ID of the monitor group."},{"name":"extension_number","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"[0-9]{3,64}","description":"The extension number.\n"},"description":"The extension number of the member."}],"responses":{"200":{"description":"OK"},"4XX":{"description":"Error"}}}}}}
```
## Delete monitor group member
> Delete an monitor group member.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.3"},"tags":[{"name":"CTI","description":"Manage CTI functions.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/monitor_groups/{id}/members/{extension_number}/destroy":{"post":{"tags":["CTI"],"operationId":"deleteMonitorGroupMember","summary":"Delete monitor group member","description":"Delete an monitor group member.","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of monitor group.\n"},"description":"The unique ID of the group."},{"name":"extension_number","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"[0-9]{3,64}","description":"The extension number.\n"},"description":"The extension number of the group member."}],"responses":{"204":{"description":"No Content"},"4XX":{"description":"Error"}}}}}}
```
## List monitor group manager
> Retrieve a collection of monitor group managers.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.3"},"tags":[{"name":"CTI","description":"Manage CTI functions.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/monitor_groups/{id}/managers":{"get":{"tags":["CTI"],"operationId":"listMonitorGroupManagers","summary":"List monitor group manager","description":"Retrieve a collection of monitor group managers.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of monitor group.\n"},"description":"The unique ID of the monitor group."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of user.\n"},"name":{"type":"string","minLength":1,"maxLength":64,"description":"The user's account name. \nOnly letters, numbers, and the following special characters can be added: underscore, dash, single quote, and period (_, -, ', and .). \nUsername cannot start or end with period (.). \n`admin`, `system`, `administrator`, and `root` are reserved names for system admin only with case ignored.\n"},"display_name":{"type":"string","maxLength":1024,"description":"The display name of user.\n"},"extension_number":{"type":"string","minLength":3,"maxLength":64,"pattern":"[0-9]{3,64}","description":"The extension number.\n"}}}}}}}}},"4XX":{"description":"Error"}}}}}}
```
## Add monitor group manager
> Add user into monitor group manager list.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.3"},"tags":[{"name":"CTI","description":"Manage CTI functions.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/monitor_groups/{id}/managers/{extension_number}":{"post":{"tags":["CTI"],"operationId":"createMonitorGroupManager","summary":"Add monitor group manager","description":"Add user into monitor group manager list.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of monitor group.\n"},"description":"The unique ID of the monitor group."},{"name":"extension_number","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"[0-9]{3,64}","description":"The extension number.\n"},"description":"The extension number of the member."}],"responses":{"200":{"description":"OK"},"4XX":{"description":"Error"}}}}}}
```
## Delete monitor group manager
> Delete an manager from monitor group manager list.
```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.3"},"tags":[{"name":"CTI","description":"Manage CTI functions.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/monitor_groups/{id}/managers/{extension_number}/destroy":{"post":{"tags":["CTI"],"operationId":"deleteMonitorGroupManager","summary":"Delete monitor group manager","description":"Delete an manager from monitor group manager list.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of monitor group.\n"},"description":"The unique ID of the group."},{"name":"extension_number","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":64,"pattern":"[0-9]{3,64}","description":"The extension number.\n"},"description":"The extension number of the group manager."}],"responses":{"204":{"description":"No Content"},"4XX":{"description":"Error"}}}}}}
```