Query All the PBXs

Query the information of all 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

Request parameters

Parameter Importance Type Description
pageNumber Optional Integer Defines which page is displayed.
pageSize Optional Integer Defines how many records per page.
sort Optional String Defines the sorting field.
  • id: Displays the PBXs by the id order.
order Optional String Defines the sorting order.
  • asc: Displays the PBXs by the ascending order.
  • desc: Displays the PBXs by the descending order.

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.

Response parameters - Page info

Parameter Type Description
list Array<PBXInstanceInfo> PBX instances list.
total Integer The total number of PBXs.
pageSize Integer How many records per page.

Examples

Request example

  • Display the page 1.
  • Display 2 PBXs per page.
  • Display the PBXs by the ascending order.
GET /api/v1/pbx/instances?pageSize=2&amp;pageNumber=1&amp;sort=id&amp;order=asc HTTP/1.1
Host: ympapi.yeastarcloud.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJsb2dpbl9uYW1lIjoiY2VjaWxpYUB5ZWFzdGFyLmNvbSIsInNjb3BlIjpbInRydXN0Il0sImV4cCI6MTU0NzAwNTQwNSwiYXV0aG9yaXRpZXMiOlsiUk9MRV9hZG1pbiJdLCJqdGkiOiJjMTFlNzhlZC1hODE4LTQ0MzAtYTI0NS1jNTQ0Njc1Zjg2MjIiLCJjbGllbnRfaWQiOiI5Nzg5OTNmMDk2YzQ0MTFmYTljYzgwZWUyZTYyZjFmMiJ9.SPMzZLQ0FCIn0YHx99_D4nNKV6uYz5fy564N9s_D36o
Cache-Control: no-cache

Response example

HTTP/1.1 200 OK
{
    "status": "Success",
    "instances": {
        "list": [
            {
                "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": 1112,
                "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"
            },
            {
                "active": true,
                "activeCalls": 0,
                "callRecording": true,
                "concurrentCall": 10,
                "createTime": "2019-03-14 09:00:38",
                "creator": {
                    "email": "cecilia@yeastar.com",
                    "id": 1
                },
                "customers": [
                    {
                        "company": "te st9ib6",
                        "contactName": "te st",
                        "email": "test9ib6@yeastar.com",
                        "id": 2
                    }
                ],
                "domain": "autop17.isbc.yeastarcloud.com",
                "extension": 20,
                "id": 1129,
                "initialStartUpTime": "2019-03-14 09:00:41",
                "linkusChat": true,
                "name": "autop17",
                "recordingCapacity": 500,
                "sn": "3682804SWHO3WCBT",
                "status": "stopped",
                "type": "commercial",
                "upgradeInPBX": true,
                "version": "81.8.0.50"
            }
        ],
        "pageSize": 2,
        "total": 44
    }
}