企业内部开发
小程序
基础
连接微信
办公
JS-SDK
基础
连接微信
办公
企业内部开发
客户端API
JS-SDK
直播
进入直播
进入直播
最后更新:2025/04/11

目录

  • ww.startLiving(params)
  • 功能描述
  • 使用限制
  • 参数说明
  • params: Object
  • 返回说明
  • 使用说明
  • 错误信息
  • 旧版jweixin调用
  • 示例代码
  • ww.startLiving([params])

    兼容性:企业微信 3.1.0 开始支持

    功能描述

    创建直播并调起直播页面

    ww.startLiving({
     liveType: 1,
     theme: '新同学培训',
    })

    使用限制

    • 本接口必须使用应用身份进行注册

    • 应用需具有直播使用权限,见配置可使用直播的应用

    • 创建直播的场景下,用户必须在应用可见范围内

    参数说明

    params: Object

    属性类型必填说明
    liveTypenumber

    直播类型

    Mac 端只支持通用直播

    合法值说明
    0

    通用直播

    1

    企业培训

    2

    大班课

    3

    小班课

    themestring

    直播主题

    使用限制

    最多支持 20 个 UTF-8 字符

    successFunction

    成功回调

    failFunction

    失败回调

    cancelFunction

    取消回调

    completeFunction

    完成回调

    返回说明

    Promise<Object>

    属性类型必填说明
    livingIdstring

    直播 ID

    错误信息

    errMsg说明
    startLiving:ok执行成功
    startLiving:fail no permission应用签名失败,或应用无直播权限
    startLiving:fail user not in allow list直播发起人必须在应用可见范围内
    startLiving:fail invalid parameter参数不合法
    startLiving:fail unsupported liveType不支持的直播类型。部分类型仅对特殊行业放开
    startLiving:fail api freq out of limit创建直播超过频率限制。单应用每天不可创建超过1w个直播

    ww.startLiving(params)

    兼容性:企业微信 3.1.0 开始支持

    功能描述

    调起直播预约详情或进行中的直播间页面。

    ww.startLiving({
      livingId: 'LIVINGID'
    })

    使用限制

    参数说明

    params: Object

    属性类型必填说明
    livingIdstring

    直播 ID

    successFunction

    成功回调

    failFunction

    失败回调

    cancelFunction

    取消回调

    completeFunction

    完成回调

    返回说明

    Promise<Object>

    属性类型必填说明
    livingIdstring

    直播 ID

    错误信息

    errMsg说明
    startLiving:ok执行成功
    startLiving:fail no permission应用签名失败,或应用无直播权限
    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 invalid department id不合法的班级ID
    startLiving:fail exceed department id list size超过最大的班级个数

    旧版jweixin调用

    示例代码

    wx.invoke('startLiving', {
    		"livingId": "LIVINGID",
    	}, function(res) {
    		if (res.err_msg == "startLiving:ok") {
                livingId = res.livingId;
            }
        });
    上一篇创建立即直播
    下一篇观看直播回放
      本节内容
    服务端API
    基础
    连接微信
    办公
    会议
    会议统计管理
    客户端API
    小程序
    基础
    连接微信
    办公
    JS-SDK
    基础
    连接微信
    办公
    更新日志
    联系我们