Query PBX capacity

Query the capacity of PBX, including the number of extensions and concurrent calls.

Request URL

GET {base_url}/{api_path}/system/capacity?access_token={access_token}

Request parameters

No request parameters. Send the request URL directly to query PBX capacity.

Response parameters

Table 1.
Parameter Type Description
errcode Integer Returned error code.
  • 0: Succeed.
  • Non-zero value: Failed.
Note: You can check the error code and error message in Error Code and Error Message.
errmsg String Returned message.
  • SUCCESS: Succeed.
  • FAILURE: Failed.
data Object<Device_Capacity> The PBX capacity.
Table 2.
Parameter Type Description
extension_capacity Integer The maximum number of extensions.
extension_used Integer The number of extensions used.
cc_capacity Integer The maximum number of concurrent calls.
cc_used Integer The number of concurrent calls used.


Request example

GET /openapi/v1.0/system/capacity?access_token=tmZCgLHfy9a2qpFthxdGfa0Xr6v3D63C 

Response example

HTTP/1.1 200 OK
    "errcode": 0,
    "errmsg": "SUCCESS",
    "data": {
        "extension_capacity": 50,
        "extension_used": 10,
        "cc_capacity": 25,
        "cc_used": 0