空號(hào)檢測 - API文檔

1、概要

1.1 文檔說明

本文檔提供互億無線平臺(tái)空號(hào)檢測服務(wù)的接口對(duì)接指南，開發(fā)者可通過 HTTP 接口調(diào)用空號(hào)檢測服務(wù)。

1.2 接口內(nèi)容

空號(hào)檢測提交、賬戶余額查詢

1.3 提交方式

提交檢測：POST + JSON
余額查詢：GET

1.4 加密要求

所有請(qǐng)求必須使用 HMAC-SHA256 簽名認(rèn)證
【必讀】 簽名機(jī)制文檔：http://www.skoolfish.com/api/request.html

1.5 API ID / API KEY

登錄用戶中心，進(jìn)入【空號(hào)檢測】模塊，在【產(chǎn)品總覽】頁面右側(cè)，如下圖所示：

2、空號(hào)檢測提交接口

2.1 接口描述

批量提交手機(jī)號(hào)進(jìn)行空號(hào)檢測，實(shí)時(shí)返回檢測結(jié)果及計(jì)費(fèi)狀態(tài)，采用POST方式提交。

2.2 請(qǐng)求地址

https://api.ihuyi.com/empty-number/submit

2.3 請(qǐng)求頭

2.4 請(qǐng)求參數(shù)（JSON）

2.5 請(qǐng)求示例

{
  "mobiles": [
    "18221256432",
    "13611111112"
  ]
}

2.6 響應(yīng)參數(shù)

2.7 成功示例

{
  "code": 200,
  "data": [
    {
      "mobile": "18221256432",
      "state": 1,
      "charge_state": 1
    },
    {
      "mobile": "13611111112",
      "state": 2,
      "charge_state": -1
    }
  ],
  "msg": "請(qǐng)求成功"
}

2.8 失敗示例

{
  "code": 4051,
  "msg": "剩余條數(shù)不足"
}

3、余額查詢接口

3.1 接口描述

查詢空號(hào)檢測賬戶剩余額度，采用GET方式提交。

3.2 請(qǐng)求地址

https://api.ihuyi.com/empty-number/balance

3.3 請(qǐng)求頭

3.4 響應(yīng)參數(shù)

3.5 響應(yīng)示例

{
  "code": 2,
  "message": "請(qǐng)求成功",
  "data": {
    "balance": 97
  }
}

4、狀態(tài)碼說明

完整python及php、Java、Go、Shell示例代碼，可參考：https://gitee.com/shsurlink/api-demo/tree/master/hmac-auth