Referencja

Żądania idempotentne

Sieci zawodzą. Jeśli żądanie wysłania przekroczy limit czasu, nie możesz wiedzieć, czy zostało zaakceptowane. Wyślij POST /v1/messages i POST /v1/batches z nagłówkiem Idempotency-Key i ponów próbę z tym samym kluczem.

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."}'

Zasady

  • Klucz to dowolny ciąg znaków do 255 znaków. Użyj czegoś, co nazywa zdarzenie: identyfikator zamówienia i krok, lub UUID utworzone przed pierwszą próbą.
  • Zaakceptowane żądanie (202) jest zapamiętywane przez 24 godziny na konto. Ten sam klucz z tym samym ciałem zwraca pierwszą odpowiedź ponownie, z nagłówkiem Idempotent-Replayed: true, i nic nie wysyła.
  • Ten sam klucz z innym ciałem odpowiada 409 idempotency_conflict.
  • Żądania, które kończą się błędem, nie są zapamiętywane, więc możesz je poprawić i ponowić próbę z tym samym kluczem.
Żądania idempotentne | Dokumentacja BulkSMSAPI