第三方应用开发 客户端API JS-SDK 效率工具 创建立即直播
创建立即直播

此接口将创建临时直播并调起进行中的直播间页面

 

权限说明

  • 此接口仅在企业微信3.1.0及以后版本支持,微信端不支持(微信开发者工具也不支持)
  • 必须先成功调用agentConfig,否则调用时会报“no permission”错误
  • 应用需具有直播使用权限,见配置可使用直播的应用
  • 如若创建临时直播,直播发起人必须在应用可见范围

调用示例

wx.invoke('startLiving', {
		"liveType": 1,
		"theme": "新同学培训",
	}, function(res) {
		if (res.err_msg == "startLiving:ok") {
            livingId = res.livingId;
        }
    });

入参说明

参数必须类型说明
liveTypeuint32直播类型,0-通用直播;1-企业培训;2-大班课;3-小班课。
Mac端只支持通用直播
themestring直播主题。最多20个UTF-8字符

 

返回说明

参数类型说明
resObj返回信息
res.err_msgstring执行结果。"startLiving:ok" 表示执行成功,否则表示报错信息
res.livingIdstring直播ID

错误列表

res.err_msg说明
startLiving:ok执行成功
startLiving:fail no permission1. 必须先成功调用agentConfig
2. 应用需具有直播权限
startLiving:fail user not in allow list直播发起人必须在应用可见范围
startLiving:fail invalid living id不合法的直播ID
startLiving:fail not allow to cross corp不可跨企业使用直播ID
startLiving:fail not allow to cross app不可跨应用使用直播ID
startLiving:fail invalid parameter参数不合法
startLiving:fail unsupported liveType不支持的直播类型。部分类型仅对特殊行业放开
startLiving:fail api freq out of limit创建直播超过频率限制。单应用每天不可创建超过1w个直播
上一篇
进入微信客服消息界面
下一篇
进入直播