调用DescribeEmptyNumberDetect接口获取号码空号检测返回结果。

使用说明

此接口需开通空号检测查询功能才能调用，详情请咨询您的商务经理。

QPS限制

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

授权信息

默认仅限阿里云账号使用本接口，RAM用户只有在被授予了相关API操作权限后方可使用。具体请参见为RAM用户授权。

调试

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

请求参数

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

系统规定参数。取值：DescribeEmptyNumberDetect。

Phone String 是 13900001234

传入的手机号。可填写单个手机号或加密后多个手机号，多个手机号之间使用英文逗号分割，传入的多个手机号个数不能超过200个且只能为同一种加密方式。
EncryptType String 是 NORMAL

用于描述PHONE字段中，对应号码的加密方式。取值：

  • NORMAL
  • MD5
  • SHA256

其中取值为NORMAL，表示PHONE字段中的手机号不做加密处理。

返回数据

名称 类型 示例值 描述
RequestId String 68A40250-50CD-034C-B728-0BD135850177

请求ID。
Code String OK

返回状态码。取值：

  • OK：成功。
  • InvalidPhoneNumber.Check：手机号非法。
  • LimitExceeded.Phone：查询号码数量超出最大限制200个。
Message String OK

返回状态码描述。
Data Array of DataList

空号检测返回结果信息。
Number String 13900001234

传入的手机号。
Status String SUSPECT_EMPTY

检测手机号返回状态。取值：

  • EMPTY：空号。
  • NORMAL：正常。
  • SUSPECT_EMPTY：疑似空号。
  • UNKNOWN：未知。

示例

请求示例

http(s)://dytnsapi.aliyuncs.com/?Action=DescribeEmptyNumberDetect
&Phone=13900001234
&EncryptType=NORMAL
&公共请求参数

正常返回示例

XML格式 

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

<DescribeEmptyNumberDetectResponse>
    <RequestId>68A40250-50CD-034C-B728-0BD135850177</RequestId>
    <Code>OK</Code>
    <Message>OK</Message>
    <Data>
        <Number>13900001234</Number>
        <Status>SUSPECT_EMPTY</Status>
    </Data>
</DescribeEmptyNumberDetectResponse>

JSON格式 

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

{
  "RequestId" : "68A40250-50CD-034C-B728-0BD135850177",
  "Code" : "OK",
  "Message" : "OK",
  "Data" : [ {
    "Number" : "13900001234",
    "Status" : "SUSPECT_EMPTY"
  } ]
}

错误码

HttpCode 错误码 错误信息 描述
400 Insufficient.Balance You have an insufficient balance. 余额不足
400 Product.Unsubscript You have not subscribed to the specified product. 未订阅该功能
400 Ram.PermissionDeny You are not authorized to perform the operation. 权限不足
400 System.LimitControl The system is under flow control. 系统限流控制
400 Unknown.ResourceOwnerId The resource does not belong to the current user. 资源不属于当前用户
403 Permission.NotAuthorized You are not authorized to perform the operation. 您没有权限执行此操作
500 InternalError A system error occurred. 系统异常

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