# 设置成员角色
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:getRoleListdw
调用此接口设置小程序直播成员的管理员、运营者和主播角色。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/wxaapi/broadcast/role/addrole?access_token=ACCESS_TOKEN
# 云调用
调用方法:liveBroadcast.addRole
出入参和 HTTPS 调用相同,调用方式可查看 云调用 说明文档
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:52
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String parameters
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token、authorizer_access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| username | string | 是 | 用户的微信号 |
| role | number | 是 | 设置用户的角色 |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| codeurl | string | 如果主播未实名认证,需要先前往“小程序直播”小程序进行实名验证 |
# 4. 注意事项
本接口无特殊注意事项
# 5. 代码示例
请求示例
{ username: 'test_1', // 微信号 role: 1, // 取值[1-管理员,2-主播,3-运营者],设置超级管理员将无效 }
返回示例
{
"errcode": 0,
"errmsg": "ok"
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| 40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误,或者 access_token 无效。请开发者认真比对 AppSecret 的正确性,或查看是否正在为恰当的公众号调用接口 |
| 200002 | 参数错误 | |
| 400001 | 微信号不合规 | |
| 400002 | 微信号需要实名认证,仅设置主播角色时可能出现 | |
| 400003 | 添加角色达到上限(管理员10个,运营者500个,主播500个) | |
| 400004 | 重复添加角色 |
# 7. 适用范围
本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请已实际调用情况为准。