查詢餘額

若您需要即時取得 EngageLab SMS 帳戶的可用餘額情況，可以呼叫本介面。介面將返回您帳戶的普通餘額、贈送餘額以及總餘額。

呼叫位址

GET https://smsapi.engagelab.com/v1/balance

呼叫驗證

請參考呼叫驗證了解如何進行 API 鑑權。

請求範例

請求頭

GET /v1/balance HTTP/1.1 Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

              
              GET /v1/balance  HTTP/1.1
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

此代碼塊在浮窗中顯示

請求體

無

請求參數

無

返回參數

成功返回

http 狀態碼為 200，響應體包含欄位如下：

欄位	類型	選項	描述
balance10000	Integer	必填	普通餘額，乘以 10000 後的整型值
gift_balance10000	Integer	必填	贈送餘額，乘以 10000 後的整型值
balance	Number	必填	普通餘額，浮點型
gift_balance	Number	必填	贈送餘額，浮點型
total_balance10000	Integer	必填	總餘額，等於普通餘額與贈送餘額之和，乘以 10000 後的整型值
total_balance	Number	必填	總餘額，等於普通餘額與贈送餘額之和，浮點型

{ "balance10000": 123456, "gift_balance10000": 20000, "balance": 12.3456, "gift_balance": 2, "total_balance10000": 143456, "total_balance": 14.3456 }

              
              {
    "balance10000": 123456,
    "gift_balance10000": 20000,
    "balance": 12.3456,
    "gift_balance": 2,
    "total_balance10000": 143456,
    "total_balance": 14.3456
}

此代碼塊在浮窗中顯示

開發建議 建議呼叫方優先使用 balance10000、gift_balance10000 和 total_balance10000 欄位自行格式化餘額，以避免浮點精度問題。

失敗返回

http 狀態碼為 4xx 或者 5xx，響應體包含欄位如下：

欄位	類型	選項	描述
code	Integer	必填	錯誤碼，詳見錯誤碼說明
message	String	必填	錯誤詳情

{ "code": 2001, "message": "invalid token" }

              
              {
    "code": 2001,
    "message": "invalid token"
}

此代碼塊在浮窗中顯示

錯誤碼

錯誤碼	http code	說明
1000	500	內部錯誤，請稍後重試
2001	401	鑑權失敗，未攜帶正確的 token，或 token 對應的商戶不存在
2002	401	鑑權失敗，token 已過期或已被禁用
2002	403	商戶已被刪除