アカウント

残高とコスト見積もり

GET/v1/balance

現在のUSD残高。

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 ドキュメント