客户端初始化报错说明

更新时间:
复制 MD 格式

初始化接口错误码

验证码初始化接口指的是带有用户身份标的获取验证码资源的请求,请求域名为xxxxx.captcha-open.aliyuncs.com,其中xxxxx为用户的身份标,关于如何获取身份标,请参考开通验证码服务。初始化请求成功之后的返回应如下所示:

{
  "CaptchaType": "INPAINTING",
  "CertifyId": "axxx",
  "Code": "Success",
  "DeviceConfig": "0NtwB5Lb4R602aF1IO1CHB1qKWQndQ1qXjwNGcoZH1NlVqy+VBr2wtb/Nb0n74tj/zuzGL+3a80pCT09GbHBTY+p13...",
  "Image": "qst/aigc/online/2/22b4e2a9-6229-4679-a8da-8f214f9722c9/inpainted_with_mask.png",
  "LimitFlow": false,
  "Message": "success",
  "PuzzleImage": "qst/aigc/online/2/22b4e2a9-6229-4679-a8da-8f214f9722c9/bitwise_and_result.png",
  "RequestId": "3xxx0",
  "StaticPath": "1xxx",
  "Success": true
}

如果初始化接口会返回失败,下表为各个失败返回结果的说明和对应的排查建议:

错误Code

原因说明及排查建议

IllegalUserTag

身份标(prefix)传参不合法。参考开通验证码服务确认该参数是否正确传入。

重要

IllegalUserTag仅适用WebH5客户端接入App客户端接入,不适用微信小程序接入。

IllegalCertifyId

客户自定义生成的certifyId(UserCertifyId)传参格式不合法。请确认参数格式标准为:身份标(prefix)_10位随机字符串(包含大小写字母和数字),代码示例详见UserCertifyId参数代码示例

IllegalScene

场景ID(SceneId)传参不合法。请确认传入的场景ID参数是否正确,确保该场景ID身份标(prefix)关联的账号下创建。

Forbidden.AccountAccessDenied

用户账号欠费。请确认账号状态是否正常。

Throttling

接口限流,超过产品支持QPS。如需更高业务容量,可购买扩容 QPS下单后不会立即生效,请至少提前2天联系客户经理进行沟通和配置。

ThrottlingByStrategy

初始化请求限速,对攻击者频繁请求遍历验证码题库行为进行阻断。

初始化参数校验报错说明

重要

初始化参数校验报错仅适用WebH5客户端接入App客户端接入,不适用微信小程序接入。

在验证码发起初始化请求之前,SDK会对初始化相关的基础参数进行校验,如果参数不合法,将会在浏览器开发者工具console内弹出相应错误。具体校验内容如下表:

字段

报错内容

示例

通用类型校验

传入参数类型不合法,请参见参数说明传入对应类型的值。

immediate参数传入字符串'false',则会报如下错误:

immediate传入参数类型不合法,请参照文档传入对应类型的值。    AliyunCaptcha.js:1

language

language参数传入值不合法,请参见验证码2.0支持的语言

language参数传入'abc',则会报如下错误:

language参数传入值不合法,请参见验证码2.0支持的语言。    AliyunCaptcha.js:1

region

region参数传入值不合法,请参见region参数说明检查此参数是否符合要求。

region参数传入'zh',则会报如下错误:

▶region参数传入值不合法,请参见    AliyunCaptcha.js:1
region参数说明检查此参数是否符合要求。

mode

mode参数传入值不合法,目前支持弹出式(popup)和嵌入式(embed)。请参见mode参数说明检查此参数是否符合要求。

mode参数传入'popout',则会报如下错误:

mode参数传入值错误,目前支持弹出式(popup)和嵌入式(embed)。请参见mode参数说明检查此参数是否符合要求。    AliyunCaptcha.js:1

element/button

element/button参数传入值不合法,请确保element/button元素在页面中存在,且element/button参数和页面上的element/button元素的ID选择器相匹配。

element/button参数传入'abc',页面没有IDabc的元素,则会报如下错误:

element参数传入值不合法,请确保element元素在页面中存在,且element参数和页面上的element元素的id选择器相匹配。    AliyunCaptcha.js:1
button参数传入值不合法,请确保button元素在页面中存在,且button参数和页面上的button元素的id选择器相匹配。    AliyunCaptcha.js:1