tencent cloud

APIs

DocumentaçãoAPIsCaptchaConsole v2.0 APIsCreateCaptchaInfoInternational

CreateCaptchaInfoInternational

Baixar
Modo Foco
Tamanho da Fonte
Última atualização: 2026-09-08 19:37:14

1. API Description

Domain name for API request: captcha.intl.tencentcloudapi.com.

Create a captcha: You can create multiple Captcha based on different business needs. Each verification has different client types and security policies. The limit for new Captcha is 50.

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 Params. The value used for this API: CreateCaptchaInfoInternational.
Version Yes String Common Params. The value used for this API: 2019-07-22.
Region No String Common Params. This parameter is not required.
AppName Yes String

Captcha name
ChannelInfo Yes String

Client type

Enumeration values:

  • web: For web scenario
  • android: For Android client
  • ios: For iOS client

Default value: web
VerifyRank No String

Verification level

Enumeration values:

  • 1: Experience-oriented
  • 2: Balanced
  • 3: Security-focused

Default value: 1
UserSetCapType No String

Validation type

Enumeration values:

  • 1: Invisible verification. UserSetCapType input 1, DisableInvisibleSwitch must be 2
  • 2: Slide
  • 8: Graphical
  • 9: Voice
DefendMode No String

Interception mode

Enumeration values:

  • block: interception mode
  • notify: perception mode

Default value: notify
Tags.N No Array of String

Resource tag, key&value format
DisableInvisibleSwitch No String

Verification mechanism

Enumeration values:

  • 0: One-Click Verification
  • 1: Always verify
  • 2: Invisible verification. DisableInvisibleSwitch input 2, UserSetCapType must be 1
VerifyDomain No String

web domain name

Only valid when ChannelInfo is web
VerifyBundleId No String

app BundleId

Only valid when ChannelInfo is ios
VerifyPackage No String

app package

Only valid when ChannelInfo is android
CheckAppidSwitch No Integer

Whether to enable captcha encryption. 0: Off. 1: On
CheckIvSwitch No Integer

Whether to enable non-repeating IV

Enumeration values:

  • 0: Off
  • 1: On

Input 1 is allowed only when CheckAppidSwitch is 1
CheckBoxStyle No String

Checkbox display method

Enumeration values:

  • 0: simplified version
  • 1: basic version
  • 2: invisible version

3. Output Parameters

Parameter Name Type Description
Data Integer

Result data.
CaptchaCode Integer

Captcha status 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.

4. Example

Example1 Request and return example

Create a verification code

Input Example

POST / HTTP/1.1
Host: captcha.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCaptchaInfo
<Common request parameters>

{
    "UserSetCapType": "13",
    "AppName": "aaa",
    "VerifyRank": "3",
    "ChannelInfo": "web",
    "VerifyDomain": "\"*******.com\"",
    "VerifyBundleId": "\"com.*******",
    "VerifyPackage": "\"com.******\""
}

Output Example

{
    "Response": {
        "RequestId": "63ade1a9-eae8-49d4-b8be-bf803bfffdbe",
        "Data": 179000008,
        "CaptchaCode": 11000,
        "CaptchaMsg": ""
    }
}

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
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
Anterior: CreateIpWhiteListInternationalPróximo: DescribeCaptchaResult

Ajuda e Suporte

Esta página foi útil?

comentários

Search
    Enter keywords to search documentation