首页 阿里云验证码 服务端API参考 Web/HTML5业务类型服务API

Web/HTML5业务类型服务API

阿里云验证码提供服务端API接口校验验证码结果,确定前端页面(包含PC端Web页面和移动端WAP/HTML5页面)获取到的签名串是否由验证码服务端颁发。

请求参数

名称

类型

是否必须

描述

Action

string

要执行的操作。取值:AuthenticateSig

Token

string

请求唯一标识。

Sig

string

签名串。

SessionId

string

会话ID。

Scene

string

使用场景标识。在统计报表中将根据该字段的内容进行分类展示。

AppKey

string

阿里云验证码配置对应的Appkey。

RemoteIp

string

客户端IP。

返回参数

名称

类型

描述

success

boolean

调用返回状态,取值:

  • true:表示调用成功。

  • false:表示调用失败。

data

json

调用返回结果。

-RequestId

string

请求ID。

-Msg

string

调用返回信息。

-Code

string

阿里云验证码结果编码,取值:

  • 100:表示验证通过。

  • 900:表示验证不通过。

示例

请求示例

http://afs.aliyuncs.com/?Action=AuthenticateSig
&SessionId=<SenderId>
&Scene=Scene
&Token=123e4567-e89b-12d3-a456-426655440000
&Sig=1
&AppKey=<AppKey>
&RemoteIp=192.168.XX.XX
&<公共请求参数>

正常返回示例

JSON格式

{
"Msg": "pass_1",
"RequestId": "B0AEA6F4-14B3-5B94-8E8B-04889C1C1336",
"Code": 100,
}

错误码

含义

400

参数错误。

500

系统内部错误。

阿里云首页 阿里云验证码 相关技术圈