接口描述
描述:
绑定扩展应用到某一个会议。
企业 secret 鉴权用户可查询该用户所属企业下的会议。
OAuth2.0 鉴权用户只能查询该企业下 OAuth2.0 应用的会议。
请求方法:GET
接口请求域名:
https://api.meeting.qq.com/v1/app/toolkit
输入参数
HTTP 请求头公共参数参考签名验证章节里的公共参数说明。
参数名称 | 必选 | 参数类型 | 参数描述 |
userid | 是 | String | 调用方用于标示用户的唯一 ID(企业内部请使用企业唯一用户标识;OAuth2.0 鉴权用户请使用 openId)企业唯一用户标识说明: 1:企业对接 SSO 时使用的员工唯一标识 ID。 2:企业调用创建用户接口时传递的 userid 参数。 |
instanceid | 是 | Integer | 用户的终端设备类型: 1:PC 2:Mac 3:Android 4:iOS 5:Web 6:iPad 7:Android Pad 8:小程序 创建会议时 userid 对应的设备类型不影响入会时使用的设备类型,缺省可填1。 |
meeting_id | 是 | String | 会议号。 |
输出参数
参数名称 | 参数类型 | 参数描述 |
tool_list | Tool 对象数组 | 扩展应用列表。 |
auto_open_sdkid | String | 自动打开应用的 ID。 |
toolbar_sdkid | String | 外显在会中工具栏的应用 ID。 |
Tool 对象
参数名称 | 参数类型 | 参数描述 |
tool_appid | String | 扩展应用的企业 appid。 |
tool_sdkid | String | 扩展应用 ID。 |
visible_type | Integer | 扩展应用可见类型。 0:所有人可见 1:本企业可见 2:指定用户可见,默认为0 |
visible_list | Visible 对象数组 | 可见用户列表(默认会议创建者可见),visible_type=2 时该字段才有效。 |
is_shield_creator | Boolean | 应用默认会议创建者可见,若应用的可见用户需要屏蔽会议创建者,则需要设置此字段,visible_type=2 时该字段才有效。 true:屏蔽会议创建者,但如果可见用户列表设置了会议创建者,此字段设置失效,则应用对会议创建者仍可见。 false:默认配置,会议创建者可见。 |
unique_code | String | 调用方业务相关字段,最大128个字符。 |
enable_customer_data | Integer | 应用是否可以查询 customerData。 0:否,默认为0 1:是 |
enable_add_robot | Integer | 应用是否可以拉取机器人。 0:否,默认为0 1:是 |
Visible 对象
参数名称 | 参数类型 | 参数描述 |
visible_appid | String | 对哪个企业的用户可见(非 OAuth2.0 授权方式此字段必填)。 |
visible_userid | String | 可见用户 userid,若不填则对该企业下所有用户可见。 |
visible_openid | String | 可见用户 openid,OAuth2.0 鉴权用户请用此字段(visible_userid 和 visible_openid 二者选一,同时存在时以 visible_openid 为准)。 |
错误码列表
状态码 | 错误码 | 错误描述 |
400 | 190004 | 参数非法,请对照接口文档检查您的参数。 |
500 | 20009 | 未查找到相应的会议信息,请检查会议是否存在。 |
500 | 9042 | 无权限进行该操作,建议检查操作者身份或资源归属。 |
500 | 190001 | 存在未注册的用户。 |
示例
输入示例
GET https://api.meeting.qq.com/v1/app/toolkit?userid=decemberhe&instanceid=2&meeting_id=4121559629134687883
输出示例
{"tool_list": [{"tool_appid": "1400143280","tool_sdkid": "16154405887","visible_type": 1}, {"tool_appid": "1400143280","tool_sdkid": "16158968179","visible_type": 2,"visible_list": [{"visible_appid": "1400143280","visible_userid": "leonxsun"}, {"visible_appid": "1400143280","visible_userid": "decemberhe"}, {"visible_appid": "200007857","visible_userid": "meeting4525887","visible_openid": "SbsftL0Nl801q7zu2GBL2ldMZPZQ"}]}],"auto_open_sdkid":"16268493751","toolbar_sdkid":"16268493751"}