Receptionist Capacity

These APIs allow to control the maximum number of monitored users for the Receptionist Enterprise service (see Receptionist Enterprise Service).

Retrieve the Receptionist Capacity

GET /api/v1/system/receptionist_enterprise/

Retrieve the currently configured maximum capacity for the Receptionist Enterprise service.

Authorization rights: minimum End User.

Example request:

GET /api/v1/system/receptionist_enterprise/ HTTP/1.1
Host: example.com

{}

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{
   "maxMonitoredUsers": 30
}

Response JSON Object:

• maxMonitoredUsers (integer) – Maximum number of monitored users.

Status Codes:

• 200 OK – no error

Update the Receptionist Capacity

PUT /api/v1/system/receptionist_enterprise/

Update the maximum capacity for the Receptionist Enterprise service.

Authorization Right: minimum System Admin.

Example request:

PUT /api/v1/api/v1/system/receptionist_enterprise/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
   "maxMonitoredUsers": 20
}

Example response:

Response:

Similar to GET instance method response.

Request JSON Object:

• maxMonitoredUsers (integer) – Maximum number of monitored users (1-1000).

Status Codes:

• 200 OK – no error

• 400 Bad Request – error in the input data, most probably due to incorrect values.