16 Monitor Config

16.1 Get Call History configuration

GET https://<HOST>:<PORT>/api/monitorCallHistoryConfig/get?version=0

Returns the Call History configuration

Required Permissions

  • API

  • Monitoring Mode Read Access

Response Body Structure

The response body is structured as MonitorCallHistoryConfig JSON object. A description for its fields is at section 32.24.1. For the JSON schema refer to section 32.24.2.

Example

GET http://localhost:13010/api/monitorCallHistoryConfig/get?version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "maxRecords": 100000,
  "cleanupInterval": 20000,
  "cleanupEnabled": true,
  "deleteOlderDays": 5000,
  "customHeaderNames": ["qwe"],
  "enabled": true,
  "recordedFilesDeleteOlderDays": 4000
}

16.2 Set Call History configuration

POST https://<HOST>:<PORT>/api/monitorCallHistoryConfig/set?version=0

Modifies the Call History configuration

Required Permissions

  • API

  • Monitoring Mode Read/Write Access

Request Body Structure

The request body is structured as MonitorCallHistoryConfig JSON object. A description for its fields is at section 32.24.1. For the JSON schema refer to section 32.24.2.

Example

POST http://localhost:13010/api/monitorCallHistoryConfig/set?version=0
HTTP Request Body
{
  "maxRecords": 100000,
  "cleanupInterval": 20000,
  "cleanupEnabled": true,
  "deleteOlderDays": 5000,
  "enabled": true,
  "recordedFilesDeleteOlderDays": 4000,
  "customHeaderNames": ["qwe"]
}
HTTP Response
HTTP/1.1 200 OK

16.3 Get SIP Flow recording configuration

GET https://<HOST>:<PORT>/api/monitorSipFlowConfig/get?version=0

Returns the active SIP Flow recording configuration

Required Permissions

  • API

  • Monitoring Mode Read Access

Response Body Structure

The response body is structured as MonitorSipFlowConfig JSON object. A description for its fields is at section 32.25.1. For the JSON schema refer to section 32.25.2.

Example

GET http://localhost:13010/api/monitorSipFlowConfig/get?version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "maxMessageLength": 100000,
  "deleteOlderDays": 5000,
  "enabled": true,
  "maxFileSizeGBytes": 100,
  "minDiskSpaceGBytes": 20
}

16.4 Set SIP Flow recording configuration

POST https://<HOST>:<PORT>/api/monitorSipFlowConfig/set?version=0

Modifies the SIP Flow recording configuration

Required Permissions

  • API

  • Monitoring Mode Read/Write Access

Request Body Structure

The request body is structured as MonitorSipFlowConfig JSON object. A description for its fields is at section 32.25.1. For the JSON schema refer to section 32.25.2.

Example

POST http://localhost:13010/api/monitorSipFlowConfig/set?version=0
HTTP Request Body
{
  "maxMessageLength": 100000,
  "deleteOlderDays": 5000,
  "enabled": true,
  "maxFileSizeGBytes": 100,
  "minDiskSpaceGBytes": 20
}
HTTP Response
HTTP/1.1 200 OK