调用VerifyPhoneWithToken使用Token验证手机号码_号码认证服务(PNVS)-阿里云帮助中心

完成H5本机号码校验。

接口说明

准备工作

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

QPS 限制

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

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
dypns:VerifyPhoneWithToken	Write	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
PhoneNumber	string	是	手机号。	1380000****
SpToken	string	是	JSSDK 获取的号码认证 Token。	Dfafdafad542****

返回参数

名称	类型	描述	示例值
	object
Code	string	状态码。返回 OK 代表请求成功。其他错误码，请参见服务端 API 返回码。	OK
Message	string	状态码的描述。	请求成功
RequestId	string	请求 ID。	8906582E-6722
GateVerify	object	结构体。
VerifyResult	string	认证结果。 PASS：一致。 REJECT：不一致。 UNKNOWN：无法判断。	PASS
VerifyId	string	流水号。	12134****

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
400	RamPermissionDeny	The user is not authorized to operate on the specified resource.	没有访问权限
400	UnknowError	The requested service is not available now, please try again later.	未知异常，请重新再试
400	Unsupported.Account	Your account has not activated the product.	你的账号没有开通本产品。
400	MobileNumberIllgeal	The specified mobile phone number is invalid.	手机号码不合法
400	InvalidToken	The token is invalid.	令牌无效
400	VerifySchemeNotExist	The specified verify scheme already exists.	认证方案不存在
500	SystemError	A system error occurred.	系统异常

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

变更历史

变更时间

变更内容概要

操作

2023-06-07

OpenAPI 错误码发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	删除错误码：400
	删除错误码：500

补充说明

Java SDK

您可以通过添加 Maven 依赖安装阿里云 Java SDK。SDK 版本会持续更新，具体版本请以 OpenAPI 页面为准。

JAVA SDK MAVEN 坐标

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

校验失败返回示例

JSON 格式

{
  "Code": "OK",
  "Message": "请求成功",
  "RequestId": "6CAB3AC6-B7C3",
  "GateVerify": {
    "VerifyResult": "REJECT",
    "VerifyId": "12134****"
  }
}

请求结果异常返回示例

JSON 格式

{
  "Code": "isv.CARRIER_NOT_MATCH",
  "Message": "验证号码与实际流量号码运营商不一致",
  "RequestId": "6EA6E9F5-37CC"
}