Appearance
获取直播间白名单用户
请求路径
- 请求方式:
POST - 请求头:
Content-Type:application/json - 接口地址:
https://gateway.nuoyunapi.com/Api/RoomRounds/getRoomUserWhitelist/2.0.0 - 频率限制:
10秒1000次
特别说明
- 仅返回未删除且未过期的白名单记录(永久有效或未到期)
- 若直播间不存在或不属于当前账号,返回「直播间不存在」
- 可通过 提交白名单 接口添加白名单用户
请求参数
| 参数 | 必选 | 类型 | 描述 |
|---|---|---|---|
| room_id | 是 | integer | 直播间ID |
| page | 是 | integer | 第几页(最小值1) |
| page_size | 是 | integer | 一页显示多少(最小值1,最大值500) |
请求示例
json
{
"room_id": 10000001,
"page": 1,
"page_size": 10
}响应参数
| 参数 | 必选 | 类型 | 描述 |
|---|---|---|---|
| code | 是 | integer | 状态码:200-成功,400-失败 |
| msg | 是 | string | 提示信息 |
| data | 是 | object | 白名单数据 |
data 参数结构
| 参数 | 必选 | 类型 | 描述 |
|---|---|---|---|
| total | 是 | integer | 白名单总量 |
| list | 是 | array | 白名单列表 |
list 参数结构
| 参数 | 必选 | 类型 | 描述 |
|---|---|---|---|
| wechat_user_space_id | 是 | integer | 用户ID;若手机号尚未关联用户,可能为 0 |
| name | 是 | string | 白名单姓名 |
| mobile | 是 | string | 白名单手机号 |
响应示例
json
{
"code": 200,
"msg": "Success",
"data": {
"total": 2,
"list": [
{
"wechat_user_space_id": 123456,
"name": "用户昵称",
"mobile": "13333333333"
},
{
"wechat_user_space_id": 0,
"name": "测试用户",
"mobile": "13999999999"
}
]
}
}