介面文件

發送驗證碼介面

用來發送簡訊。需要提供用戶的api_key，接收簡訊的號碼以及簡訊內容。請求之後會得到此次發送的一個ID，根據此ID可以用來查詢簡訊發送的狀態。

介面地址：https://api.haosms.net/extra_api/otp_msg
請求方式：POST/GET

參數說明：

參數名類型必填說明
api_keyString是用戶的唯一識別符
phoneString是接受驗證碼的手機號碼，號碼格式：1324638088。不用加0086，不接受+86格式
contentString是驗證碼。驗證碼只能是數字加英文字母，且長度不能超過6位
platformString是用於發送驗證碼的通道。比如中國OTP通道2，中國OTP通道1
tmp_idString否用於指定驗證碼資訊模板（不傳使用系統預設OTP模板）

模板說明（tmp_id）：

  • 預設（不需要傳值）：驗證碼：XXXX，請輸入並驗證！請勿向任何人透漏索取驗證碼。請注意:驗證碼有效時間為1小時，過期失效將無法順利驗證！
  • 1：驗證碼：XXXX，您正在修改個人資料，需要進行校驗！請勿向任何人透露索取驗證碼。
  • 2：驗證碼：XXXX，請輸入並校驗！請勿向任何人透露索取驗證碼。
  • 3：驗證碼：XXXX，您正在更改問題和答案，需要進行校驗！請勿向任何人透露索取驗證碼。
  • 4：驗證碼：XXXX，您正在更新密碼，需要進行校驗！請勿向任何人透露索取驗證碼。

返回結果：

範例：

{
    "msg": "a42739630dbe4daa8d4f5f6a530a35bc",
    "result": "成功",
    "code": "",
    "data": null,
    "datas": [],
    "name": "extra_api.otp_msg",
    "request_id": ""
}
  • msg：
    • 成功時：返回具體的任務ID（字串格式）
    • 失敗時：返回錯誤資訊
  • result：
    • 成功時：返回"成功"字元
    • 失敗時：返回"失敗"字元
  • code：返回代碼，通常為空字串
  • data：返回數據，通常為null
  • datas：數據陣列，通常為空陣列
  • name：介面名稱，固定為"extra_api.otp_msg"
  • request_id：請求ID，通常為空字串

請求範例：

https://api.haosms.net/extra_api/otp_msg/?api_key=kknft3xxxx&content=123212&phone=155xxxx827&platform=%E9%AA%8C%E8%AF%81%E7%A0%81%E9%80%9A%E9%81%931

查詢餘額介面

用於查詢帳戶餘額。需要提供用戶的api_key，請求後會返回當前帳戶的餘額資訊。

介面地址：https://api.haosms.net/user/s_balance
請求方式：GET/POST

參數說明：

參數名類型必填說明
api_keyString是用戶的唯一識別符

返回結果：

範例：

{
    "msg": "",
    "result": "True",
    "code": "",
    "data": {
        "balance": 0
    },
    "datas": [],
    "name": "",
    "request_id": ""
}
  • msg：返回訊息，成功時為空字串
  • result：
    • 成功時：返回"True"
    • 失敗時：返回"False"
  • code：返回代碼，成功時為空字串
  • data：返回數據對象
    • balance：帳戶餘額（數字類型）
  • datas：數據陣列，通常為空陣列
  • name：介面名稱，通常為空字串
  • request_id：請求ID，通常為空字串

請求範例：

https://api.haosms.net/user/s_balance?api_key=yourApiKey