目录
兼容性:企业微信 3.1.0 开始支持
创建直播并调起直播页面
ww.startLiving({
liveType: 1,
theme: '新同学培训',
})
本接口必须使用应用身份进行注册
应用需具有直播使用权限,见配置可使用直播的应用
创建直播的场景下,用户必须在应用可见范围内
属性 | 类型 | 必填 | 说明 | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
liveType | number | 否 | 直播类型 Mac 端只支持通用直播 | ||||||||||||||||
| |||||||||||||||||||
theme | string | 否 | 直播主题 使用限制 最多支持 20 个 UTF-8 字符 | ||||||||||||||||
success | Function | 否 | 成功回调 | ||||||||||||||||
fail | Function | 否 | 失败回调 | ||||||||||||||||
cancel | Function | 否 | 取消回调 | ||||||||||||||||
complete | Function | 否 | 完成回调 |
Promise<Object>
属性 | 类型 | 必填 | 说明 | |
---|---|---|---|---|
livingId | string | 是 | 直播 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个直播 |
兼容性:企业微信 3.1.0 开始支持
调起直播预约详情或进行中的直播间页面。
ww.startLiving({
livingId: 'LIVINGID'
})
本接口必须使用应用身份进行注册
应用需具有直播使用权限,见配置可使用直播的应用
属性 | 类型 | 必填 | 说明 | |
---|---|---|---|---|
livingId | string | 是 | 直播 ID | |
success | Function | 否 | 成功回调 | |
fail | Function | 否 | 失败回调 | |
cancel | Function | 否 | 取消回调 | |
complete | Function | 否 | 完成回调 |
Promise<Object>
属性 | 类型 | 必填 | 说明 | |
---|---|---|---|---|
livingId | string | 是 | 直播 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 | 超过最大的班级个数 |
wx.invoke('startLiving', {
"livingId": "LIVINGID",
}, function(res) {
if (res.err_msg == "startLiving:ok") {
livingId = res.livingId;
}
});