Query All Trunk Access Permissions

Query trunk access permissions granted to subordinate users.

Request URL

GET {base_url}/dm/open_api/v1/trunk_acl/page

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
pageSize No Integer Define how many records per page.
  • Default value: 10
  • Maximum value: 50
pageNumber No Integer Define which page is displayed.
  • Default value: 1
query No String Enter a keyword for fuzzy search.

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
pageSize Integer How many records are displayed per page.
pageNumber Integer Which page is displayed.
total Integer The total number of trunk access permissions.
list Array <Trunk_Access_Permission> The list of trunk access permissions granted to subordinate users.
Trunk_Access_Permission
Parameter Type Description
userId Long The ID of the subordinate user.
userName String User name.
userEmail String User email.
trunkList Array<Trunk_Info> The list of assigned shared trunks.

Trunk_Info

Parameter Type Description
trunkId Integer The ID of the shared trunk.
trunkName String The name of the shared trunk.

Example

Request example

Query the list of trunk access permissions:
  • Display 3 records per page.
  • Display Page 1.
GET /dm/open_api/v1/trunk_acl/page?pageNumber=1&pageSize=3 HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer ******

Response example

HTTP/1.1 200 OK
{
    "data": {
        "pageSize": 3,
        "pageNumber": 1,
        "total": 7,
        "list": [
            {
                "userId": 1143,
                "userName": "Sophia",
                "userEmail": "sophia@yeastar.com",
                "trunkList": [
                    {
                        "trunkId": 5091,
                        "trunkName": "hbl_ZG184D"
                    }
                ]
            },
            {
                "userId": 1145,
                "userName": "Malinda",
                "userEmail": "malinda@yeastar.com",
                "trunkList": [
                    {
                        "trunkId": 5229,
                        "trunkName": "gd_597RXM_S5H46P"
                    }
                ]
            },
            {
                "userId": 1150,
                "userName": "Charlotte",
                "userEmail": "charlotte@yeastar.com",
                "trunkList": [
                    {
                        "trunkId": 5092,
                        "trunkName": "port_KY540C"
                    },
                    {
                        "trunkId": 5097,
                        "trunkName": "dxy_LU6N33"
                    },
                    {
                        "trunkId": 5112,
                        "trunkName": "dxy_9TOO33"
                    }
                ]
            }
        ]
    },
    "requestId": "wBcbvXO8",
    "status": "Success",
    "time": 1766381383
}