Retrice service status

GET /services/status/list
Retrives PortSIP PBX service status.

Request

Placeholders
  • access_token

    string

    required

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

    integer

    required

    The pagination of paging.
  • pagesize

    integer

    required

    The pagesize of paging.
  • sort_by

    enum

    required

    Values include "DEFAULT" and "Optional" Default value will be used when user does not specify value for this field.

Sample Request

https://example.com/api/services/status/list?access_token=196ACE20C6F34027895F7F95402BB164&pagesize=100&pagination=1&sort_by=DEFAULT

Response

Placeholders
  • media_server

    array

    required

    Show child attributes
  • conference_server

    array

    required

    Show child attributes
  • moh_server

    array

    required

    Show child attributes
  • virtual_receptionist_server

    array

    required

    Show child attributes
  • call_queue_server

    array

    required

    Show child attributes
  • voicemail_server

    array

    required

    Show child attributes
  • call_manager

    array

    required

    Show child attributes
  • database_server

    array

    required

    Show child attributes
  • webrtc_server

    array

    required

    Show child attributes

Sample Response

{
    "media_server": [
        {
            "server_name": "BUILT_IN_SERVER",
            "status": "RUNNING",
            "service_type": "PortSIP Media Server"
        }
    ],
    "conference_server": [
        {
            "server_name": "BUILT_IN_SERVER",
            "status": "RUNNING",
            "service_type": "PortSIP Conference Server"
        }
    ],
    "moh_server": [
        {
            "server_name": "PortSIP MOH Server",
            "status": "RUNNING",
            "service_type": "PortSIP MOH Server"
        }
    ],
    "virtual_receptionist_server": [
        {
            "server_name": "PortSIP Virtual Receptionist Server",
            "status": "RUNNING",
            "service_type": "PortSIP Virtual Receptionist Server"
        }
    ],
    "call_queue_server": [
        {
            "server_name": "PortSIP Call Queue Server",
            "status": "RUNNING",
            "service_type": "PortSIP Call Queue Server"
        }
    ],
    "voicemail_server": [
        {
            "server_name": "PortSIP Voice Mail Server",
            "status": "RUNNING",
            "service_type": "PortSIP Voice Mail Server"
        }
    ],
    "call_manager": [
        {
            "server_name": "PortSIP Call Manager Server",
            "status": "RUNNING",
            "service_type": "PortSIP Call Manager Server"
        }
    ],
    "database_server": [
        {
            "server_name": "PortSIP Database Server",
            "status": "RUNNING",
            "service_type": "PortSIP Database Server"
        }
    ],
    "webrtc_server": [
        {
            "server_name": "PortSIP WebRTC Gateway Server",
            "status": "RUNNING",
            "service_type": "PortSIP WebRTC Gateway Server"
        }
    ]
}

Start a service

POST /services/start
Start a service by service name.

Request

Placeholders
  • access_token

    string

    required

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

    enum

    required

    PortSIP Database Server
    PortSIP Call Manager Server
    PortSIP Voicemail Server
    PortSIP Call Queue Server
    PortSIP Virtual Receptionist Server
    PortSIP MOH Server
    PortSIP Conference Server
    PortSIP Media Server
    PortSIP WebRTC Gateway Server
  • server_name

    string

    required

    Server name.

Sample Request

{
    "access_token": "196ACE20C6F34027895F7F95402BB164",
    "server_type": "PortSIP Call Manager Server",
    "server_name": "PortSIP Call Manager Server"
}

Response

Placeholders

Sample Response

Stop a service

POST /services/stop
Stop a service by service name.

Request

Placeholders
  • access_token

    string

    required

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

    enum

    required

    PortSIP Database Server
    PortSIP Call Manager Server
    PortSIP Voicemail Server
    PortSIP Call Queue Server
    PortSIP Virtual Receptionist Server
    PortSIP MOH Server
    PortSIP Conference Server
    PortSIP Media Server
    PortSIP WebRTC Gateway Server
  • server_name

    string

    required

    Server name.

Sample Request

{
    "access_token": "196ACE20C6F34027895F7F95402BB164",
    "server_type": "PortSIP Call Manager Server",
    "server_name": "PortSIP Call Manager Server"
}

Response

Placeholders

Sample Response

Restart a service

POST /services/restart
Restart a service by service name.

Request

Placeholders
  • access_token

    string

    required

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

    boolean

    required

    Control all service or not.
  • server_type

    enum

    required

    PortSIP Database Server
    PortSIP Call Manager Server
    PortSIP Voicemail Server
    PortSIP Call Queue Server
    PortSIP Virtual Receptionist Server
    PortSIP MOH Server
    PortSIP Conference Server
    PortSIP Media Server
    PortSIP WebRTC Gateway Server
  • server_name

    string

    required

    Server name.

Sample Request

{
    "access_token": "196ACE20C6F34027895F7F95402BB164",
    "is_start_all": false,
    "server_type": "PortSIP Call Manager Server",
    "server_name": "PortSIP Call Manager Server"
}

Response

Placeholders

Sample Response