接口描述
描述:获取用户个人会议号配置信息。仅企业下 secret 鉴权用户可获取该用户的 pmi 配置。目前暂不支持 OAuth 2.0鉴权访问。
请求方式:GET
自建应用权限点:查看企业会议详细信息,管理企业会议详细信息。
接口请求域名:
https://api.meeting.qq.com/v1/pmi-meetings/pmi-config?userid={userid}&instanceid={instanceid}
输入参数
参数名称 | 必选 | 参数类型 | 参数描述 |
userid | 是 | 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 |
输出参数
参数名称 | 参数类型 | 参数描述 |
pmi_code | String | 个人会议号。 |
pmi_password | String | 个人会议号密码,经过 base64 编码处理。 |
pmi_name | String | 个人会议室名称。 |
allow_in_waiting_room | Boolean | 是否开启等候室。 |
only_enterprise_user_allowed | Boolean | 是否仅企业内部成员可入会。 true:允许 false:不允许 |
allow_in_before_host | Boolean | 是否允许成员在主持人前入会。 true:允许 false:不允许 |
watermark | Boolean | 是否开启会议水印。 true:开启 false:关闭 |
water_mark_type | Integer | 水印样式。 0:单排 1:多排 |
disable_note_capture | Boolean | 是否禁止笔记截屏。 true:禁止 false:不禁止 |
mute_enable_type_join | Integer | 成员入会静音设置。 0:关闭 1:开启 2:超过6人后自动开启 |
hosts | String[] | 指定主持人 userid 列表。 |
allow_multi_device | Boolean | 是否允许成员多端入会。 |
错误码列表
状态码 | 错误码 | 错误描述 |
400 | 190001 | 存在未注册的用户。 |
400 | 190004 | 参数非法,请对照接口文档检查您的参数。 |
400 | 550000 | 请求超时,请稍后再试。 |
400 | 500122 | 该接口的操作者不在应用可用范围内。 |
400 | 500014 | 账号无权限。 |
示例
输入示例
GET https://api.meeting.qq.com/v1/pmi-meetings/pmi-config?userid=tester&instanceid=1
输出示例
{"pmi_code": "xxxxxxx","pmi_password": "dGhpcyBpcyBhIGV4YW1wbGU=","pmi_name":"xxx的个人会议室","allow_in_waiting_room":true,"only_enterprise_user_allowed":false,"allow_in_before_host":true,"watermark":true,"water_mark_type":0,"disable_note_capture":false,"mute_enable_type_join":0,"hosts":["user1","user2"],"allow_multi_device":false}