目录
兼容性:企业微信 4.0 开始支持
创建会议
创建临时会议并调起进行中的会议室页面.
// 创建会议
ww.startMeeting()
本接口必须使用应用身份进行注册
应用必须具有会议使用权限,参考配置可使用会议的应用
用户需要在应用可见范围内
属性 | 类型 | 必填 | 说明 | |
---|---|---|---|---|
success | Function | 否 | 成功回调 | |
fail | Function | 否 | 失败回调 | |
cancel | Function | 否 | 取消回调 | |
complete | Function | 否 | 完成回调 |
Promise<Object>
属性 | 类型 | 必填 | 说明 | |
---|---|---|---|---|
meetingId | string | 是 | 会议 ID |
errMsg | 说明 |
---|---|
startMeeting:ok | 执行成功 |
startMeeting:fail no permission | 应用签名校验失败,或成员不在应用的可见范围内,或应用未开启会议使用权限 |
startMeeting:fail user not in allow list | 会议发起人必须在应用可见范围 |
startMeeting:fail invalid parameter | 参数不合法 |
startMeeting:fail api freq out of limit | 创建会议超过频率限制。单应用每天不可创建超过1w个会议 |
兼容性:企业微信 3.1.0 开始支持
进入会议
通过传入 meetingId 进入已有会议。
ww.startMeeting({
meetingId: 'MEETINGID'
})
本接口必须使用应用身份进行注册
应用必须具有会议使用权限,参考配置可使用会议的应用
用户需要在应用可见范围内
属性 | 类型 | 必填 | 说明 | |
---|---|---|---|---|
meetingId | string | 否 | 会议 ID,可通过创建预约会议或通过调用ww.startMeeting()获取 为空的情况下创建快速会议 | |
success | Function | 否 | 成功回调 | |
fail | Function | 否 | 失败回调 | |
cancel | Function | 否 | 取消回调 | |
complete | Function | 否 | 完成回调 |
Promise<Object>
属性 | 类型 | 必填 | 说明 | |
---|---|---|---|---|
meetingId | string | 是 | 会议 ID |
errMsg | 说明 |
---|---|
startMeeting:ok | 执行成功 |
startMeeting:fail no permission | 应用签名校验失败,或成员不在应用的可见范围内,或应用未开启会议使用权限 |
startMeeting:fail user not in allow list | 会议发起人必须在应用可见范围 |
startMeeting:fail not allow to cross corp | 不可跨企业使用会议ID |
startMeeting:fail invalid meeting id | 不合法的会议ID |
startMeeting:fail not allow to cross app | 不可跨应用使用会议ID |
startMeeting:fail invalid parameter | 参数不合法 |
调用示例
wx.invoke('startMeeting', {
"meetingId": "MEETINGID",
}, function(res) {
if (res.err_msg == "startMeeting:ok") {
}
});