Retrive status of PBX.

GET /system/summary
Retrive status of PBX.
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

Sample Request

                      curl -v -X GET http://127.0.0.1:8990/api/system/summary \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \

Responses

200
Successful operation
application/json
  • call_sessions

    integer

    The count of current call sessions.
  • per_hour_succeeded_calls_count_last_24hours

    array

    Show child attributes
  • failed_calls_count_last_24hours

    integer

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

    integer

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

    integer

    The count of extension.
  • succeeded_calls_count_last_24hours

    integer

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

    string

    Duration for which the PortSIP PBX is running.
  • online_extensions

    integer

    The count of current online extensions.
  • memory_usage

    integer

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

    array

    Show child attributes
  • calls_count_last_24hours

    integer

    The count of calls in last 24 hours.
  • tenants_count

    integer

    The count of tenant.
  • now_time

    string

  • per_hour_failed_calls_count_last_24hours

    array

    Show child attributes

Sample Response

                      
{}

Retrive status of call_manager.

GET /call_manager/summary
Retrive status of call_manager.
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

Sample Request

                      curl -v -X GET http://127.0.0.1:8990/api/call_manager/summary \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \

Responses

200
Successful operation
application/json
  • transports

    array

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

    string

    SIP domain used by current user.
  • pbx_public_ip_v6

    string

    IPV6 address for PortSIP PBX.
  • pbx_private_ip_v4

    string

    IPV4 address for PortSIP PBX.
  • secondary_dns_server

    string

    Secondary DNS Server.
  • pbx_public_ip_v4

    string

    IPV4 address for PortSIP PBX.
  • pbx_private_ip_v6

    string

    IPV6 address for PortSIP PBX.
  • pbx_web_domain

    string

  • primary_dns_server

    string

    Primary DNS Server.

Sample Response

                      
{}