OAuth(开放授权)是一个开放标准,允许用户授权应用访问其存储在另外的服务提供者上的信息,而不需要将用户名和密码提供给第三方应用或分享数据的所有内容。对于用户相关的 API(例如:获取用户信息、会议信息、云录制信息等),为了保护用户数据的安全和隐私,应用访问用户数据前都需要显式的向用户征求授权。您创建的应用可采用 OAuth2.0 标准协议来进行用户身份验证和获取用户授权,其认证流程简单、安全。
开发人员使用 OAuth 授权后获取用户数据权限,OAuth 应用既可以由账户管理员作为账户级应用进行安装使用,也可以由用户作为个人的应用进行安装使用。
创建应用
- 登录 腾讯会议 开放平台,单击创建应用。
- 选择“应用类型”,填写应用名称、应用图标和简短描述,选择是否推送到应用市场,完成应用创建。
第三方应用类型
第三方应用支持两种应用类型的选择:账户级应用和用户级应用。
- 账户级应用必须由账户管理员安装和使用,可以管理该账户下的所有用户数据、会议数据、录制数据等内容的 API 调用范围。例如:打造一个内部仪表盘或者统一管理公司其他用户的会议创建等行为的应用,则可以创建账户级应用。
- 用户级应用可以由各个用户安装使用的应用,可以管理单个用户内容的 API 调用范围,因此需要每个用户进行授权。例如:打造一个需要增加个人日历的扩展或允许用户自行创建会议等行为的应用,则可以创建用户级应用。
应用凭证
- 创建应用后,将自动生成应用凭证(应用 ID 和客户密匙)。
- OAuth 回调地址:请提供由 HTTPS 保护的有效 URL,用户在成功授权您的应用后将被重定向到该 URL。
- 白名单:添加所有将腾讯会议列入白名单的唯一 URL 地址作为 OAuth 的有效重定向 URL。开启白名单后,仅白名单中的请求来源可以正常调用 API 接口,保证应用重定向的安全。请填写完整的 URL 地址,包含路径和查询参数(例如:
https://[subdomain.]domain.com/path/to/oauth/callback
)或不包含路径和查询参数的基础 URL 地址(例如:https://[subdomain.]domain.com
),多个白名单则请换行填写。
基础信息
您需要提供有关您创建的应用的一些基本信息,包括应用类目、简短描述、详细描述、预览内容、应用联系人信息等。
权限范围
权限范围定义应用可以调用的 API 接口范围,以便获取用户相关指定资源。您可单击右上角添加权限范围,进行权限范围的选择。
账户级应用权限范围说明
权限范围 | 可调用接口 |
---|---|
查看所有用户的会议 | 通过会议 ID 查询、通过会议 Code 查询、获取参会成员列表、查询用户的会议列表、查询用户已结束会议列表、获取账户级已结束会议列表、获取账户级即将召开的会议列表、获取账户级实时会议列表 |
查看和管理所有用户的会议 | 通过会议 ID 查询、通过会议 Code 查询、获取参会成员列表、查询用户的会议列表、查询用户已结束会议列表、获取账户级已结束会议列表、获取账户级即将召开的会议列表、获取账户级实时会议列表、创建会议、取消会议、结束会议、修改会议 |
查看所有用户的录制 | 查询会议录制列表、查询会议录制地址、查询单个录制地址、获取账户级会议录制列表、查询录制文件访问数据、获取会议录制操作明细 |
查看和管理所有用户的录制 | 查询会议录制列表、查询会议录制地址、查询单个录制地址、获取账户级会议录制列表、查询录制文件访问数据、获取会议录制操作明细、删除会议录制、删除单个录制文件、修改会议录制共享设置 |
查看所有用户的直播 | 获取直播回看地址 |
查看和管理所有用户的直播 | 获取直播回看地址、修改直播配置、删除直播回看文件 |
查看所有用户信息 | 获取用户详情、获取用户列表、获取账户级全量用户列表、获取账户级角色列表、获取账户级角色用户列表 |
查看和管理所有用户信息 | 获取用户详情、获取用户列表、获取账户级全量用户列表、获取账户级角色列表、获取账户级角色用户列表、创建用户、更新用户、删除用户 |
用户级应用权限范围说明
权限范围 | 可调用接口 |
---|---|
查看您的会议 | 通过会议 ID 查询、通过会议 Code 查询、获取参会成员列表、查询用户的会议列表、查询用户已结束会议列表 |
查看和管理您的会议 | 通过会议 ID 查询、通过会议 Code 查询、获取参会成员列表、查询用户的会议列表、查询用户已结束会议列表、创建会议、取消会议、结束会议、修改会议 |
查看您的录制 | 查询会议录制列表、查询会议录制地址、查询单个录制地址、查询录制文件访问数据、获取会议录制操作明细 |
查看和管理您的录制 | 查询会议录制列表、查询会议录制地址、查询单个录制地址、查询录制文件访问数据、获取会议录制操作明细、删除会议录制、删除单个录制文件、修改会议录制共享设置 |
查看您的直播 | 获取直播回看地址 |
查看和管理您的直播 | 获取直播回看地址、修改直播配置、删除直播回看文件 |
查看您的用户信息 | 获取用户详情、获取用户列表 |
查看和管理您的用户信息 | 获取用户详情、获取用户列表、创建用户、更新用户、删除用户 |
事件订阅
事件订阅为可选功能,允许应用在触发某些特定事件或触发某些特定操作时向您的 Webhook 地址返回消息通知。在很多情况下,事件订阅可以代替重复 API 调用的需求。例如:您希望统计某个会议的参会成员进退会记录,则您可以订阅“用户入会”事件和“用户退会”事件,当用户进入会议或者离开会议均会发送通知到您的通知地址。
如果您的应用要订阅事件,仅需要打开“事件订阅”,单击右上角添加事件,填写消息通知名称、事件通知 URL 地址,选择您需要订阅的事件类型即可。
激活应用
在激活应用时,我们会进行应用必填内容的判断,需按照要求把必填项都填写完成,才能完成应用的最终创建。如内容全部填写完成,您将能够在平台或者工具中集成腾讯会议的服务和 API。