跳转到主要内容
本文将介绍一种 手机号状态查询 API 对接说明,它可用于验证手机号的状态,您可以输入手机号进行查询。

申请流程

要使用 API,需要先到 手机号状态查询 API 对应页面申请对应的服务,进入页面之后,点击「Acquire」按钮,如图所示: 如果你尚未登录或注册,会自动跳转到登录页面邀请您来注册和登录,登录注册之后会自动返回当前页面。 在首次申请时会有免费额度赠送,可以免费使用该 API。

基本使用

首先先了解下基本的使用方式,就是输入手机号码,便可获得处理后的结果,首先需要简单地传递一个 mobile 字段。我们接下来就可以在界面上填写对应的内容,如图所示:

可以看到这里我们设置了 Request Headers,包括:
  • accept:想要接收怎样格式的响应结果,这里填写为 application/json,即 JSON 格式。
  • authorization:调用 API 的密钥,申请之后可以直接下拉选择。
另外设置了 Request Body,包括:
  • mobile:需要处理的手机号码,是必选参数。
  • encryption:可选,敏感字段加密参数(如需上送密文)。
选择之后,可以发现右侧也生成了对应代码,如图所示:

点击「Try」按钮即可进行测试,如上图所示,这里我们就得到了如下结果:
{
  "result": "0",
  "description": "成功",
  "status_code": 0
}
返回结果一共有多个字段,介绍如下:
  • result,认证结果码,收费情况如下。
    • 收费结果码:
      • 0:成功
    • 不收费结果码:
      • -1:未查询到结果
      • -2:手机号格式不正确
      • -3:验证中心服务繁忙
  • description,业务结果描述。
  • status_code,状态码:
    • 0:正常
    • 1:停机
    • 2:销号
    • 3:空号
    • 4:不在网
    • 99:未知状态
可以看出这个手机号码的状态已经查询出来了。 另外如果想生成对应的对接代码,可以直接复制生成,例如 CURL 的代码如下:
curl -X POST 'https://api.acedata.cloud/identity/phone/check-1e' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "mobile": "***"
}'
Python 的对接代码如下:
import requests

url = "https://api.acedata.cloud/identity/phone/check-1e"

headers = {
    "accept": "application/json",
    "authorization": "Bearer {token}",
    "content-type": "application/json"
}

payload = {
    "mobile": "***"
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)

错误处理

在调用 API 时,如果遇到错误,API 会返回相应的错误代码和信息。例如:
  • 400 token_mismatched:Bad request, possibly due to missing or invalid parameters.
  • 400 api_not_implemented:Bad request, possibly due to missing or invalid parameters.
  • 401 invalid_token:Unauthorized, invalid or missing authorization token.
  • 429 too_many_requests:Too many requests, you have exceeded the rate limit.
  • 500 api_error:Internal server error, something went wrong on the server.

错误响应示例

{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "fetch failed"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}

结论

通过本文档,您已经了解了如何使用 手机号状态查询 API 进行验证手机号的状态,您可以输入手机号进行查询。希望本文档能帮助您更好地对接和使用该 API。如有任何问题,请随时联系我们的技术支持团队。