小程序直播 /直播间管理 /获取直播间分享二维码
获取直播间分享二维码
接口应在服务器端调用,详细说明参见服务端API。
本接口支持云调用。需开发者工具版本 >=
1.02.1904090
(最新稳定版下载),wx-server-sdk
>=0.4.0
接口说明
接口英文名
getSharedCode
功能描述
该接口用于获取直播间分享二维码。
调用方式
HTTPS 调用
GET https://api.weixin.qq.com/wxaapi/broadcast/room/getsharedcode?access_token=ACCESS_TOKEN
云调用
- 出入参和 HTTPS 调用相同,调用方式可查看云调用说明文档
- 接口方法为: openapi.liveBroadcast.getSharedCode
第三方调用
- 调用方式以及出入参和 HTTPS 相同,仅是调用的 token 不同
- 该接口所属的权限集 id 为:52
- 服务商获得其中之一权限集授权后,可通过使用authorizer_access_token代商家进行调用
请求参数含义
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
roomId | Number | 是 | 房间ID |
params | String | 否 | 自定义参数 |
返回参数含义
参数 | 类型 | 说明 |
---|---|---|
errcode | number | 返回码 |
cdnUrl | string | 分享二维码cdn url |
pagePath | string | 分享路径 |
posterUrl | string | 分享海报 url |
调用示例
示例说明: HTTPS请求示例
请求数据示例
// URL query 参数
{
"roomId" : 6209,
"params" : encodeURIComponent(JSON.stringify(custom_params))
}
返回数据示例
{
"cdnUrl": "http://mmbiz.qpic.cn/mmbiz_jpg/FVribAGdErI2jhO1hbzVDH1E5LW7VQ9D1SIvTLFmyYwkIUucJqE72icgAj6NYw92kbJRNV0zwnGZWaO0Y8T0vqlg/0", // 分享二维码
"pagePath": "plugin-private://wx2b03c6e691cd7370/pages/live-player-plugin?room_id=6209", // 分享路径
"posterUrl": "http://mmbiz.qpic.cn/mmbiz_jpg/dlFudV139LtQn96YNHSGtVfcUkUwQaYeR5OiaJ6bPr7OZxy3yhIK3icjxop0QeRBiaDPiaxuzENtCj15zFIM8sh7ag/0", // 分享海报
"errcode": 0
}
错误码
错误码 | 错误码取值 | 解决方案 |
---|---|---|
40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误,或者 access_token 无效。请开发者认真比对 AppSecret 的正确性,或查看是否正在为恰当的公众号调用接口 |
300022 | 此房间号不存在 | |
300023 | 房间状态 拦截(当前房间状态不允许此操作) |