接口描述
描述:结束一个进行中的会议。
只有会议创建者、主持人、联席主持人可以结束会议,且该会议是一个有效的进行中会议。
结束周期性会议需要传入主会议 ID。
企业 secret 鉴权用户可结束任何该企业用户创建的进行中的会议,OAuth 2.0鉴权用户只能结束通过 OAuth 2.0鉴权创建的进行中的会议。
当您想实时监测会议结束状况时,您可以通过订阅 会议结束 的事件,接收事件通知。
此接口暂不支持 MRA 设备作为被操作者的情况。
结束会议不会释放 Rooms,如需释放请调用 释放会议室(Rooms)接口。
请求方式:POST
接口请求域名:
https://api.meeting.qq.com/v1/meetings/{meeting_id}/dismiss
输入参数
参数名称 | 必选 | 参数类型 | 参数描述 |
meeting_id | 是 | String | 会议的唯一 ID。 |
operator_id | 是 | String | 操作者 ID,根据 operator_id_type 的值,使用不同的类型。 |
operator_id_type | 是 | Integer | 操作者 ID 的类型: 1:userid 2:openid 4:ms_open_id |
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: 回收会议号,不可重新入会 说明:周期性会议如果还有子会议,需设置为不回收会议号,否则会导致后续子会议无法正常进行。 此字段对快速会议不生效,快速会议会强制收回会议号。 |
输出参数
错误码列表
状态码 | 错误码 | 错误描述 |
500 | 41 | 网络错误,请稍后重试。 |
500 | 9042 | 无权限进行该操作,建议检查操作者身份或资源归属。 |
500 | 13001 | 缓存设置会议信息失败。 |
400 | 190301 | 请求重放错误,请求头里的 X-TC-Timestamp 和 X-TC-Nonce 每次请求时需重新生成,不能使用和过去五分钟内相同的 timestamp 和 nonce。 |
500 | 960000 | 网络错误,请稍后重试。 |
500 | 190308 | 查询 tinyID 失败。 |
500 | 190310 | 每分钟总接口调用次数超过限制。 |
500 | 9003 | 会议信息不存在。 |
400 | 190457 | 会议不存在, 请核对 meeting_id。 |
400 | 190004 | 参数非法,请对照接口文档检查您的参数。 |
500 | 190001 | 存在未注册的用户。 |
500 | 13651 | 会议已取消。 |
500 | 13000 | 缓存查询会议信息失败。 |
500 | 13652 | 非强制解散会议时有成员在会议中。 |
500 | 9108 | 用户 sdkID 认证失败。 |
500 | 190456 | 查询用户不存在,请检查该用户是否注册。 |
示例
输入示例
POST https://api.meeting.qq.com/v1/meetings/7567173273889276131/dismiss{"operator_id":"KM4Ss4Th09ogUw1JiK","operator_id_type":1,"instanceid" : 1,"reason_code" : 3,"reason_detail" : "结束会议","retrieve_code":1,"force_dismiss_meeting":1}
输出示例
取消成功,返回 Body 为空。