DescribeToken

Last updated: 2021-04-06 14:12:01

1. API Description

Domain name for API request: gpm.tencentcloudapi.com.

This API is used to query the token of a Matchcode, which is used for verified the pushed message.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: DescribeToken.
Version Yes String Common parameter. The value used for this API: 2020-08-20.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
MatchCode Yes String MatchCode

3. Output Parameters

Parameter Name Type Description
MatchToken String The token corresponding to the current MatchCode. If the current MatchCode does not have a token, this parameter may not obtain a valid value.
Note: this field may return null, indicating that no valid value is obtained.
CompatibleSpan Integer The time period during which GPM will continuously push the original token in seconds when the token is replaced.
Note: this field may return null, indicating that no valid value is obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the token of a Matchcode

Input Example

https://gpm.tencentcloudapi.com/?Action=DescribeToken
&MatchCode=match-58mnuqlz
&<Common request parameters>

Output Example

{
  "Response": {
    "MatchToken": "mytoken",
    "CompatibleSpan": 180,
    "RequestId": "ab6ab15a-ab3a-495c-8818-e826084ea072"
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation.ServiceUnavailable System error. If you cannot solve the problem, please submit a ticket.
InternalError Internal error
InvalidParameterValue.MatchCodeNotFound MatchCode does not exist.
InvalidParameterValue.MatchNotFound The matchmaking does not exist.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help