查询所有分组

查询所有分组的信息。

请求 URL

GET {base_url}/dm/open_api/v1/groups

请求参数

请求头
参数 是否必填 类型 说明
Authorization 是 String 在请求头中传递访问 Token。

格式：Bearer {access_token}。
查询参数
参数 是否必填 类型 说明
pageNumber 否 Integer 定义显示第几个页面。
  • 默认值：1
pageSize 否 Integer 定义每页显示几项查询结果。
  • 默认值：10
  • 最大值：50
fqGroupName 否 String 使用分组名称进行模糊搜索。

响应参数

参数 类型 说明
data Object<Details> 详情。
requestId String 请求 ID，作为该请求的唯一标识，用于快速定位请求。
status String 请求结果。
  • Success：请求成功。
  • Failed：请求失败。
time Long 请求响应的时间。
注： YCM API 响应返回的是时间戳，如有需要，你可以将时间戳转换成具体的日期和时间。详细操作方法，请参见 将时间戳转换为日期和时间。
Details
参数 类型 说明
pageSize Integer 每页显示几项查询结果。
pageNumber Integer 当前显示第几页。
total Integer 分组总数量。
list Array<Group_Info> 分组信息列表。
Group_Info
参数 类型 说明
id Integer 分组 ID。
groupName String 分组名称。
deviceNumber Integer 分组中的设备总数量，包括 P 系列云 PBX 以及远程连接的设备。

示例

请求示例

GET /dm/open_api/v1/groups HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer ******

响应示例

HTTP/1.1 200 OK
{
    "data": {
        "pageSize": 3,
        "pageNumber": 1,
        "total": 3,
        "list": [
            {
                "id": 20038,
                "groupName": "Group3",
                "deviceNumber": 3
            },
            {
                "id": 20037,
                "groupName": "Group2",
                "deviceNumber": 2
            },
            {
                "id": 20036,
                "groupName": "Group1",
                "deviceNumber": 6
            }
        ]
    },
    "requestId": "fd7674934b2053d933c5bdbd227756aa",
    "status": "Success",
    "time": 1775721086
}