有奖捉虫:云通信与企业服务文档专题,速来> HOT

接口描述

描述:结束一个进行中的会议。
只有会议创建者、主持人、联席主持人可以结束会议,且该会议是一个有效的进行中会议。
结束周期性会议需要传入主会议 ID。
企业 secret 鉴权用户可结束任何该企业用户创建的进行中的会议,OAuth 2.0鉴权用户只能结束通过 OAuth 2.0鉴权创建的进行中的会议。
当您想实时监测会议结束状况时,您可以通过订阅 会议结束 的事件,接收事件通知。
此接口暂不支持 MRA 设备作为被操作者的情况。
结束会议不会释放 Rooms,如需释放请调用 释放会议室(Rooms)接口。
请求方式:POST
接口请求域名
https://api.meeting.qq.com/v1/meetings/{meetingId}/dismiss

输入参数

HTTP 请求头公共参数请参见签名验证章节的 公共参数说明
参数名称
必选
参数类型
参数描述
meetingId
String
会议的唯一 ID。
operator_id
String
操作者 ID,根据 operator_id_type 的值,使用不同的类型。
operator_id_type
Integer
操作者 ID 的类型:
1:userid
2:openid
4:ms_open_id
userid
String
调用方用于标示用户的唯一 ID(企业内部请使用企业唯一用户标识;OAuth 2.0鉴权用户请使用 openId)。
企业唯一用户标识说明:企业对接 SSO 时使用的员工唯一标识 ID,企业调用创建用户接口时传递的 userid 参数。
instanceid
Integer
用户的终端设备类型:
0:PSTN
1:PC
2:Mac
3:Android
4:iOS
5:Web
6:iPad
7:Android Pad
8:小程序
9:voip、sip 设备
10:Linux
20:Rooms for Touch Windows
21:Rooms for Touch MacOS
22:Rooms for Touch Android
30:Controller for Touch Windows
32:Controller for Touch Android
33:Controller for Touch iOS
reason_code
Integer
原因代码,可为用户自定义。
reason_detail
String
详细取消原因描述。
force_dismiss_meeting
Integer
是否强制结束会议,默认值为1:
0:不强制结束会议,会议中有参会者,则无法强制结束会议
1 :强制结束会议,会议中有参会者,也会强制结束会议
retrieve_code
Integer
是否回收会议号,默认值为0:
0:不回收会议号,可以重新入会
1: 回收会议号,不可重新入会
说明:周期性会议如果还有子会议,需设置为不回收会议号,否则会导致后续子会议无法正常进行。
此字段对快速会议不生效,快速会议会强制收回会议号。

输出参数

无输出参数,成功返回空消息体,失败返回 错误码 和错误信息。

示例

输入示例

POST https://api.meeting.qq.com/v1/meetings/7567173273889276131/dismiss
{
"userid" : "test1",
"instanceid" : 1,
"reason_code" : 3,
"reason_detail" : "结束会议",
"retrieve_code":1,
"force_dismiss_meeting":1
}

输出示例

取消成功,返回 Body 为空。