接口描述
描述:根据会议录制 ID 修改共享等配置,支持修改共享权限、共享密码、共享有效期等信息,支持 OAuth2.0 鉴权调用。
所需权限点为:管理会议录制(MANAGE_VIDEO)。
请求方式:PUT
接口请求域名:
https://api.meeting.qq.com/v1/records/settings/{meeting_record_id}
输入参数
请求路径参数
参数名称 | 必选 | 参数类型 | 参数描述 |
meeting_record_id | 是 | String | 会议录制 ID,列表查询接口返回的 meeting_record_id。 |
请求 body 参数
参数名称 | 必选 | 参数类型 | 参数描述 |
meeting_id | 否 | String | 会议 ID,当针对上传类型的录制文件操作时,可不传 meeting_id。 |
operator_id | 否 | String | 操作者 ID。operator_id 必须与 operator_id_type 配合使用。根据 operator_id_type 的值,operator_id 代表不同类型。 说明:userid 字段和 operator_id 字段二者必填一项。若两者都填,以 operator_id 字段为准。 |
operator_id_type | 否 | Integer | 操作者 ID 的类型: 3:rooms_id 说明:当前仅支持 rooms_id。如操作者为企业内 userid 或 openId,请使用 userid 字段。 |
userid | 否 | String | 操作者 ID,仅会议创建者、企业超级管理员或有企业录制管理权限的用户可调用。调用方用于标示用户的唯一 ID(企业内部请使用企业唯一用户标识;OAuth2.0 鉴权用户请使用 openId)。 企业唯一用户标识说明: 1:企业对接 SSO 时使用的员工唯一标识 ID。 2:企业调用创建用户接口时传递的 userid 参数。 |
sharing_config | 否 | SharingConfig 对象 | 共享配置信息。 |
SharingConfig 对象
参数名称 | 必选 | 参数类型 | 参数描述 |
enable_sharing | 否 | Boolean | 共享开关,是否开启共享,默认为 true。 true:开启 false:未开启 说明: 未开启时不允许设置以下参数。 修改为 false 关闭共享后,之前设置的共享设置将不保存。 |
sharing_auth_type | 否 | Integer | 注意:即将废弃,请使用share_scope 和其它字段组合设置。 共享权限类型。 0:仅允许登录用户查看 1:仅企业用户成员可查看 2:仅参会成员可查看 3:全部成员可查看 4:通过权限审批的成员可查看 5:获取微信特邀链接的成员可查看 |
share_scope | 否 | Integer | 访问范围。 0:所有人 1:同企业 |
enable_approve | 否 | Boolean | 是否需要审批,与密码二选一,如果为 false 且设置密码则按密码生效设置。
true:需要审批
false:不需要审批 |
enable_password | 否 | Boolean | 是否开启密码,默认为 true。 true:开启 |
password | 否 | String | 共享密码,密码必须为4~8位字母或数字。默认随机生成。 说明:当 enable_password = true 时,必传;当 enable_password = false 时,不可传。 |
enable_sharing_expire | 否 | Boolean | 是否开启共享链接有效期,默认为 false。 true:开启 |
sharing_expire | 否 | Number | 共享链接有效期,unix 时间戳(单位毫秒),默认为空。 说明:当 enable_sharing_expire = true 时,必传;当 enable_sharing_expire = false 时,不可传。 |
allow_download | 否 | Boolean | 是否允许下载,默认为 false。 true:允许下载 |
allow_view_transcripts | 否 | Boolean | 是否允许查看录制转写,默认为 true。 true:允许 false:不允许 |
输出参数
错误码列表
状态码 | 错误码 | 错误描述 |
400 | 190004 | 参数非法,请对照接口文档检查您的参数。 |
500 | 403 | 没有资源操作权限。 |
500 | 190001 | 存在未注册的用户。 |
500 | 4044 | 会议录制未完成。 |
500 | 400 | 未根据会议录制 ID 找到会议录制。 |
示例
输入示例
PUT https://api.meeting.qq.com/v1/records/settings/1335844011111111111{"userid": "test","meeting_id": "3423746843611111111","sharing_config": {"enable_sharing": true,"sharing_auth_type": 2,"enable_password":true,"password":"12asABcs","enable_sharing_expire": true,"sharing_expire": 1640908800000,"allow_download": true}}
输出示例
删除成功,返回 Body 为空。