人脸识别

查询用户列表

更新时间: 2025/03/05 16:07:31

接口说明

查询指定用户组中的用户列表。

接口URL

https://sdk.cloudroom.com/CLOUDMEETING-API/v1/face/user/query/list

请求方式:POST

请求参数

Header

名称 参数值 是否必传 说明
Content-Type application/json 是 请求头

Body

公共参数

接口参数

参数名称 类型 是否必传 说明
GroupId String 是 用户组id
PageNumber Integer 否 当前页码(默认为1,超出范围使用默认值)
PageSize Integer 否 每页数量(默认为20,最大值为50,超出范围使用默认值)

返回参数

名称 类型 说明
RspCode Integer 错误码
RspDesc String 描述
Data Map 数据集合

Data 参数说明:

名称 类型 说明
PersonCount Integer 该组的用户数量
PersonList List 用户信息列表
- PersonId String 用户id
- PersonInfo String 用户资料
- CreateTime Long 创建时间,Unix时间戳

示例

请求示例

curl -X POST https://sdk.cloudroom.com/CLOUDMEETING-API/v1/face/user/query/list \
-H "Content-Type: application/json" \
-d '{
    "RequestId": "2d95a5fe-a384-5dea-0d84-db153b10ee0f",
    "CompID": "1",
    "SecretKey": "a7febff6a21c36fb50150f88c95ef641",
    "AppId": "demo",
	 "GroupId":"test_group_1",
	 "PageNumber":1,
	 "PageSize":20
}'

返回示例

{
    "RspCode":0,
    "RspDesc":"请求成功",
    "Data":{
        "PersonCount":1,
        "PersonList":[
            {
                "PersonId":"1001",
                "PersonInfo":"utest01",
                "CreateTime": 1730456554
            }
        ]
    }
}

错误码

上述接口在 Body 中返回请求的错误码,详情请参见 错误码