此接口用于主播打开预约的直播进行开播操作,以及观众进入直播间观看;若直播还未开始,则观众进入直播详情页,可预约观看直播。创建预约直播接口参考该文档。
接口参数 Object object
参数 | 必须 | 类型 | 说明 |
---|---|---|---|
livingId | 是 | string | 直播ID,通过创建预约直播和创建立即直播获取 |
success | 否 | Function | 接口调用成功的回调函数 |
fail | 否 | Function | 接口调用失败的回调函数 |
complete | 否 | Function | 接口调用结束的回调函数(调用成功、失败都会执行) |
回调函数参数 Object res
参数 | 类型 | 说明 |
---|---|---|
res.errMsg | string | 错误信息,如果调用成功返回 ${apiName}:ok |
wx.qy.startLiving({
"livingId": "LIVINGID",
fail: function(res) {
console.log(res)
},
});
res.errMsg | 说明 |
---|---|
qy.startLiving:ok | 执行成功 |
qy.startLiving:fail no session or expired | 没有调用 wx.qy.login,或者 session_key 已过期 |
qy.startLiving:fail no permission | 应用需具有直播权限 |
qy.startLiving:fail user not in allow list | 当前成员不在应用可见范围 |
qy.startLiving:fail invalid living id | 不合法的直播ID |
qy.startLiving:fail not allow to cross corp | 不可跨企业使用直播ID |
qy.startLiving:fail not allow to cross app | 不可跨应用使用直播ID |
qy.startLiving:fail invalid parameter | 参数不合法 |
qy.startLiving:fail unsupported liveType | 不支持的直播类型。部分类型仅对特殊行业放开 |
qy.startLiving:fail api freq out of limit | 创建直播超过频率限制。单应用每天不可创建超过1w个直播 |