Status

Retrieve current tenant status

Get status of current tenant.

GEThttp://127.0.0.1:8888/api/tenant/status

Response

2004XX

OK

Body

application/json

versionstring

The version information of PortSIP PBX.

licensed_usersinteger (int32)

The maximum number of authorized users purchased by the tenant from System Admin or Dealer.

current_usersinteger (int32)

The number of current users of the tenant.

online_usersinteger (int32)

The number of current online users of the tenant.

current_callsinteger (int32)

The current number of calls.

current_queuesinteger (int32)

The current number of call queues.

current_conference_roomsinteger (int32)

The current number of conference rooms.

current_ring_groupsinteger (int32)

The current number of ring groups.

current_ivrsinteger (int32)

The current number of virtual receptionists.

current_trunksinteger (int32)

The current number of trunks.

calls_in_24_hoursarray of object

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/tenant/status', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "version": "text",
  "licensed_users": 0,
  "current_users": 0,
  "online_users": 0,
  "current_calls": 0,
  "current_queues": 0,
  "current_conference_rooms": 0,
  "current_ring_groups": 0,
  "current_ivrs": 0,
  "current_trunks": 0,
  "calls_in_24_hours": [
    {
      "time": {},
      "count": 0
    }
  ]
}