接口描述
描述:
用户能取消自己创建的会议和自己所管理企业下的会议,且该会议是一个有效的会议。
如果不是会议创建者或者企业管理员或者无效会议号将会返回错误。
企业 secret 鉴权用户可取消任何该用户企业下创建的有效会议,OAuth2.0 鉴权用户只能取消通过 OAuth2.0 鉴权创建的有效会议。
当您想实时监测会议取消状况时,您可以通过订阅 会议取消 的事件,接收事件通知。
请求方式:POST
接口请求域名:
https://api.meeting.qq.com/v1/meetings/{meetingId}/cancel
输入参数
参数名称 | 必选 | 参数类型 | 参数描述 |
meetingId | 是 | String | 会议的唯一 ID。 |
userid | 是 | String | 调用 API 的用户 ID(企业内部请使用企业唯一用户标识;OAuth2.0 鉴权用户请使用 openId)。 企业唯一用户标识说明: 1:企业对接 SSO 时使用的员工唯一标识 ID。 2:企业调用创建用户接口时传递的 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 | 原因代码,可为用户自定义。 |
meeting_type | 否 | Integer | 会议类型,默认值为0。 0:普通会议 1:周期性会议 |
sub_meeting_id | 否 | String | 周期性子会议 ID,如果不传,则会取消该系列的周期性会议。 |
reason_detail | 否 | String | 详细取消原因描述。 |
输出参数
错误码列表
状态码 | 错误码 | 错误描述 |
400 | 500014 | 账号无权限。 |
400 | 190004 | 参数非法,请对照接口文档检查您的参数。 |
403 | 9042 | 无权限进行该操作,建议检查操作者身份或资源归属。 |
500 | 9002 | 非法请求。 |
500 | 9007 | MEETING CANCLED。 |
500 | 13602 | 已开始的会议不能取消。 |
500 | 13603 | 会议已结束。 |
500 | 13000 | 缓存查询会议信息失败。 |
500 | 960000 | 网络错误,请稍后重试。 |
500 | 190001 | 存在未注册的用户。 |
500 | 9003 | MEETING NOT EXIST。 |
500 | 202007 | 成员不在会中。 |
500 | 190310 | 每分钟总接口调用次数超过限制。 |
代码示例
输入示例
POST https://api.meeting.qq.com/v1/meetings/7567173273889276131/cancel{"userid" : "test1","instanceid" : 1,"reason_code" : 1,"reason_detail" : "取消会议"}
输出示例
取消成功,返回 Body 为空。