tencent cloud

APIs

文档APIsCaptchaConsole v2.0 APIsCreateCaptchaInfoInternational

新建验证码国际

下载
聚焦模式
字号
最后更新时间: 2026-09-08 19:37:59

1. 接口描述

接口请求域名: captcha.intl.tencentcloudapi.com 。

新建验证码:您可以基于不同业务需求创建多个验证,每个验证配置不同的客户端类型、安全策略等。新建验证上限为50个。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateCaptchaInfoInternational。
Version String 公共参数,本接口取值:2019-07-22。
Region String 公共参数,此参数为可选参数。
AppName String

验证码名称

ChannelInfo String

客户端类型

枚举值:

  • web: web场景使用
  • android: android端使用
  • ios: ios端使用

默认值:web

VerifyRank String

验证等级

枚举值:

  • 1: 体验优先
  • 2: 平衡
  • 3: 安全优先

默认值:1

UserSetCapType String

验证类型

枚举值:

  • 1: 无感验证 , UserSetCapType传入1,DisableInvisibleSwitch必须为2
  • 2: 滑动
  • 8: 图形点选
  • 9: 语音
DefendMode String

拦截模式

枚举值:

  • block: 打击模式
  • notify: 感知模式

默认值:notify

Tags.N Array of String

资源标签, key&value格式

DisableInvisibleSwitch String

验证机制

枚举值:

  • 0: 一键验证
  • 1: 始终验证
  • 2: 无感验证,DisableInvisibleSwitch传入2, UserSetCapType必须为1
VerifyDomain String

web域名

仅在ChannelInfo为web时传入有效

VerifyBundleId String

app BundleId

仅在ChannelInfo为ios时传入有效

VerifyPackage String

app package

仅在ChannelInfo为android时传入有效

CheckAppidSwitch Integer

是否开启captcha加密,0:关闭,1:开启

CheckIvSwitch Integer

是否开启一次一密

枚举值:

  • 0: 关闭
  • 1: 开启

仅在CheckAppidSwitch为1时允许传入1

CheckBoxStyle String

勾选框展示方式

枚举值:

  • 0: 简约版
  • 1: 基础版
  • 2: 隐形版

3. 输出参数

参数名称 类型 描述
Data Integer

结果数据

CaptchaCode Integer

验证码状态码

CaptchaMsg String

验证码信息

RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求和返回示例

创建验证码

输入示例

POST / HTTP/1.1
Host: captcha.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCaptchaInfo
<公共请求参数>

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

输出示例

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

5. 开发者资源

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
AuthFailure.UnauthorizedOperation 请求未CAM授权
InternalError 内部错误。
InvalidParameter 参数错误。
UnauthorizedOperation.ErrAuth 鉴权失败。
UnauthorizedOperation.Unauthorized 未开通权限/无有效套餐包/账号已欠费。

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈