结束会议

接口描述

描述:结束一个进行中的会议。用户只能结束自己创建的会议,且该会议是一个在进行中有效的会议。如果非会议创建者或者未开始的会议将会返回错误,周期性会议需要传入主会议 ID。企业 secret 鉴权用户可结束任何该企业该用户创建的进行中的会议;OAuth2.0 鉴权用户只能结束通过 OAuth2.0 鉴权创建的进行中的会议。
当您想实时监测会议结束状况时,您可以通过订阅 会议结束 的事件,接收事件通知。
调用方式:POST
接口请求域名

https://api.meeting.qq.com/v1/meetings/{meetingId}/dismiss

输入参数

HTTP 请求头公共参数请参见签名验证章节的 公共参数说明

参数名称 必选 参数类型 参数描述
meetingId String 会议的唯一 ID。
userid String 调用 API 的用户 ID(企业内部请使用企业唯一用户标识;OAuth2.0 鉴权用户请使用 openId)。 <br>企业唯一用户标识说明:<br>1. 企业对接 SSO 时使用的员工唯一标识 ID;<br>2. 企业调用创建用户接口时传递的 userid 参数。
instanceid Integer 用户的终端设备类型:<br>1:PC <br>2:Mac<br>3:Android <br>4:iOS <br>5:Web <br>6:iPad <br>7:Android Pad <br>8:小程序
reason_code Integer 原因代码,可为用户自定义。
reason_detail String 详细取消原因描述。
force_dismiss_meeting Integer 是否强制结束会议,默认值为1。<br>0:不强制结束会议,会议中有参会者,则无法强制结束会议。<br>1 :强制结束会议,会议中有参会者,也会强制结束会议。
retrieve_code Integer 是否回收会议号,默认值为0。<br>0:不回收会议号,可以重新入会。<br>1: 回收会议号,不可重新入会。

输出参数

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

示例

输入示例

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

输出示例

结束成功,返回 Body 为空。

下载 腾讯会议API结束会议-腾讯会议.pdf
文章内容是否对您有帮助?
有帮助
无帮助