Query a Specific PBX

Query the information of a specific PBX.

HTTP method and endpoint

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

Request parameters

Parameter Importance Type Description
instance_id Required Integer PBX ID.

Response parameters - PBX info

Parameter Type Description
id Integer PBX ID.
name String PBX name.
domain String PBX domain.
customers Array<PBXCustomer> PBX customer.
version String PBX version.
creator Object<PBXCreator> Information of PBX creator.
createTime String When the PBX was created.
initialStartUpTime String When the PBX was first started.
uptime String How long the PBX has been running.
linkusChat String Is Linkus Chat feature enabled or not.
extension Integer The maximum number of extensions for the PBX.
concurrentCall Integer The maximum number of concurrent calls for the PBX.
recordingCapacity Integer
  • The maximum recording time for the PBX.
  • Time Unit: minute.
callRecording Boolean Is the Call Recording feature enabled or not.
status String The running status of the PBX.
  • stopped: The PBX stops running.
  • starting: The PBX is booting.
  • running: The PBX has been started and is running.
sn String The PBX SN (Serial Number).
active Boolean Is the PBX activated or not.
activeCalls Integer How many concurrent calls are being made on the PBX now.
upgradeInPBX Boolean Is the Upgrade feature is enabled or not.

Response parameters - PBXCreator info

Parameter Type Description
id Integer User ID.
name String The creator's name.
email String The creator's email address.

Response parameters - PBXCustomer info

Parameter Type Description
customer Object Customer information.
id Integer Customer ID.
company String Company name.
contactName String Contact name.
email String Email address.
position String Job title.
cellphone String Cell phone number.
telephone String Telephone number.
fax String Fax number.
address String Company address.
remark String Remark.
externalId String External ID.

Examples

Request example

GET /api/v1/pbx/instances/859 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
{
    "status": "Success",
    "instance": {
        "active": true,
        "activeCalls": 0,
        "callRecording": true,
        "concurrentCall": 10,
        "createTime": "2019-02-20 16:58:33",
        "creator": {
            "email": "cecilia@yeastar.com",
            "id": 1
        },
        "customers": [
            {
                "company": "te st9ib6",
                "contactName": "te st",
                "email": "test9ib6@yeastar.com",
                "id": 2
            }
        ],
        "domain": "channel.isbc.yeastarcloud.com",
        "extension": 10,
        "id": 859,
        "initialStartUpTime": "2019-02-20 16:58:35",
        "linkusChat": false,
        "name": "sps1",
        "recordingCapacity": 500,
        "sn": "3682804SWHO3PWN4",
        "status": "stopped",
        "type": "commercial",
        "upgradeInPBX": true,
        "version": "81.8.0.50"
    }
}