Skip to content

获取直播间白名单用户

请求路径

  • 请求方式:POST
  • 请求头:Content-Type:application/json
  • 接口地址:https://gateway.nuoyunapi.com/Api/RoomRounds/getRoomUserWhitelist/2.0.0
  • 频率限制:10秒1000次

特别说明

  • 仅返回未删除且未过期的白名单记录(永久有效或未到期)
  • 若直播间不存在或不属于当前账号,返回「直播间不存在」
  • 可通过 提交白名单 接口添加白名单用户

请求参数

参数必选类型描述
room_idinteger直播间ID
pageinteger第几页(最小值1)
page_sizeinteger一页显示多少(最小值1,最大值500)

请求示例

json
{
    "room_id": 10000001,
    "page": 1,
    "page_size": 10
}

响应参数

参数必选类型描述
codeinteger状态码:200-成功,400-失败
msgstring提示信息
dataobject白名单数据

data 参数结构

参数必选类型描述
totalinteger白名单总量
listarray白名单列表

list 参数结构

参数必选类型描述
wechat_user_space_idinteger用户ID;若手机号尚未关联用户,可能为 0
namestring白名单姓名
mobilestring白名单手机号

响应示例

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"
            }
        ]
    }
}