Referenz

Idempotente Anfragen

Als Markdown anzeigen OpenAPI-Spezifikation

Netzwerke können ausfallen. Wenn eine Sendeanfrage ein Timeout hat, wissen Sie nicht, ob sie akzeptiert wurde. Senden Sie POST /v1/messages und POST /v1/batches mit einem Idempotency-Key-Header und wiederholen Sie mit demselben Schlüssel.

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

Regeln

Ein Schlüssel ist eine beliebige Zeichenkette bis zu 255 Zeichen. Verwenden Sie etwas, das das Ereignis benennt: eine Bestell-ID und Schritt oder eine UUID, die vor dem ersten Versuch erstellt wurde.
Eine akzeptierte Anfrage (202) wird 24 Stunden pro Konto gespeichert. Derselbe Schlüssel mit demselben Body liefert die erste Antwort erneut zurück, mit dem Header Idempotent-Replayed: true, und sendet nichts.
Derselbe Schlüssel mit einem anderen Body antwortet mit 409 idempotency_conflict.
Anfragen, die mit einem Fehler fehlschlagen, werden nicht gespeichert, sodass Sie sie korrigieren und mit demselben Schlüssel wiederholen können.

ZurückAnfragelimits WeiterCodebeispiele