调用VerifyPhoneWithToken接口完成H5本机号码校验。

准备工作

请先完成阿里云账号注册、获取阿里云访问密钥、创建认证方案,更多信息,请参见H5本机号码校验使用流程

QPS限制

本接口的单用户QPS限制为1000次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String VerifyPhoneWithToken

系统规定参数。取值:VerifyPhoneWithToken

PhoneNumber String 1380000****

手机号。

SpToken String Dfafdafad542****

JSSDK获取的号码认证Token。

返回数据

名称 类型 示例值 描述
Code String OK

状态码。

Message String 请求成功

状态码的描述。

RequestId String 8906582E-6722

请求ID。

GateVerify Object

结构体。

VerifyResult String PASS

认证结果。

  • PASS:一致。
  • REJECT:不一致。
  • UNKNOWN:无法判断。
VerifyId String 12134****

流水号。

示例

请求示例

http(s)://dypnsapi.aliyuncs.com/?Action=VerifyPhoneWithToken
&PhoneNumber=1380000****
&SpToken=Dfafdafad542****
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<VerifyPhoneWithTokenResponse>
    <Code>OK</Code>
    <Message>请求成功</Message>
    <RequestId>8906582E-6722</RequestId>
    <GateVerify>
        <VerifyResult>PASS</VerifyResult>
        <VerifyId>12134****</VerifyId>
    </GateVerify>
</VerifyPhoneWithTokenResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Code" : "OK",
  "Message" : "请求成功",
  "RequestId" : "8906582E-6722",
  "GateVerify" : {
    "VerifyResult" : "PASS",
    "VerifyId" : "12134****"
  }
}

错误码

访问错误中心查看更多错误码。

Java SDK

您可以通过添加Maven依赖安装阿里云Java SDK。

JAVA SDK MAVEN坐标


<dependency>
  <groupId>com.aliyun</groupId>
  <artifactId>dypnsapi20170525</artifactId>
  <version>1.0.2</version>
</dependency>