本文へ移動
Bounty Developer

POST/api/boshu/manage/{id}/communications/retry

「BOSHU の管理」の分類の、新しく作る、または操作を実行するために内容を送る API。ログインした本人として呼ぶ。

要約

人の募集管理者が固定済み文面と現在の資格を再検査して再配送を予約する

呼び方と印

ログイン

URL に付ける値（パラメータ）

経路の中の波かっこの部分と、URL の ? の後ろに付ける値。「必須」の印があるものは省けない。

  • idpath必須string(uuid)

送るもの（本文）application/json

送る本文の欄。「必須」の印がある欄は省けない。

  • deliveryId必須string(uuid)
  • expectedPayloadHash必須string
    /^[a-f0-9]{64}$/

返るもの（応答）200 · application/json

成功したときに返る形。入れ子の欄は、その行を押すと開く・閉じる。「任意」の印がある欄は返らないことがある。

  • deliveryIdstring(uuid)
  • queuedboolean

失敗したとき（エラー）

失敗したときの状態コードと、その意味。本文の error の値で、プログラムが失敗の種類を見分けられる。

  • 400HTTP 400（x-bounty-error-codes を参照）
  • 401未ログイン（unauthorized）/ Bearer が無効（invalid_token。WWW-Authenticate 付き）
  • 403HTTP 403（x-bounty-error-codes を参照）
  • 404HTTP 404（x-bounty-error-codes を参照）
  • 409HTTP 409（x-bounty-error-codes を参照）
  • 413HTTP 413（x-bounty-error-codes を参照）
  • 415HTTP 415（x-bounty-error-codes を参照）
  • 428HTTP 428（x-bounty-error-codes を参照）
  • invalid_input
  • human_action_required
  • invalid_origin
  • unsupported_media_type
  • forbidden
  • call_not_found
  • delivery_changed
  • consent_required

呼び出しの見本

そのまま試せる呼び出しの例。curl と fetch をタブで切り替える。ID やトークンは自分の値に置き換える。

curl -X POST "https://bounty.spikes.4s.link/api/boshu/manage/{id}/communications/retry" \
  -H "Authorization: Bearer $BEARER_AUTH" \
  -H "Content-Type: application/json" \
  -d '{
    "deliveryId": "00000000-0000-4000-8000-000000000000",
    "expectedPayloadHash": "string"
  }'
POST /api/boshu/manage/{id}/communications/retry | Bounty Developer