Rate This Document
Findability
Accuracy
Completeness
Readability

Response Format Description

Returned Result

1
2
3
4
5
6
7
8
9
{
  "code": "2000",
  "message": "Authentication token updated successfully",
	"messageArgs": [],
"data": {
	"access_token": "*******************************",
        "expires_in": 3600
	}
}

Return Parameter

Table 1 Return parameters

Parameter

Name

Type

Description

code

Returned value

String

If the 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.

access_token

Authentication token

String

Trusted token after authentication.

expires_in

Validity period of access_token

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.

Error Code

Table 2 Error codes

Error Scene

Return Code

Error Message

Missing client_id

8101

The client_id parameter is missing.

Missing refresh_token

8106

The refresh_token parameter is missing.

Invalid client_id

8201

The client_id parameter is invalid.

Invalid refresh_token

8206

The refresh_token parameter is invalid.

Internal resource error

8500

There is internal resource error on the server.