Rate This Document
Findability
Accuracy
Completeness
Readability

Response Format Description

Returned Result

{
  "code": "2000",
  "message": "Authentication succeeded",
  "messageArgs": [],
  "data": {
     "access_token": "*******************************",
     "expires_in": 3600,
     "refresh_token":"*******************************"
}
}

Return Parameter

Table 1 Return parameters

Parameter

Name

Type

Description

access_token

Authentication token

String

Trusted token after authentication.

expires_in

Token expiration time

Integer

  • The value is a number, in seconds. For example, the value 3600 indicates the validity period of the current access_token. The maximum value is one hour.
  • If access_token becomes invalid, refresh_token is used by default to obtain a new access_token.

refresh_token

Refresh token

String

It is used to refresh the token of access_token after access_token is used. The token usually lasts for hours or days.

code

Returned value

String

If data is normal, 2000 is returned. If an error occurs, the corresponding error code is returned.

message

Returned message

String

Returned message. For details about a normal message, see the above example. For details about the interface request error messages, see the Error codes table.

messageArgs

Returned message arguments

List

Currently, this parameter is left blank for extension.

data

Data dictionary

dict

Dictionary of returned information.

Error Code

Table 2 Error codes

Error Scene

Return Code

Error Message

Missing client_id

8101

The client_id parameter is missing.

Missing authorization_code

8102

The authorization_code parameter is missing.

Missing grant_type

8103

The grant_type parameter is missing.

Missing client_secret

8104

The client_secret parameter is missing.

Missing redirect_uri

8107

The redirect_uri parameter is missing.

Invalid client_id

8201

The client_id parameter is invalid.

Invalid authorization_code

8202

The authorization_code parameter is invalid.

Invalid grant_type

8203

The grant_type parameter is invalid.

Invalid client_secret

8204

The client_secret parameter is invalid.

Invalid redirect_uri

8207

The redirect_uri parameter is invalid.