Query Status of All PBXs

Query status of all the created PBXs.

Note: For the hosting user, only the PBXs that are created by the hosting user can be queried.

HTTP method and endpoint

GET /api/v1/pbx/instances/status

Request parameters

No request parameters.

Response parameters

Parameter Type Description
id Integer PBX ID.
status String The running status of PBX.
  • stopped: The PBX stops running.
  • starting: The PBX is booting.
  • running: The PBX has been started and is running.

Examples

Request example

GET /api/v1/pbx/instances/status HTTP/1.1
Host: ympapi.yeastarcloud.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJsb2dpbl9uYW1lIjoiY2VjaWxpYUB5ZWFzdGFyLmNvbSIsInNjb3BlIjpbInRydXN0Il0sImV4cCI6MTU0NzAxNDc4OSwiYXV0aG9yaXRpZXMiOlsiUk9MRV9hZG1pbiJdLCJqdGkiOiJiYWYxN2Q2Ny03NGYzLTRlNjQtODMxMi0wYWM1ZTkyZmViZjAiLCJjbGllbnRfaWQiOiI5Nzg5OTNmMDk2YzQ0MTFmYTljYzgwZWUyZTYyZjFmMiJ9.KriN9QENpnb2Vy5qw_ktut4ONrPz-LYhPCxl58jGqSc
Cache-Control: no-cache

Response example

HTTP/1.1 200 OK
{   "instances" : 
    [
        {
            "id": 33,
            "status": "stopped"
        },
        {
            "id": 39,
            "status": "starting"
        },
        {
            "id": 40,
            "status": "running"
        }
    ]
}