Довідка

Ідемпотентні запити

Переглянути як Markdown Специфікація OpenAPI

Мережі можуть відмовляти. Якщо запит на надсилання завершується тайм-аутом, ви не можете знати, чи він був прийнятий. Надсилайте 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 символів. Використовуйте щось, що іменує подію: ідентифікатор замовлення та крок, або UUID, створений перед першою спробою.
Прийнятий запит (202) зберігається протягом 24 годин для кожного облікового запису. Той самий ключ з тим самим тілом повертає першу відповідь знову, з заголовком Idempotent-Replayed: true, і нічого не надсилає.
Той самий ключ з іншим тілом відповідає 409 idempotency_conflict.
Запити, які завершуються помилкою, не зберігаються, тому ви можете виправити їх і повторити з тим самим ключем.

ПопередняЛіміти запитів ДаліПриклади коду