本文へ移動
Bounty Developer

GET/api/boshu/manage/{id}/communications

「BOSHU の管理」の分類の、情報を読み出す API。ログインした本人として呼ぶ。

要約

募集管理者が配送件数と宛先を伏せた配送状態を確認する

呼び方と印

ログイン

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

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

  • idpath必須string(uuid)

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

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

  • configuredboolean
  • countsobject
    • unverifiedinteger≥0
    • unsentinteger≥0
    • sendinginteger≥0
    • retryinteger≥0
    • sentinteger≥0
    • suppressedinteger≥0
    • unknowninteger≥0
  • rowsarray<object>件数 ≤100
    • idstring(uuid)
    • applicationIdstring(uuid) | null
    • kindenum(9)"contact_verify" "application_received" "stage_passed" "stage_rejected" "final_accepted" "final_waitlisted" "correction" "organizer_message" "chat_digest"
    • statusenum(7)"pending" "claimed" "sent" "retry" "failed" "suppressed" "unknown"
    • templateRevisioninteger≥0
    • recipientRevisioninteger≥0
    • createdAtstring(date-time)
    • sentAtstring(date-time) | null
    • lastCodestring | null長さ ≤80
    • payloadHashstring/^[a-f0-9]{64}$/

失敗したとき（エラー）

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

  • 400入力の誤り（error = invalid_input など）
  • 401未ログイン（unauthorized）/ Bearer が無効（invalid_token。WWW-Authenticate 付き）
  • 403HTTP 403（x-bounty-error-codes を参照）
  • 404HTTP 404（x-bounty-error-codes を参照）
  • 428HTTP 428（x-bounty-error-codes を参照）
  • forbidden
  • call_not_found
  • consent_required

呼び出しの見本

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

curl "https://bounty.spikes.4s.link/api/boshu/manage/{id}/communications" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET /api/boshu/manage/{id}/communications | Bounty Developer