# 查询直播间小助手

调试诊断

接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南

接口英文名:getAssistantList

该接口用于查询直播间小助手

# 1. 调用方式

# HTTPS 调用

GET https://api.weixin.qq.com/wxaapi/broadcast/room/getassistantlist?access_token=ACCESS_TOKEN

# 云调用

  • 调用方法:liveBroadcast.getAssistantList

  • 出入参和 HTTPS 调用相同,调用方式可查看 云调用 说明文档

# 第三方调用

  • 本接口支持第三方平台代商家调用。

  • 该接口所属的权限集 id 为:52

  • 服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。

# 2. 请求参数

# 查询参数 Query String parameters

参数名类型必填示例说明
access_tokenstringACCESS_TOKEN接口调用凭证,可使用 access_tokenauthorizer_access_token

# 请求体 Request Payload

参数名类型必填说明
roomIdnumber房间ID

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
listobjarray小助手列表
countnumber小助手个数
maxCountnumber小助手最大个数
errcodenumber错误码
errmsgstring错误描述

# Res.list(Array) Object Payload

小助手列表

参数名类型说明
timestampnumber修改时间
headimgstring头像
nicknamestring昵称
aliasstring微信号
openidstringopenid

# 4. 注意事项

调用额度:10000次/一天

# 5. 代码示例

请求示例

{
  "roomId": 6491
}

返回示例

{
  "list": [
    {
      "timestamp": 1601199369,
      "headimg": "http://wx.qlogo.cn/mmhead/USXYj7XUar4OmtmhpYR3IS1X54ibLgjcNjEXp3ne5C6I/0",
      "nickname": "nickname",
      "alias": "wechat",
      "openid": "o7esq5K76p47O-ien1kuaVAuSsvw"
    }
  ],
  "count": 1,
  "maxCount": 10,
  "errcode": 0
}

# 6. 错误码

以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。

错误码错误描述解决方案
-1system error系统繁忙,此时请开发者稍候再试

# 7. 适用范围

本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请已实际调用情况为准。