リファレンス

べき等リクエスト

ネットワークは失敗します。送信リクエストがタイムアウトした場合、受理されたかどうか分かりません。POST /v1/messagesとPOST /v1/batchesにはIdempotency-Keyヘッダーを付け、同じキーで再試行してください。

curl https://bulksmsapi.cc/v1/messages \
  -H "Authorization: Bearer $BULKSMSAPI_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: order-55102-shipped" \
  -d '{"to": "+14155550123", "text": "Order 55102 has shipped."}'

ルール

  • キーは255文字までの任意の文字列です。注文IDとステップ、または初回試行前に生成したUUIDなど、イベントを特定できるものを使用してください。
  • 受理されたリクエスト(202)はアカウントごとに24時間記憶されます。同じキーと本文でリクエストすると、Idempotent-Replayed: trueヘッダー付きで最初の応答が再送され、実際の送信は行われません。
  • 同じキーで本文が異なる場合、409 idempotency_conflictが返ります。
  • エラーで失敗したリクエストは記憶されないため、修正後同じキーで再試行できます。
べき等リクエスト | BulkSMSAPI ドキュメント