接口描述
描述:修改用户个人会议号配置信息。仅企业下 secret 鉴权用户可获取该用户的 pmi 配置。目前暂不支持 OAuth 2.0鉴权访问。
请求方式:PUT
自建应用权限点:管理企业会议详细信息。
接口请求域名:
https://api.meeting.qq.com/v1/pmi-meetings/pmi-config
输入参数
参数名称 | 必选 | 参数类型 | 参数描述 |
operator_id | 是 | String | 用户的 ID(企业内部请使用企业唯一用户标识)。 |
operator_id_type | 是 | Integer | 操作者 ID 类型。 1: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 |
pmi_name | 否 | String | 个人会议室名称,最大支持18个汉字或36个英文字母。 |
enable_password | 否 | Boolean | 是否需要密码。 true:需要 false:不需要 |
pmi_password | 否 | String | 入会密码,当 enable_password 为 true 时,此参数生效。 |
auto_in_waiting_room | 否 | Boolean | 是否开启等候室。 true:开启 false:不开启 |
watermark | 否 | Boolean | 是否开启会议水印。 true:开启 false:不开启 |
water_mark_type | 否 | Integer | 水印样式。当 watermark 为 true 时,此参数才生效。 0:单排 1:多排 |
disable_note_capture | 否 | Boolean | 禁止笔记截屏。当 watermark 为 true 时,此参数才生效。 true:禁止 false:不禁止 |
only_enterprise_user_allowed | 否 | Boolean | 是否仅企业内部成员可入会。 true:仅企业内成员 false:非仅企业内成员 |
allow_in_before_host | 否 | Boolean | 是否允许成员在主持人进会前加入会议。 true:允许 false:不允许 |
mute_enable_type_join | 否 | Integer | 成员入会静音选项。 0:关闭 1:开启 2:超过6人开启 |
hosts | 否 | String[] | 指定主持人 userid 列表。 |
allow_multi_device | 否 | Boolean | 是否允许成员多端入会。 |
输出参数
错误码列表
状态码 | 错误码 | 错误描述 |
400 | 550000 | 请求超时,请稍后再试。 |
400 | 500122 | 该接的口操作者不在应用可用范围内。 |
400 | 190001 | 存在未注册的用户。 |
400 | 190004 | 参数非法,请对照接口文档检查您的参数。 |
示例
输入示例
PUT https://api.meeting.qq.com/v1/pmi-meetings/pmi-config{"operator_id":"user1","operator_id_type":1,"instanceid":1,"auto_in_waiting_room":true}
输出示例
更新用户成功,返回 Body 为空。