第三方应用鉴权(OAuth2.0)
腾讯会议 OAuth2.0 鉴权访问,需要先通过 OAuth2.0 鉴权成功后,换取到 AccessToken 和 OpenId,以此访问腾讯会议 Rest API。
- AccessToken:用于表示 OAuth2.0 鉴权成功 token 信息。
- OpenId:用于表示 OAuth2.0 鉴权用户信息。
公共参数
公共参数是用于标识用户和接口鉴权目的的参数,如非必要,在每个接口单独的接口文档中不再对这些参数进行说明,但每次请求均需要携带这些参数,才能正常发起请求。
公共参数需要统一放到 HTTP Header 请求头部中。
参数名称 | 类型 | 必选 | 描述 |
---|---|---|---|
X-TC-Action | String | 否 | 操作的接口名称。取值参考接口文档中输入参数公共参数 Action 的说明,例如云服务器的查询实例列表接口,取值为 DescribeInstances。 |
X-TC-Region | String | 否 | 地域参数,用来标识希望操作哪个地域的数据。接口接受的地域取值参考接口文档中输入参数公共参数 Region 的说明。<br>注意:某些接口不需要传递该参数,接口文档中会对此特别说明,此时即使传递该参数也不会生效。 |
X-TC-Timestamp | Integer | 是 | 此参数参与签名计算。当前 UNIX 时间戳,可记录发起 API 请求的时间。例如1529223702,单位为秒。<br>注意:如果与服务器时间相差超过5分钟,会引起签名过期错误。 |
X-TC-Nonce | Integer | 是 | 此参数参与签名计算,随机正整数。 |
X-TC-Version | String | 否 | 应用 App 的版本号,建议设置,以便灰度和查找问题。通过设置该字段,API 会把该版本信息传递给会议后台, 以控制一些和 App 版本有关的特性。 |
AccessToken | String | 是 | OAuth2.0 鉴权成功后返回的 token 信息。 |
OpenId | String | 是 | OAuth2.0 鉴权成功后的用户信息。 |
X-TC-Registered | Integer | 否 | 非必填字段,表示是否启用了腾讯会议的企业用户管理功能。请求头不带该字段或者该字段值为0,表示未启用企业用户管理功能。用户使用未注册的 userid 创建的会议,在会议客户端中无法看到会议列表,但可以正常使用会议短链接或会议号加入会议。<br>以下两种场景,请求头必须带该字段且值为1:<br><li>企业用户通过 SSO 接入腾讯会议账号体系;<br><li>企业用户通过腾讯会议企业用户管理创建用户。 |
构造请求头的时候,需注意自定义字段名的大小写。签名验证以及服务器端读取字段值时对大小写敏感。
授权方式
下面将为您介绍 OAuth2.0 的授权步骤,具体如下:
步骤一:用户同意授权,获取 auth_code
接口描述:用户同意授权。
接口请求方法:GET
接口请求域名:
https://meeting.tencent.com/authorize.html?corp_id={corpId}&sdk_id={sdkId}&redirect_uri={redirect_uri}&state={state}
输入参数
参数名称 | 必选 | 参数类型 | 参数描述 |
---|---|---|---|
corp_id | 是 | string | OAuth 应用的企业 ID。 |
sdk_id | 是 | string | OAuth 应用 ID。 |
redirect_uri | 是 | string | 授权后重定向的回调链接地址,请使用 urlEncode 对链接进行处理。 |
state | 是 | string | 重定向后会带上 state 参数,开发者可以填写 a-zA-Z0-9 的参数值,最多64字节。 |
输出参数
参数名称 | 参数类型 | 参数描述 |
---|---|---|
auth_code | string | 授权码。 |
state | string | 入参的 state,接入方自行校验,防止 CSRF 攻击。 |
示例
输入示例
// 接入方302重定向到授权URL,如:
https://meeting.tencent.com/authorize.html?corp_id=200000999&sdk_id=10066660661&redirect_uri=https%3a%2f%2fqq.com%2fcallback%3fa%3d1%26b%3d2&state=123456789
输出示例
HTTP/1.1 302 Found
Location: https://qq.com/callback?a=1&b=2&auth_code=98187ecd****4846ac555a658dcc1122&state=123456789
Date: Wed, 02 Dec 2020 13:36:38 GMT
Content-Length: 2
Content-Type: text/plain; charset=utf-8
步骤二:通过 auth_code 换取授权 access_token
接口描述:通过 auth_code 换取授权 access_token。
接口请求方法:POST
接口请求域名:
https://meeting.tencent.com/wemeet-webapi/v2/oauth2/oauth/access_token
由于授权的 secret 和获取到的 access_token 安全级别都非常高,必须只保存在服务器,不允许传给客户端。后续刷新 access_token、通过 access_token 获取用户信息等步骤时,也必须从服务器发起。
输入参数
参数名称 | 必选 | 参数类型 | 参数描述 |
---|---|---|---|
sdk_id | 是 | string | OAuth 应用 ID。 |
secret | 是 | string | OAuth 应用密钥。 |
auth_code | 是 | string | 授权码,有效期五分钟。 |
输出参数
参数名称 | 参数类型 | 参数描述 |
---|---|---|
access_token | string | 访问凭证(有效期6小时)。 |
refresh_token | string | 用户刷新 access_token 凭证(有效期30天)。 |
expires | int | access_token 过期时间,时间戳(单位秒)。 |
open_id | string | 用户唯一标识(同一 OAuth 应用,同一用户,值唯一)。 |
scopes | string | 用户授权的权限作用域,字符串数组。 |
示例
输入示例
{
"sdk_id":"10066660661",
"secret":"fde85be844****13d2747d06313123fa",
"auth_code":"98187ecd****4846ac555a658dcc1122"
}
输出示例
{
"nonce" : "98187ecdebca4846",
"data" : {
"access_token" : "RRZ6+d8Y+JX2hwBtsmF9LpZwBi2gR/bBu3Wq8TmrGtYoV0FqvbnD985smoqkZ6SoV/IgP5h+Lm+pAoxuR",
"expires" : 1606985243,
"refresh_token" : "RZ6+d8Y+JX2hwBtsmF9LpZwBi2gR/bBu3Wq8TmrGtYoV0FqvbnD985smoqkZ6SoV/IgP5iO7r+pQoxu",
"scopes" : [
"VIEW_USER_INFO",
"VIEW_VIDEO",
"MANAGE_VIDEO"
],
"open_id" : "xqGn7bYSD601jnq8xq0lCAlx5h12"
},
"message" : "SUCCESS",
"code" : 0
}
步骤三:刷新 access_token(如有需要)
接口描述:通过 refresh_token,令牌续约。
接口请求方法:POST
接口请求域名:
https://meeting.tencent.com/wemeet-webapi/v2/oauth2/oauth/refresh_token
输入参数
参数名称 | 必选 | 参数类型 | 参数描述 |
---|---|---|---|
refresh_token | 是 | string | 刷新凭证。 |
sdk_id | 是 | string | OAuth 应用 ID。 |
open_id | 是 | string | 用户唯一标识(同一 OAuth 应用,同一用户,值唯一)。 |
输出参数
参数名称 | 参数类型 | 参数描述 |
---|---|---|
access_token | string | 访问凭证(有效期6小时)。 |
refresh_token | string | 用户刷新 access_token 凭证(有效期30天)。 |
expires | int | access_token 过期时间,时间戳(单位秒)。 |
open_id | string | 用户唯一标识(同一 OAuth 应用,同一用户,值唯一)。 |
scopes | string | 用户授权的权限作用域,字符串数组。 |
示例
输入示例
{
"sdk_id":"10066660661",
"refresh_token":"RZ6+d8Y+JX2hwBtsmF9LpZwBi2gR/bBu3Wq8TmrGtYoV0FqvbnD985smoqkZ6SoV/IgP5iO7r+pQoxu", "open_id":"xqGn7bYSD601jnq8xq0lCAlx5h12"
}
输出示例
{
"nonce" : "98187ecdebca4846",
"data" : {
"access_token" : "RRZ6+d8Y+JX2hwBtsmF9LpZwBi2gR/bBu3Wq8TmrGtYoV0FqvbnD985smoqkZ6SoV/IgP5h+Lm+pAoxuR",
"expires" : 1606985243,
"refresh_token" : "RZ6+d8Y+JX2hwBtsmF9LpZwBi2gR/bBu3Wq8TmrGtYoV0FqvbnD985smoqkZ6SoV/IgP5iO7r+pQoxu",
"scopes" : [
"VIEW_USER_INFO",
"VIEW_VIDEO",
"MANAGE_VIDEO"
],
"open_id" : "xqGn7bYSD601jnq8xq0lCAlx5h12"
},
"message" : "SUCCESS",
"code" : 0
}
步骤四:拉取用户信息(检验凭证是否有效)
接口描述:拉取用户信息(检验凭证是否有效)。
接口请求方法:POST
接口请求域名:
https://meeting.tencent.com/wemeet-webapi/v2/oauth2/oauth/user_info
输入参数
参数名称 | 必选 | 参数类型 | 参数描述 |
---|---|---|---|
access_token | 是 | string | 访问凭证。 |
open_id | 是 | string | 用户唯一标识(同一 OAuth 应用,同一用户,值唯一)。 |
输出参数
参数名称 | 参数类型 | 参数描述 |
---|---|---|
expires | string | access_token 过期时间,时间戳(单位秒)。 |
open_id | string | 用户唯一标识(同一 OAuth 应用,同一用户,值唯一)。 |
scopes | string | 用户授权的权限作用域,字符串数组。 |
示例
输入示例
{
"access_token":"RZ6+d8Y+JX2hwBtsmF9LpZwBi2gR/bBu3Wq8TmrGtYoV0FqvbnD985smoqkZ6SoV/IgP5iO7r+pQoxu",
"open_id":"xqGn7bYSD601jnq8xq0lCAlx5h12"
}
输出示例
{
"nonce" : "98187ecdebca4846",
"data" : {
"expires" : 1606985243,
"scopes" : [
"VIEW_USER_INFO",
"VIEW_VIDEO",
"MANAGE_VIDEO"
],
"open_id" : "xqGn7bYSD601jnq8xq0lCAlx5h12"
},
"message" : "SUCCESS",
"code" : 0
}
鉴权错误返回参数
鉴权错误返回统一为400。
下载 腾讯会议 OAuth2.0 鉴权访问-腾讯会议.pdf
Copyright(C)2023 HFBangFu Inc. All Rights Reserved
皖ICP备12017563号-5