Query Status of a PBX

Query the status of a specific PBX.

HTTP method and endpoint

GET /api/v1/pbx/instances/{instance_id}/status

Request parameters

Parameter Importance Type Description
instance_id Required Integer PBX ID.

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/33/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
{   "instance" : 
        {
            "id": 33,
            "status": "stopped"
        }
}