# 【小程序直播】成员管理接口
名称 | 功能说明 |
---|---|
设置成员角色 | 调用此接口设置小程序直播成员的管理员、运营者和主播角色 |
解除成员角色 | 调用此接口移除小程序直播成员的管理员、运营者和主播角色 |
查询成员列表 | 调用此接口查询小程序直播成员列表 |
# 一、简介
直播成员管理接口,是小程序直播提供给开发者对直播成员进行批量管理的接口能力。
开发者可以通过接口设置、查询、移除直播成员的角色,不同角色拥有不同的管理权限,具体请查看小程序直播成员管理说明。
# 二、接口文档
# 1.设置成员角色
# 接口说明:
调用此接口设置小程序直播成员的管理员、运营者和主播角色
# 调用频率
调用额度:10000次/一天
# 请求方式
POST
# 请求URL
https://api.weixin.qq.com/wxaapi/broadcast/role/addrole?access_token=
# 请求参数示例: json
{
username: 'test_1', // 微信号
role: 1, // 取值[1-管理员,2-主播,3-运营者],设置超级管理员将无效
}
# 请求参数含义
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
username | String | 是 | 用户的微信号 |
role | Number | 是 | 设置用户的角色 |
# 正确返回示例
{
"errcode": 0,
}
# 返回参数含义
参数 | 说明 |
---|---|
codeurl | 如果主播未实名认证,需要先前往“小程序直播”小程序进行实名验证, 小程序二维码链接:https://res.wx.qq.com/op_res/9rSix1dhHfK4rR049JL0PHJ7TpOvkuZ3mE0z7Ou_Etvjf-w1J_jVX0rZqeStLfwh |
# 2.解除成员角色
# 接口说明:
调用此接口移除小程序直播成员的管理员、运营者和主播角色
# 调用频率
调用额度:10000次/一天
# 请求方式
POST
# 请求URL
https://api.weixin.qq.com/wxaapi/broadcast/role/deleterole?access_token=
# 请求参数示例: json
{
username: 'test_1', // 微信号
role: 1, // 取值[1-管理员,2-主播,3-运营者],删除超级管理员将无效
}
# 请求参数含义
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
username | String | 是 | 用户的微信号 |
role | Number | 是 | 删除用户的角色 |
# 正确返回示例
{
"errcode": 0,
}
# 3.查询成员列表
# 接口说明:
调用此接口查询小程序直播成员列表
# 调用频率
调用额度:10000次/一天
# 请求方式
GET
# 请求URL
https://api.weixin.qq.com/wxaapi/broadcast/role/getrolelist?access_token=
# URL query 参数
{
role: 1, // 取值 [-1-所有成员, 0-超级管理员,1-管理员,2-主播,3-运营者]
offset: 0, // 起始偏移量
limit: 10, // 查询个数,最大30,默认10
keyword: 'test_1' // 搜索的微信号,不传返回全部
}
# 请求参数含义
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
role | Number | 否 | 查询的用户角色,取值 [-1-所有成员, 0-超级管理员,1-管理员,2-主播,3-运营者],默认-1 |
offset | Number | 否 | 起始偏移量, 默认0 |
limit | Number | 否 | 查询个数,最大30,默认10 |
keyword | String | 否 | 搜索的微信号或昵称,不传则返回全部 |
# 正确返回示例
{
"errcode": 0,
"total" : 1, // 总个数
"list": [{
"headingimg": "http://wx.qlogo.cn/mmhead/Q3auHgzwzM5jBhFwrHoeoaxTlhP9YzlVica7wu6lZLnGreKAj7CVicA/0", // 头像
"nickname": "test1", // 昵称
"openid": "o7esq5MvImF2SEm7OHYohausj2o",
"roleList": [2, 3], // 具有的身份,[0-超级管理员,1-管理员,2-主播,3-运营者]
"updateTimestamp": "1600340080", // 更新时间
"username": "o0****0o", //脱敏微信号
}]
}
# 返回参数含义
参数 | 说明 |
---|---|
total | 总个数 |
list | 角色列表 |
headingimg | 微信用户头像url |
nickname | 微信用户昵称 |
openid | openid |
roleList | 具有的身份,[0-超级管理员,1-管理员,2-主播,3-运营者] |
updateTimestamp | 更新时间 |
username | 微信号 |
# 附录:错误码
-1:系统错误
400001: 微信号不合规
400002: 微信号需要实名认证,仅设置主播角色时可能出现
400003: 添加角色达到上限(管理员10个,运营者500个,主播500个)
400004: 重复添加角色
400005: 主播角色删除失败,该主播存在未开播的直播间