查询所有下级用户

查询所有下级用户的基本信息。

请求 URL

GET {base_url}/dm/open_api/v1/user_info/subordinates

请求参数

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

格式：Bearer {access_token}。
查询参数
参数 是否必填 类型 说明
pageNumber 否 Integer 定义显示第几个页面。
  • 默认值：1
pageSize 否 Integer 定义每页显示几项查询结果。
  • 默认值：10
  • 最大值：50
query 否 Integer 输入用于模糊查询的关键字。

响应参数

参数 类型 说明
data Object <Details> 详情。
requestId String 请求 ID，作为该请求的唯一标识，用于快速定位请求。
status String 请求结果。
  • Success：请求成功。
  • Failed：请求失败。
time Long 请求响应的时间。
注： YCM API 响应返回的是时间戳，如有需要，你可以将时间戳转换成具体的日期和时间。详细操作方法，请参见 将时间戳转换为日期和时间。
Details
参数 类型 说明
pageSize Integer 每页显示几项查询结果。
pageNumber Integer 当前显示第几页。
total Integer 下级用户的总数。
list Array <User_Info> 下级用户的基础信息列表。
User_Info
参数 类型 说明
userId Long 用户 ID。
userName String 用户名。
userEmail String 用户邮箱。

示例

请求示例

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

响应示例

HTTP/1.1 200 OK
{
    "data": {
        "pageSize": 10,
        "pageNumber": 1,
        "total": 3,
        "list": [
            {
                "userId": 405427,
                "userName": "Charlotte",
                "userEmail": "Charlotte@yeastar.com"
            },
            {
                "userId": 359054,
                "userName": "Sophia",
                "userEmail": "huqy@yeastar.com"
            },
            {
                "userId": 318902,
                "userName": "Malinda",
                "userEmail": "malinda@yeastar.com"
            }
        ]
    },
    "requestId": "878d9869ba18c7c0fb6cc7b3d031e4e5",
    "status": "Success",
    "time": 1766552544
}