Conference monitor



With Conference monitor, you can define the default class of active participants, short calls and long calls.
[tags: INTERNAL]

Resource Root

https://localhost:8443/api/rest/conference-monitor

Summary


Resources Methods
https://localhost:8443/api/rest/conference-monitor

https://localhost:8443/api/rest/conference-monitor/active-participant-number

GET Get the number of active participants in RPRM.

https://localhost:8443/api/rest/conference-monitor/short-call-number

GET Get the number of short calls in RPRM.

https://localhost:8443/api/rest/conference-monitor/long-calls

GET Get the long calls in RPRM.

https://localhost:8443/api/rest/conference-monitor/monitor-settings

PUT  Set the short call duration and long call threshold.

Resources


https://localhost:8443/api/rest/conference-monitor


https://localhost:8443/api/rest/conference-monitor/active-participant-number


Methods

GET

Get the number of active participants in RPRM.

Response

Status Representation Description
200 application/vnd.plcm.plcm-integer+xml
application/vnd.plcm.plcm-integer+json
The number of active participants is successfully retrieved.
304 The number of active participants has not changed.
401 application/vnd.plcm.plcm-error+xml
Invalid credentials.
403 application/vnd.plcm.plcm-error+xml
Unable to get permission. Get number of active participants requires administrator role.

https://localhost:8443/api/rest/conference-monitor/short-call-number


Methods

GET

Get the number of short calls in RPRM.

Response

Status Representation Description
200 application/vnd.plcm.plcm-integer+xml
application/vnd.plcm.plcm-integer+json
The number of short calls is successfully retrieved.
304 The number of short calls has not changed
401 application/vnd.plcm.plcm-error+xml
Invalid credentials.
403 application/vnd.plcm.plcm-error+xml
Unable to get permission. Getting the number of short calls requires administrator role.

https://localhost:8443/api/rest/conference-monitor/long-calls


Methods

GET

Get the long calls in RPRM.

Response

Status Representation Description
200 application/vnd.plcm.plcm-conference-long-call-list+xml
application/vnd.plcm.plcm-conference-long-call-list+json
The long calls are successfully retrieved.
304 The long calls has not changed
401 application/vnd.plcm.plcm-error+xml
Invalid credentials.
403 application/vnd.plcm.plcm-error+xml
Unable to get permission. Get long calls requires administrator role.

https://localhost:8443/api/rest/conference-monitor/monitor-settings


Methods

PUT


Set the short call duration and long call threshold.
[tags: PD, RPRM]

Request

Representations

application/vnd.plcm.plcm-conference-monitor-settings+xml
application/vnd.plcm.plcm-conference-monitor-settings+json

Response

Status Representation Description
204 Conference monitor settings are successfully updated
403 application/vnd.plcm.plcm-error+xml
Current user does not have the required permission. Require the role: administrator
409 application/vnd.plcm.plcm-error+xml

Invalid settings.