接口描述
描述:设置或撤销会议中的参会者联席主持人身份,目前支持 MRA 设备作为被操作者的情况。企业 secret 鉴权用户可管理任何该企业用户创建的有效会议,OAuth 2.0鉴权用户只能管理通过 OAuth 2.0鉴权创建的有效会议。
说明:
操作者必须是会议的创建者或主持人才可以设置。
调用该接口需要权限项 : MANAGE_MEETING 查看和管理您的会议。
请求方式:PUT
接口请求域名:
https://api.meeting.qq.com/v1/real-control/meetings/{meeting_id}/cohosts
输入参数
请求路径参数
参数名称 | 必选 | 参数类型 | 参数描述 |
meeting_id | 是 | String | 会议 ID,周期性会议传总会议 ID。 |
请求 body
参数名称 | 必选 | 参数类型 | 参数描述 |
operator_id | 否 | String | 操作者 ID。 1:operator_id 必须与 operator_id_type 配合使用。根据 operator_id_type 的值,operator_id 代表不同类型。 2:接口输入参数如果需要传用户 ID 时,operator_id 和 uuid 不可以同时为空,两个参数如果都传了以 operator_id 为准。 3:如果 operator_id_type=2,operator_id 必须和公共参数的 openid 一致。 |
operator_id_type | 否 | Integer | 操作者 ID 的类型: 1:userid 2:openid 4:ms_open_id |
uuid | 否 | String | 操作者用户唯一身份 ID,仅支持创建者或主持人,且只适用于单场会议。即将废弃,推荐使用 operator_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 说明:使用 ms_open_id 进行调用时,仅支持以上1-9的设备类型。 |
action | 是 | bool | 具体设置动作: true:设置联席主持人 false:撤销联席主持人 |
user | 是 | User 对象 | 被操作用户对象信息。 |
User 对象
参数名称 | 必选 | 参数类型 | 参数描述 |
to_operator_id | 否 | String | 被操作者 ID,根据 to_operator_id_type 的值,使用不同的类型。 |
to_operator_id_type | 否 | Integer | 被操作者 ID 的类型: 4:ms_open_id。 |
uuid | 否 | String | 被操作者用户唯一身份 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 说明:请与被操作者的设备类型保持一致,否则不生效。使用 ms_open_id 进行调用时,仅支持以上1-9的设备类型。 |
输出参数
错误码列表
状态码 | 错误码 | 错误描述 |
500 | 10 | 参数错误,具体字段错误原因,详细见 message 字段。 |
500 | 190308 | 查询 tinyID 失败。 |
500 | 190001 | 存在未注册的用户。 |
400 | 190004 | 参数非法,请对照接口文档检查您的参数。 |
400 | 9042 | 无权限进行该操作,建议检查操作者身份或资源归属。 |
400 | 190455 | 非会议中不允许操作。 |
500 | 9042 | 没有权限。 |
400 | 500008 | 获取多端信息失败。 |
500 | 13009 | 缓存设置会议成员列表信息失败。 |
500 | 9042 | 无权限进行该操作,建议检查操作者身份或资源归属。 |
500 | 41 | 网络错误,请稍后重试。 |
500 | 190456 | 查询用户不存在,请检查该用户是否注册。 |
500 | 13008 | 缓存查询会议成员列表信息失败。 |
400 | 202007 | 成员不在会中。 |
示例
输入示例
PUThttps://api.meeting.qq.com//v1/real-control/meetings/1242152152161/cohosts{"operator_id": "afagsagwags","operator_id_type": 4,"instanceid": 4,"action":true,"user":{"to_operator_id":"agaqwwgdkkddd","to_operator_id_type": 4,"instanceid": 2}}