Status

Retrieve current system status

get

Get current status of system.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

versionstringOptional

The version information of PortSIP PBX.

newsstringOptional

The news information of PortSIP PBX.

license_keystringOptional

The license key of PortSIP PBX.

license_typestringOptional

The license type of product.

maintenance_expires_atall ofOptional

The maintenance expiry time.

string · date_timeOptional

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Example: 2017-07-21T17:32:28Z

max_concurrent_callsinteger · int32Optional

The number of authorized concurrent calls purchased by the user.

licensed_usersinteger · int32Optional

The maximum number of authorized users purchased by the system admin.

current_usersinteger · int32Optional

The number of current users of the system.

online_usersinteger · int32Optional

The number of current online users of the system.

current_tenantsinteger · int32Optional

The number of current tenants of the system.

current_dealersinteger · int32Optional

The number of current dealers of the system.

current_callsinteger · int32Optional

The current number of calls.

current_trunksinteger · int32Optional

The current number of trunks.

current_conference_serversinteger · int32Optional

The current number of conference servers.

current_media_serversinteger · int32Optional

The current number of media servers.

current_call_queue_serversinteger · int32Optional

The current number of call queue servers.

current_ivr_serversinteger · int32Optional

The current number of ivr servers.

4XX

Error

get

/admin/status

HTTPcURLJavaScriptPython

GET /api/admin/status HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "version": "text",
  "news": "text",
  "license_key": "text",
  "license_type": "text",
  "maintenance_expires_at": "2017-07-21T17:32:28Z",
  "max_concurrent_calls": 1,
  "licensed_users": 1,
  "current_users": 1,
  "online_users": 1,
  "current_tenants": 1,
  "current_dealers": 1,
  "current_calls": 1,
  "current_trunks": 1,
  "current_conference_servers": 1,
  "current_media_servers": 1,
  "current_call_queue_servers": 1,
  "current_ivr_servers": 1,
  "calls_in_24_hours": [
    {
      "time": "2017-07-21T17:32:28Z",
      "count": 1
    }
  ]
}