Conference monitoring

Requests

HTTP verb Endpoint Description

GET

/api/monitor/v1/conf/currentload

Conference server load

GET

/api/monitor/v1/conf/active

Dialog counter by servers

GET

/api/monitor/v1/conf/servers

Dialog counter by servers

GET

/api/monitor/v1/conf/sites

Dialog counter by sites

GET

/api/monitor/v1/conf/total

Total dialog counter

GET

/api/monitor/v1/conf/count

Total dialog counter

GET

/api/monitor/v1/conf/rooms

Active conferences

GET

/api/monitor/v1/conf/participants

Conference participants

Domain type: master; for rooms and participants — also worker (own domain data only).

conf server filter: site, sites (comma-separated), server (srvidx, address, or node name), servers (comma-separated srvidx).

Conference server load

The mode parameter: active (default), count, servers, sites, total, rooms, participants — result of the corresponding request.

Dialog counter by servers

Number of calls (callcount) and dialogs (dlgcount) in total, by sites, and by servers. Alias: active.

Example response
HTTP/1.1 200 OK

{
  "resultcode": 0,
  "resultmsg": "OK",
  "data": {
    "callcount": 1,
    "dlgcount": 3,
    "sites": [
      {
        "site": "central",
        "callcount": 1,
        "dlgcount": 3,
        "servers": [
          {
            "srvidx": 1003,
            "node": "conf1@192.168.0.84",
            "addr": "192.168.0.84",
            "online": true,
            "callcount": 1,
            "dlgcount": 3
          }
        ]
      }
    ]
  }
}

For an unavailable server — online: false without counters.

Dialog counter by sites

Like Dialog counter by servers, without the server list.

Total dialog counter

Total number of calls and dialogs (callcount, dlgcount). Alias: count.

Active conferences

Example response
HTTP/1.1 200 OK

{
  "resultcode": 0,
  "resultmsg": "OK",
  "data": {
    "rooms": ["sip:conf-123@test.rootdomain.ru"]
  }
}

Conference participants

Request

Table 1. Request parameters
Specification Description

Name: room
Type: str

Required. Conference URI (from Active conferences), for example sip:conf-123@test.rootdomain.ru.

Example request
GET /api/monitor/v1/conf/participants?room=sip:conf-123@test.rootdomain.ru HTTP/1.1

Response

Example response
HTTP/1.1 200 OK

{
  "resultcode": 0,
  "resultmsg": "OK",
  "data": {
    "participants": [
      {
        "callid": "1870585125@192.168.0.204",
        "uri": "sip:sip1@test.rootdomain.ru",
        "disp": "Ivanov"
      }
    ]
  }
}