{
  "name": "captcha",
  "display_name": "验证码",
  "description": "介绍如何使用API对验证码进行操作，包括核查验证码票据结果、安全验证码用户操作数据查询等。",
  "domain": "other",
  "api_version": "2019-07-22",
  "endpoint": "captcha.tencentcloudapi.com",
  "actions": [
    {
      "name": "DescribeCaptchaAppIdInfo",
      "description": "查询安全验证码应用APPId信息",
      "status": "online",
      "parameters": [
        {
          "name": "CaptchaAppId",
          "type": "integer",
          "required": true,
          "description": "验证码应用注册APPID",
          "example": "199999409"
        }
      ],
      "required": [
        "CaptchaAppId"
      ]
    },
    {
      "name": "DescribeCaptchaData",
      "description": "安全验证码分类查询数据接口，请求量type=0、通过量type=1、验证量type=2、拦截量type=3 分钟级查询",
      "status": "online",
      "parameters": [
        {
          "name": "CaptchaAppId",
          "type": "integer",
          "required": true,
          "description": "验证码应用ID",
          "example": "1854132229"
        },
        {
          "name": "Start",
          "type": "integer",
          "required": true,
          "description": "查询开始时间",
          "example": "20220206"
        },
        {
          "name": "End",
          "type": "integer",
          "required": true,
          "description": "查询结束时间",
          "example": "20220201"
        },
        {
          "name": "Type",
          "type": "integer",
          "required": true,
          "description": "查询类型",
          "example": "1"
        }
      ],
      "required": [
        "CaptchaAppId",
        "Start",
        "End",
        "Type"
      ]
    },
    {
      "name": "DescribeCaptchaDataSum",
      "description": "安全验证码查询请求数据概况，例如：按照时间段查询数据 昨日请求量、昨日恶意比例、昨日验证量、昨日通过量、昨日恶意拦截量……",
      "status": "online",
      "parameters": [
        {
          "name": "CaptchaAppId",
          "type": "integer",
          "required": true,
          "description": "验证码应用ID",
          "example": "2010000"
        },
        {
          "name": "Start",
          "type": "integer",
          "required": true,
          "description": "查询开始时间",
          "example": "20191201"
        },
        {
          "name": "End",
          "type": "integer",
          "required": true,
          "description": "查询结束时间",
          "example": "20191202"
        }
      ],
      "required": [
        "CaptchaAppId",
        "Start",
        "End"
      ]
    },
    {
      "name": "DescribeCaptchaMiniData",
      "description": "安全验证码小程序插件分类查询数据接口，请求量type=0、通过量type=1、验证量type=2、拦截量type=3 小时级查询（五小时左右延迟）",
      "status": "online",
      "parameters": [
        {
          "name": "CaptchaAppId",
          "type": "integer",
          "required": true,
          "description": "验证码应用ID",
          "example": "1854132229"
        },
        {
          "name": "Start",
          "type": "integer",
          "required": true,
          "description": "查询开始时间 例如：2019112900",
          "example": "2019112900"
        },
        {
          "name": "End",
          "type": "integer",
          "required": true,
          "description": "查询结束时间 例如：2019112902",
          "example": "2019112902"
        },
        {
          "name": "Type",
          "type": "integer",
          "required": true,
          "description": "查询类型 安全验证码小程序插件分类查询数据接口，请求量type=0、通过量type=1、验证量type=2、拦截量type=3 小时级查询（五小时左右延迟）",
          "example": "1"
        }
      ],
      "required": [
        "CaptchaAppId",
        "Start",
        "End",
        "Type"
      ]
    },
    {
      "name": "DescribeCaptchaMiniDataSum",
      "description": "安全验证码小程序插件查询请求数据概况",
      "status": "online",
      "parameters": [
        {
          "name": "CaptchaAppId",
          "type": "integer",
          "required": true,
          "description": "验证码应用ID",
          "example": "1854132229"
        },
        {
          "name": "Start",
          "type": "integer",
          "required": true,
          "description": "查询开始时间",
          "example": "20220201"
        },
        {
          "name": "End",
          "type": "integer",
          "required": true,
          "description": "查询结束时间",
          "example": "20220201"
        }
      ],
      "required": [
        "CaptchaAppId",
        "Start",
        "End"
      ]
    },
    {
      "name": "DescribeCaptchaMiniOperData",
      "description": "安全验证码小程序插件用户操作数据查询",
      "status": "online",
      "parameters": [
        {
          "name": "CaptchaAppId",
          "type": "integer",
          "required": true,
          "description": "验证码应用ID",
          "example": "201111111"
        },
        {
          "name": "Start",
          "type": "integer",
          "required": true,
          "description": "查询开始时间",
          "example": "20200909"
        },
        {
          "name": "Type",
          "type": "integer",
          "required": true,
          "description": "查询类型",
          "example": "2"
        },
        {
          "name": "End",
          "type": "integer",
          "required": false,
          "description": "查询结束时间",
          "example": "20220313"
        }
      ],
      "required": [
        "CaptchaAppId",
        "Start",
        "Type"
      ]
    },
    {
      "name": "DescribeCaptchaMiniResult",
      "description": "核查验证码票据结果(小程序插件)",
      "status": "online",
      "parameters": [
        {
          "name": "CaptchaType",
          "type": "integer",
          "required": true,
          "description": "固定填值：9",
          "example": "9"
        },
        {
          "name": "Ticket",
          "type": "string",
          "required": true,
          "description": "验证码返回给用户的票据",
          "example": "tr03XaCUZPAlPdIMqv17yvcfdXCzkqvLE09AbCA4ghlWfD8hkySfbU2TZVCyoOCjNI84pAYEMopKv7Uh8XwQDSE9DC0xJpXVC7kmlPENlbFINs_N937qkoEmU6Pl8e-9EkFQzvrrwsZOTKQ*"
        },
        {
          "name": "UserIp",
          "type": "string",
          "required": true,
          "description": "业务侧获取到的验证码使用者的外网IP",
          "example": "127.0.0.1"
        },
        {
          "name": "CaptchaAppId",
          "type": "integer",
          "required": true,
          "description": "验证码应用ID。登录 [验证码控制台](https://console.cloud.tencent.com/captcha/graphical)，在验证列表的【密钥】列，即可查看到CaptchaAppId。",
          "example": "199999164"
        },
        {
          "name": "AppSecretKey",
          "type": "string",
          "required": true,
          "description": "验证码应用密钥。登录 [验证码控制台](https://console.cloud.tencent.com/captcha/graphical)，在验证列表的【密钥】列，即可查看到AppSecretKey。AppSecretKey属于服务器端校验验证码票据的密钥，请妥善保密，请勿泄露给第三方。",
          "example": "E4kwK9AcXQMHkktRItyMEyQnp"
        },
        {
          "name": "BusinessId",
          "type": "integer",
          "required": false,
          "description": "业务 ID，网站或应用在多个业务中使用此服务，通过此 ID 区分统计数据",
          "example": "1"
        },
        {
          "name": "SceneId",
          "type": "integer",
          "required": false,
          "description": "场景 ID，网站或应用的业务下有多个场景使用此服务，通过此 ID 区分统计数据",
          "example": "3"
        },
        {
          "name": "MacAddress",
          "type": "string",
          "required": false,
          "description": "mac 地址或设备唯一标识",
          "example": "\"00:1A:2B:3C:4D:5E\""
        },
        {
          "name": "Imei",
          "type": "string",
          "required": false,
          "description": "手机设备号",
          "example": "\"359880051234567\""
        }
      ],
      "required": [
        "CaptchaType",
        "Ticket",
        "UserIp",
        "CaptchaAppId",
        "AppSecretKey"
      ]
    },
    {
      "name": "DescribeCaptchaMiniRiskResult",
      "description": "核查验证码小程序插件票据接入风控结果(已停用)",
      "status": "online",
      "parameters": [
        {
          "name": "CaptchaType",
          "type": "integer",
          "required": true,
          "description": "固定填值：9（滑块验证码）",
          "example": "9"
        },
        {
          "name": "Ticket",
          "type": "string",
          "required": true,
          "description": "验证码返回给用户的票据",
          "example": "tr03z8JQftDQ5ZMteDlvkg6GbucZQTiG8dq53boJY8xJoq6PanrsicK9NOQcK6G2aXSjReWIxVvXt1Y6TXnaWvBy3k2hp_gRSwpi_ZEu3j8BUY2vuuyg-c1tZc3c8GfLdVlqJbOQ5JdAFos*"
        },
        {
          "name": "UserIp",
          "type": "string",
          "required": true,
          "description": "业务侧获取到的验证码使用者的外网IP",
          "example": "127.0.0.1"
        },
        {
          "name": "CaptchaAppId",
          "type": "integer",
          "required": true,
          "description": "验证码应用APPID",
          "example": "199999164"
        },
        {
          "name": "AppSecretKey",
          "type": "string",
          "required": true,
          "description": "用于服务器端校验验证码票据的验证密钥，请妥善保密，请勿泄露给第三方",
          "example": "E4kwK9AcXQMHkktiItyMEyQPn"
        },
        {
          "name": "BusinessId",
          "type": "integer",
          "required": false,
          "description": "业务 ID，网站或应用在多个业务中使用此服务，通过此 ID 区分统计数据",
          "example": "1"
        },
        {
          "name": "SceneId",
          "type": "integer",
          "required": false,
          "description": "场景 ID，网站或应用的业务下有多个场景使用此服务，通过此 ID 区分统计数据",
          "example": "3"
        },
        {
          "name": "MacAddress",
          "type": "string",
          "required": false,
          "description": "mac 地址或设备唯一标识",
          "example": "\"00:1A:2B:3C:4D:5E\""
        },
        {
          "name": "Imei",
          "type": "string",
          "required": false,
          "description": "手机设备号",
          "example": "\"359880051234567\""
        },
        {
          "name": "SceneCode",
          "type": "integer",
          "required": false,
          "description": "验证场景：1 活动防刷场景，2 登录保护场景，3 注册保护场景。根据需求选择场景参数。",
          "example": "1"
        },
        {
          "name": "WeChatOpenId",
          "type": "string",
          "required": false,
          "description": "用户操作来源的微信开放账号",
          "example": "\"o6_bmjrPTlm6_2sgVt7hMZOPfL2M\""
        }
      ],
      "required": [
        "CaptchaType",
        "Ticket",
        "UserIp",
        "CaptchaAppId",
        "AppSecretKey"
      ]
    },
    {
      "name": "DescribeCaptchaOperData",
      "description": "安全验证码用户操作数据查询，验证码加载耗时type = 1 、拦截情况type = 2、 一周通过平均尝试次数 type = 3、尝试次数分布 type = 4",
      "status": "online",
      "parameters": [
        {
          "name": "CaptchaAppId",
          "type": "integer",
          "required": true,
          "description": "验证码应用ID",
          "example": "201111111"
        },
        {
          "name": "Start",
          "type": "integer",
          "required": true,
          "description": "查询开始时间",
          "example": "20191129"
        },
        {
          "name": "Type",
          "type": "integer",
          "required": true,
          "description": "查询类型",
          "example": "1"
        },
        {
          "name": "End",
          "type": "integer",
          "required": false,
          "description": "查询结束时间",
          "example": "20220313"
        }
      ],
      "required": [
        "CaptchaAppId",
        "Start",
        "Type"
      ]
    },
    {
      "name": "DescribeCaptchaRceResult",
      "description": "Rce融合验证核查验证码票据结果(Web及APP)",
      "status": "online",
      "parameters": [
        {
          "name": "CaptchaType",
          "type": "integer",
          "required": true,
          "description": "固定填值：9。",
          "example": "9"
        },
        {
          "name": "Ticket",
          "type": "string",
          "required": true,
          "description": "前端回调函数返回的用户验证票据",
          "example": "tr03z8JQftDQ5ZMteDlvkg6GbucZQTiG8dq53boJY8xJoq6PanrsicK9NOQcK6G2aXSjReWIxVvXt1Y6TXnaWvBy3k2hp_gRSwpi_ZEu3j8BUY2vuuyg-c1tZc3c8GfLdVlqJbOQ5JdAFos*"
        },
        {
          "name": "UserIp",
          "type": "string",
          "required": true,
          "description": "业务侧获取到的验证码使用者的外网IP",
          "example": "127.0.0.1"
        },
        {
          "name": "Randstr",
          "type": "string",
          "required": true,
          "description": "前端回调函数返回的随机字符串",
          "example": "@Vki"
        },
        {
          "name": "CaptchaAppId",
          "type": "integer",
          "required": true,
          "description": "验证码应用ID。登录 [验证码控制台](https://console.cloud.tencent.com/captcha/graphical)，在验证列表的【密钥】列，即可查看到CaptchaAppId。",
          "example": "199999164"
        },
        {
          "name": "AppSecretKey",
          "type": "string",
          "required": true,
          "description": "验证码应用密钥。登录 [验证码控制台](https://console.cloud.tencent.com/captcha/graphical)，在验证列表的【密钥】列，即可查看到AppSecretKey。AppSecretKey属于服务器端校验验证码票据的密钥，请妥善保密，请勿泄露给第三方。",
          "example": "E4kwK9AcXQMHkktiItyMEyQPn"
        },
        {
          "name": "BusinessId",
          "type": "integer",
          "required": false,
          "description": "预留字段",
          "example": "1"
        },
        {
          "name": "SceneId",
          "type": "integer",
          "required": false,
          "description": "预留字段",
          "example": "3"
        },
        {
          "name": "MacAddress",
          "type": "string",
          "required": false,
          "description": "mac 地址或设备唯一标识",
          "example": "\"00:1A:2B:3C:4D:5E\""
        },
        {
          "name": "Imei",
          "type": "string",
          "required": false,
          "description": "手机设备号",
          "example": "\"359880051234567\""
        },
        {
          "name": "NeedGetCaptchaTime",
          "type": "integer",
          "required": false,
          "description": "是否返回前端获取验证码时间，取值1：需要返回",
          "example": "1"
        }
      ],
      "required": [
        "CaptchaType",
        "Ticket",
        "UserIp",
        "Randstr",
        "CaptchaAppId",
        "AppSecretKey"
      ]
    },
    {
      "name": "DescribeCaptchaResult",
      "description": "核查验证码票据结果(Web及APP)",
      "status": "online",
      "parameters": [
        {
          "name": "CaptchaType",
          "type": "integer",
          "required": true,
          "description": "固定填值：9。",
          "example": "9"
        },
        {
          "name": "Ticket",
          "type": "string",
          "required": true,
          "description": "前端回调函数返回的用户验证票据",
          "example": "tr03XaCUZPAlPdIMqv17yvcfdXCzkqvLE09AbCA4ghlWfD8hkySfbU2TZVCyoOCjNI84pAYEMopKv7Uh8XwQDSE9DC0xJpXVC7kmlPENlbFINs_N937qkoEmU6Pl8e-9EkFQzvrrwsZOTKQ*"
        },
        {
          "name": "UserIp",
          "type": "string",
          "required": true,
          "description": "业务侧获取到的验证码使用者的外网IP",
          "example": "127.0.0.1"
        },
        {
          "name": "Randstr",
          "type": "string",
          "required": true,
          "description": "前端回调函数返回的随机字符串",
          "example": "@Vki"
        },
        {
          "name": "CaptchaAppId",
          "type": "integer",
          "required": true,
          "description": "验证码应用ID。登录 [验证码控制台](https://console.cloud.tencent.com/captcha/graphical)，在验证列表的【密钥】列，即可查看到CaptchaAppId。",
          "example": "199999164"
        },
        {
          "name": "AppSecretKey",
          "type": "string",
          "required": true,
          "description": "验证码应用密钥。登录 [验证码控制台](https://console.cloud.tencent.com/captcha/graphical)，在验证列表的【密钥】列，即可查看到AppSecretKey。AppSecretKey属于服务器端校验验证码票据的密钥，请妥善保密，请勿泄露给第三方。",
          "example": "E4kwK9AcXQMHkktiItyMEyQPn"
        },
        {
          "name": "BusinessId",
          "type": "integer",
          "required": false,
          "description": "预留字段",
          "example": "1"
        },
        {
          "name": "SceneId",
          "type": "integer",
          "required": false,
          "description": "预留字段",
          "example": "3"
        },
        {
          "name": "MacAddress",
          "type": "string",
          "required": false,
          "description": "mac 地址或设备唯一标识",
          "example": "\"00:1A:2B:3C:4D:5E\""
        },
        {
          "name": "Imei",
          "type": "string",
          "required": false,
          "description": "手机设备号",
          "example": "\"359880051234567\""
        },
        {
          "name": "NeedGetCaptchaTime",
          "type": "integer",
          "required": false,
          "description": "是否返回前端获取验证码时间，取值1：需要返回",
          "example": "1"
        }
      ],
      "required": [
        "CaptchaType",
        "Ticket",
        "UserIp",
        "Randstr",
        "CaptchaAppId",
        "AppSecretKey"
      ]
    },
    {
      "name": "DescribeCaptchaTicketData",
      "description": "安全验证码用户操作票据数据查询",
      "status": "online",
      "parameters": [
        {
          "name": "CaptchaAppId",
          "type": "integer",
          "required": true,
          "description": "验证码应用ID",
          "example": "199999164"
        },
        {
          "name": "Start",
          "type": "integer",
          "required": true,
          "description": "查询开始时间 例如：20200909",
          "example": "20200909"
        },
        {
          "name": "End",
          "type": "integer",
          "required": false,
          "description": "查询结束时间 例如：20220314",
          "example": "20220313"
        }
      ],
      "required": [
        "CaptchaAppId",
        "Start"
      ]
    },
    {
      "name": "DescribeCaptchaUserAllAppId",
      "description": "安全验证码获取用户注册所有APPId和应用名称",
      "status": "online",
      "parameters": [],
      "required": []
    },
    {
      "name": "GetRequestStatistics",
      "description": "查询单个CaptchaAppID验证的统计数据，包括：请求量、验证量、验证通过量、验证拦截量。",
      "status": "online",
      "parameters": [
        {
          "name": "CaptchaAppId",
          "type": "string",
          "required": true,
          "description": "验证码AppId",
          "example": "\"19901111\""
        },
        {
          "name": "StartTimeStr",
          "type": "string",
          "required": true,
          "description": "开始时间字符串",
          "example": "\"2022-05-14 01:00\""
        },
        {
          "name": "EndTimeStr",
          "type": "string",
          "required": true,
          "description": "结束时间字符串",
          "example": "\"2022-06-15 20:00\""
        },
        {
          "name": "Dimension",
          "type": "string",
          "required": true,
          "description": "查询粒度",
          "example": "\"3\""
        }
      ],
      "required": [
        "CaptchaAppId",
        "StartTimeStr",
        "EndTimeStr",
        "Dimension"
      ]
    },
    {
      "name": "GetTicketStatistics",
      "description": "查询单个CaptchaAppID票据校验数据，包括：票据校验量、票据校验通过量、票据校验拦截量。",
      "status": "online",
      "parameters": [
        {
          "name": "CaptchaAppId",
          "type": "string",
          "required": true,
          "description": "验证码AppId",
          "example": "\"199999164\""
        },
        {
          "name": "StartTimeStr",
          "type": "string",
          "required": true,
          "description": "开始时间字符串",
          "example": "\"2022-05-14 01:00\""
        },
        {
          "name": "EndTimeStr",
          "type": "string",
          "required": true,
          "description": "结束时间字符串",
          "example": "\"2022-06-15 20:00\""
        },
        {
          "name": "Dimension",
          "type": "string",
          "required": true,
          "description": "查询粒度",
          "example": "\"3\""
        }
      ],
      "required": [
        "CaptchaAppId",
        "StartTimeStr",
        "EndTimeStr",
        "Dimension"
      ]
    },
    {
      "name": "GetTotalRequestStatistics",
      "description": "查询全部验证的统计数据，包括：总请求量、总验证量、总验证通过量、总验证拦截量等数据。",
      "status": "online",
      "parameters": [
        {
          "name": "StartTimeStr",
          "type": "string",
          "required": true,
          "description": "开始时间字符串",
          "example": "\"2022-05-14 01:00\""
        },
        {
          "name": "EndTimeStr",
          "type": "string",
          "required": true,
          "description": "结束时间字符串",
          "example": "\"2022-06-15 20:00\""
        },
        {
          "name": "Dimension",
          "type": "string",
          "required": true,
          "description": "查询粒度",
          "example": "\"3\""
        }
      ],
      "required": [
        "StartTimeStr",
        "EndTimeStr",
        "Dimension"
      ]
    },
    {
      "name": "GetTotalTicketStatistics",
      "description": "查询全部票据校验的统计数据，包括：总票据校验量、总票据校验通过量、总票据校验拦截量。",
      "status": "online",
      "parameters": [
        {
          "name": "StartTimeStr",
          "type": "string",
          "required": true,
          "description": "开始时间",
          "example": "\"2022-05-14 01:00\""
        },
        {
          "name": "EndTimeStr",
          "type": "string",
          "required": true,
          "description": "结束时间",
          "example": "\"2022-06-15 20:00\""
        },
        {
          "name": "Dimension",
          "type": "string",
          "required": true,
          "description": "查询粒度分钟：“1”小时：“2”天：“3”",
          "example": "\"3\""
        }
      ],
      "required": [
        "StartTimeStr",
        "EndTimeStr",
        "Dimension"
      ]
    },
    {
      "name": "UpdateCaptchaAppIdInfo",
      "description": "更新验证码应用APPId信息",
      "status": "online",
      "parameters": [
        {
          "name": "CaptchaAppId",
          "type": "integer",
          "required": true,
          "description": "验证码应用ID",
          "example": "199999409"
        },
        {
          "name": "AppName",
          "type": "string",
          "required": true,
          "description": "应用名",
          "example": "\"登录场景\""
        },
        {
          "name": "DomainLimit",
          "type": "string",
          "required": true,
          "description": "域名限制",
          "example": "\"login.com\""
        },
        {
          "name": "SceneType",
          "type": "integer",
          "required": true,
          "description": "场景类型",
          "example": "3"
        },
        {
          "name": "CapType",
          "type": "integer",
          "required": true,
          "description": "验证码类型",
          "example": "2"
        },
        {
          "name": "EvilInterceptGrade",
          "type": "integer",
          "required": true,
          "description": "风险级别",
          "example": "2"
        },
        {
          "name": "SmartVerify",
          "type": "integer",
          "required": true,
          "description": "智能检测",
          "example": "0"
        },
        {
          "name": "SmartEngine",
          "type": "integer",
          "required": true,
          "description": "开启智能引擎",
          "example": "0"
        },
        {
          "name": "SchemeColor",
          "type": "string",
          "required": true,
          "description": "web风格",
          "example": "\"#ffffff\""
        },
        {
          "name": "CaptchaLanguage",
          "type": "integer",
          "required": true,
          "description": "语言",
          "example": "2052"
        },
        {
          "name": "MailAlarm",
          "type": "string",
          "required": true,
          "description": "告警邮箱",
          "example": "\"login@login.com\""
        },
        {
          "name": "TopFullScreen",
          "type": "integer",
          "required": true,
          "description": "是否全屏",
          "example": "0"
        },
        {
          "name": "TrafficThreshold",
          "type": "integer",
          "required": true,
          "description": "流量限制",
          "example": "0"
        }
      ],
      "required": [
        "CaptchaAppId",
        "AppName",
        "DomainLimit",
        "SceneType",
        "CapType",
        "EvilInterceptGrade",
        "SmartVerify",
        "SmartEngine",
        "SchemeColor",
        "CaptchaLanguage",
        "MailAlarm",
        "TopFullScreen",
        "TrafficThreshold"
      ]
    }
  ]
}