Retrive status of PBX.

GET /system/summary
Returns the status of PBX.

Request

Placeholders
  • access_token

    string

    required

    Access token is a 32-byte string with validity of 30 seconds.

Sample Request

https://example.com/api/system/summary?access_token=196ACE20C6F34027895F7F95402BB164

Response

Placeholders
  • call_sessions

    integer

    required

    The count of current call sessions.
  • online_extensions

    integer

    required

    The count of current online extensions.
  • up_time

    string

    required

    Duration for which the PortSIP PBX is running.
  • cpu_usage

    integer

    required

    CPU usage for PortSIP PBX with the range 0 - 100.
  • memory_usage

    integer

    required

    Memory usage for PortSIP PBX with the range 0 - 100.
  • tenants_count

    integer

    required

    The count of tenant.
  • extensions_count

    integer

    required

    The count of extension.
  • calls_count_last_24hours

    integer

    required

    The count of calls in last 24 hours.
  • succeeded_calls_count_last_24hours

    integer

    required

    The count of succeeded calls in last 24 hours.
  • failed_calls_count_last_24hours

    integer

    required

    The count of succeeded calls in last 24 hours.
  • per_hour_succeeded_calls_count_last_24hours

    array

    required

  • per_hour_failed_calls_count_last_24hours

    array

    required

  • news

    array

    required

    Show child attributes

Sample Response

{
    "online_extensions": 0,
    "call_sessions": 0,
    "cpu_usage": 7,
    "up_time": "0 D 3 H 27 M 48 S",
    "now_time": "",
    "memory_usage": 86,
    "tenants_count": 0,
    "extensions_count": 0,
    "calls_count_last_24hours": 0,
    "failed_calls_count_last_24hours": 0,
    "succeeded_calls_count_last_24hours": 0,
    "per_hour_succeeded_calls_count_last_24hours": [
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0
    ],
    "per_hour_failed_calls_count_last_24hours": [
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0
    ],
    "news": [
        {
            "title": "Sample title",
            "url": "sample.com"
        }
    ]
}

Retrive status of call manager

GET /call_manager/summary
Returns the status of call manager.

Request

Placeholders
  • access_token

    string

    required

    Access token is a 32-byte string with validity of 30 seconds.

Sample Request

https://example.com/api/call_manager/summary?access_token=196ACE20C6F34027895F7F95402BB164

Response

Placeholders
  • domain

    string

    required

    SIP domain used by current user.
  • pbx_ip_v4

    string

    required

    IPV4 address for PortSIP PBX.
  • pbx_ip_v6

    string

    required

    IPV6 address for PortSIP PBX.
  • pbx_mode

    string

    required

    Working mode for PortSIP PBX. It could be either "public network" or "private network".
  • transports

    array

    required

    Collection of PBX transport protocol objects. PortSIP PBX supports all popular network transport protocol, including UDP, TCP, TLS, WS, and WSS.
    Show child attributes
  • primary_dns_server

    string

    required

    Primary DNS Server.
  • secondary_dns_server

    string

    required

    Secondary DNS Server.

Sample Response

{
    "domain": "portsip.com",
    "pbx_mode": "PRIVATE_NETWORK",
    "pbx_ip_v4": "127.0.0.1",
    "pbx_ip_v6": "",
    "primary_dns_server": "",
    "secondary_dns_server": "",
    "transports": [
        {
            "protocol": "UDP",
            "port": 5060
        }
    ]
}