Domain name for API request: captcha.intl.tencentcloudapi.com.
Query the Captcha list to obtain all verification CaptchaAppIds, verification names, and other information internationally.
A maximum of 20 requests can be initiated per second for this API.
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 Params. The value used for this API: DescribeCaptchaInfoListInternational. |
| Version | Yes | String | Common Params. The value used for this API: 2019-07-22. |
| Region | No | String | Common Params. This parameter is not required. |
| PageIndex | No | Integer | Pagination parameter - page number |
| PageSize | No | Integer | Pagination parameters - number of records per page |
| UserSetCapTypeArr.N | No | Array of String | Query parameter - Behavior verification type Enumeration values:
|
| VerifyRankArr.N | No | Array of String | Query parameter - risk control level Enumeration values:
|
| ChannelInfoArr.N | No | Array of String | Query parameter - client multiple selection Enumeration values:
|
| CaptchaAppId | No | String | Query parameter -Captcha appid |
| AppName | No | String | Query parameter - Captcha name |
| OrderBy | No | OrderByInternational | Sorting parameter Input limits: desc: in descending order by creation time; asc: in ascending order by creation time |
| Parameter Name | Type | Description |
|---|---|---|
| Data | DescribeCaptchaConsoleDataInternational | Data block after paging query. |
| CaptchaCode | Integer | Captcha response code |
| CaptchaMsg | String | Captcha information |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
Query the verification code list information
POST / HTTP/1.1
Host: captcha.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCaptchaInfoList
<Common request parameters>
{
"CaptchaAppId": "179*****2",
"OrderBy": {
"CreateTime": "string"
},
"PageIndex": "int",
"UserSetCapTypeArr": [
String
],
"ChannelInfoArr": [
string
],
"PageSize": "int"
"AppName": "string",
"VerifyRankArr": [
string
]
}{
"Response": {
"RequestId": "5b320902-54f3-4b70-8663-6e86e99dffff",
"Data": {
"DataList": [],
"Total": 0,
"PageIndex": 0
},
"CaptchaCode": 0,
"CaptchaMsg": "success"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| AuthFailure | CAM signature/authentication error. |
| AuthFailure.UnauthorizedOperation | Request not authorized by CAM. |
| InternalError | Internal error. |
| InvalidParameter | Parameter error. |
| UnauthorizedOperation.ErrAuth | Authentication failed. |
| UnauthorizedOperation.Unauthorized | Operation not authorized/No valid package/The account is overdue |
피드백