查询组列表
更新时间: 2025/03/05 16:07:31接口说明
用于查询用户组列表。
接口URL
https://sdk.cloudroom.com/CLOUDMEETING-API/v1/face/group/query/list
请求方式:POST
请求参数
Header
| 名称 | 参数值 | 是否必传 | 说明 |
|---|---|---|---|
| Content-Type | application/json | 是 | 请求头 |
Body
接口参数
| 参数名称 | 类型 | 是否必传 | 说明 |
|---|---|---|---|
| PageNumber | Integer | 否 | 当前页码(默认为1,超出范围使用默认值) |
| PageSize | Integer | 否 | 每页数量(默认为20,最大值为50,超出范围使用默认值) |
返回参数
| 名称 | 类型 | 说明 |
|---|---|---|
| RspCode | Integer | 错误码 |
| RspDesc | String | 描述 |
| Data | Map | 数据集合 |
Data 参数说明:
| 名称 | 类型 | 说明 |
|---|---|---|
| GroupCount | Integer | 该AppId内的组数量 |
| GroupIdList | List | 组列表id |
示例
请求示例
curl -X POST https://sdk.cloudroom.com/CLOUDMEETING-API/v1/face/group/query/list \
-H "Content-Type: application/json" \
-d '{
"RequestId": "2d95a5fe-a384-5dea-0d84-db153b10ee0f",
"CompID": "1",
"SecretKey": "a7febff6a21c36fb50150f88c95ef641",
"AppId": "demo",
"PageNumber":1,
"PageSize":20
}'
返回示例
{
"RspCode":0,
"RspDesc":"请求成功",
"Data":{
"GroupCount":2,
"GroupIdList":[
"test_group_1",
"test_group_2"
]
}
}
错误码
上述接口在 Body 中返回请求的错误码,详情请参见 错误码