帳戶

餘額與成本估算

GET/v1/balance

當前餘額(美元)。

curl https://bulksmsapi.cc/v1/balance \
  -H "Authorization: Bearer $BULKSMSAPI_KEY"
200 OKJSON
{
  "object": "balance",
  "balance": "184.32950",
  "currency": "USD"
}

估算

POST/v1/estimates

使用與 POST /v1/batches 相同的主體,並返回其成本。不發送任何內容,也不收取任何費用。

curl https://bulksmsapi.cc/v1/estimates \
  -H "Authorization: Bearer $BULKSMSAPI_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text": "Doors open at 18:00 tonight.", "to": ["+14155550123", "+447400123456", "+447400123456", "12"]}'
200 OKJSON
{
  "object": "estimate",
  "recipients": 2,
  "set_aside": [
    { "to": "+447400123456", "reason": "duplicate" },
    { "to": "12", "reason": "invalid_number" }
  ],
  "encoding": "GSM-7",
  "segments": 2,
  "max_segments": 1,
  "cost": "0.01294",
  "currency": "USD",
  "by_country": [
    { "country": "US", "recipients": 1, "segments": 1, "cost": "0.00507" },
    { "country": "GB", "recipients": 1, "segments": 1, "cost": "0.00787" }
  ]
}

餘額不足

成本超過餘額的請求將回應 402 top_up_required,並在訊息中包含兩個金額,且不發送任何內容。在發送大批次前檢查餘額,或先進行估算,並在控制台進行充值。

餘額與成本估算 | BulkSMSAPI 文件