Query the System Capacity

HTTP method and endpoint

GET /api/v1/system/capacities

Response parameters

System capacity information

Parameter Type Description
total Object<Capacity> Total capacity.
used Object<Capacity> Used capacity.
available Object<Capacity> Available capacity.

Detailed information of capacity

Parameter Type Description
recordingCapacity Integer Call Recording capacity.
concurrentCall Integer Concurrent Call capacity.
extension Integer Extension capacity.
instance Integer PBX capacity.

Examples

Request example

GET /api/v1/system/capacities HTTP/1.1
Host: ympapi.yeastarcloud.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJsb2dpbl9uYW1lIjoiY2VjaWxpYUB5ZWFzdGFyLmNvbSIsInNjb3BlIjpbInRydXN0Il0sImV4cCI6MTU0NzAyMjQ0MSwiYXV0aG9yaXRpZXMiOlsiUk9MRV9hZG1pbiJdLCJqdGkiOiJjODVlM2MwZS02N2IzLTRmYjYtYWM4NS05MDg0ZmM1M2EyMjUiLCJjbGllbnRfaWQiOiI5Nzg5OTNmMDk2YzQ0MTFmYTljYzgwZWUyZTYyZjFmMiJ9.dA7NcHMtrnuQp5QPyuOfdRDarC8-a2ypTP1OMyDN2cI
Cache-Control: no-cache

Response example

HTTP/1.1 200 OK
{
    "status": "Success",
    "capacities": {
        "available": {
            "concurrentCall": 603,
            "extension": 586,
            "instance": 31,
            "recordingCapacity": 1749
        },
        "total": {
            "concurrentCall": 805,
            "extension": 830,
            "instance": 100,
            "recordingCapacity": 2100
        },
        "used": {
            "concurrentCall": 202,
            "extension": 244,
            "instance": 69,
            "recordingCapacity": 351
        }
    }
}