来鼓2.0全新发布，诚邀体验！

refresh access token

开发中

GET

/open/v1/oauth2/refresh-token

accessToken是调用授权关系接口的调用凭证，由于accessToken有效期（目前为2个小时）较短，当accessToken超时后，可以使用refreshToken进行刷新，accessToken刷新结果有两种：

若accessToken已超时，那么进行 refresh-token 会获取一个新的accessToken，新的超时时间；

若accessToken未超时

如果当前有效期大于等于5分钟，则会直接返回当前accessToken

如果小于5分钟，则会生成1个新的accessToken，旧的也不会过期，并返回新的accessToken，同一用户同一时间最多拥有2个accessToken

refreshToken拥有较长的有效期（180天），当refreshToken失效的后，需要用户重新授权。

最佳实践：推荐accessToken有效期小于5分钟时请求刷新该接口获取新的accessToken

请求参数

Query 参数

appid

string

应用唯一标识

可选

示例值:

<APPID_VALUE>

grantType

string

可选

填refresh_token

示例值:

refresh_token

refreshToken

string

可选

填写通过access_token获取到的refresh_token参数

示例值:

<REFRESH_TOKEN_VALUE>

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET '/open/v1/oauth2/refresh-token?appid=<APPID_VALUE>&grantType=refresh_token&refreshToken=<REFRESH_TOKEN_VALUE>'

返回响应

🟢200成功

application/json

Body

code

integer

1-成功，否则失败

必需

msg

string

提示信息

必需

data

object

数据

必需

accessToken

string

接口调用凭证

必需

expiresIn

integer

必需

access_token接口调用凭证超时时间，单位（秒）

refreshToken

string

必需

用户刷新access_token

scope

string

必需

用户授权的作用域，使用逗号（,）分隔

entId

integer

企业ID

必需

agentId

integer

必需

token所属客服ID

示例

{
    "code": 0,
    "msg": "string",
    "data": {
        "accessToken": "string",
        "expiresIn": 0,
        "refreshToken": "string",
        "scope": "string",
        "entId": 0,
        "agentId": 0
    }
}

修改于 2025-05-14 20:58:06

get access token

check access token