企业内部开发 客户端API 小程序 效率工具 进入直播
进入直播

此接口用于主播打开预约的直播进行开播操作,以及观众进入直播间观看;若直播还未开始,则观众进入直播详情页,可预约观看直播。创建预约直播接口参考该文档。

权限说明

  • 此接口仅在企业微信3.1.0及以后版本支持
  • 必须先调用过wx.qy.login,且session_key未过期,开发者可调用checkSession 检查当前登录态
  • 当前成员必须在应用的可见范围
  • 应用需具有直播使用权限,见配置可使用直播的应用

参数说明

接口参数 Object object

参数必须类型说明
livingIdstring直播ID,通过创建预约直播创建立即直播获取
successFunction接口调用成功的回调函数
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

 

回调函数参数 Object res

参数类型说明
res.errMsgstring错误信息,如果调用成功返回 ${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个直播
上一篇
创建立即直播
下一篇
观看直播回放