Query the Assigned Trunks of a Cloud PBX

Query the assigned shared trunks of a specific Cloud PBX.

Request URL

GET {base_url}/dm/open_api/v1/shared_trunk/pbx/used

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String Pass the access token in the header.

Format: Bearer {access_token}.
Query parameters
Parameter Required Type Description
cloudPbxId Yes Long The ID of the specific Cloud PBX.
Note: You can query the Cloud PBX ID using Query All the Cloud PBXs.

Response parameters

Parameter Type Description
data Object <Details> 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
sharedTrunkIds Array <Integer> The IDs of the shared trunk assigned to the PBX.

Example

Request example

GET /dm/open_api/v1/shared_trunk/pbx/used?cloudPbxId=4769 HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer ******

Response example

HTTP/1.1 200 OK
{
    "data": {
        "sharedTrunkIds": [
            6680
        ]
    },
    "requestId": "12e9bd8936d05ca4dd67c85d0e4796f1",
    "status": "Success",
    "time": 1747032632
}