Query Concurrent Call Information for a Shared Trunk

Query the concurrent call information of a specific shared trunk, including total limit, remaining capacity, and the allocation details to Cloud PBXs and subordinate users.

Request URL

GET {base_url}/dm/open_api/v1/shared_trunk/{trunkId}/cc-info

Request parameters

Path parameter
Parameter Required Type Description
trunkId Yes Integer The ID of the shared trunk.
Note: You can query the trunk ID using Query Available Shared Trunks.
Headers
Parameter Required Type Description
Authorization Yes String Pass the access token in the header.

Format: Bearer {access_token}.

Response parameters

Parameter Type Description
data Object <Detailss> The detailed information.
requestId String The unique ID of the request, which can be used to quickly locate the request.
status String Request result:
  • Success
  • Failed
time Long The response time.
Note: The YCM API response returns a timestamp, you can convert the timestamp to detailed date and time as needed. For more information, see Convert Timestamp to Local Date and Time.
Details
Parameter Type Description
trunkId Integer The ID of the shared trunk.
trunkName String The name of the shared trunk.
maxConcurrentCalls Integer The maximum number of concurrent call allowed for the shared trunk.
Note: A returned value of 0 indicates no limit.
pbxAllocatedTotal Integer The total number of maximum concurrent calls allocated to Cloud PBXs associated with the shared trunk.
aclAllocatedTotal Integer The total number of maximum concurrent calls allocated to subordinate users who have access to the shared trunk.
remainingAvailable Integer The remaining available concurrent calls of the shared trunk.
pbxAllocations Array <PBX_Allocation> The details of the concurrent calls allocated to Cloud PBXs.
aclAllocations Array <TrunkAccess_Allocation> The details of the concurrent calls allocated to subordinate users.
PBX_Allocation
Parameter Type Description
pbxId Integer The ID of the Cloud PBX.
pbxName String The name of the Cloud PBX.
allocatedMaxConcurrentCalls Integer The maximum concurrent call assigned to the Cloud PBX.
Note: If this parameter is not returned, it indicates no limit, and the PBX can use the trunk's maximum concurrent calls.
TrunkAccess_Allocation
Parameter Type Description
userName String The name of the subordinate user.
allocatedMaxConcurrentCalls Integer The maximum concurrent call assigned to the subordinate user.
Note: If this parameter is not returned, it indicates no limit, and the user can use the trunk's maximum concurrent calls.

Example

Request example

Query the concurrent call details of a shared trunk (ID: 40062).

GET /dm/open_api/v1/shared_trunk/40062/cc-info HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer ******

Response example

{
    "data": {
        "trunkId": 40062,
        "trunkName": "88_3M1I6R",
        "maxConcurrentCalls": 50,
        "pbxAllocatedTotal": 10,
        "aclAllocatedTotal": 20,
        "remainingAvailable": 20,
        "pbxAllocations": [
            {
                "pbxId": 1863,
                "pbxName": "PCE1",
                "allocatedMaxConcurrentCalls": 10
            }
        ],
        "aclAllocations": [
            {
               
                "userName": "User1"
            },
            {
                
                "userName": "User2"
            },
            {
               
                "userName": "User3",
                "allocatedMaxConcurrentCalls": 20
            }
        ]
    },
    "requestId": "DkReF9xw",
    "status": "Success",
    "time": 1781678962
}