本文へ移動
Bounty Developer

POST/api/messages/reports

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

要約

通報する(人・任意で会話やメッセージ。メッセージを指すと本文の抜粋が運営に渡る)

呼び方と印

ログイン・レート制限

短い時間に呼びすぎると断られる API(レート制限)。断られたら Retry-After の秒数を待って呼び直す。

送るもの(本文)application/json

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

  • targetUserId必須string(uuid)
  • conversationId任意string(uuid) | null
  • messageId任意string(uuid) | null
  • reason必須enum(5)
    • "spam"
    • "harassment"
    • "inappropriate"
    • "impersonation"
    • "other"
  • note任意string | null
    長さ ≤1000

返るもの(応答)201 · application/json

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

  • idstring

失敗したとき(エラー)

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

  • 400入力の誤り(error = invalid_input など)
  • 401未ログイン(unauthorized)/ Bearer が無効(invalid_token。WWW-Authenticate 付き)
  • 403権限が無い
  • 429レート制限(Retry-After 付き)
  • cannot_report_self
  • user_not_found
  • message_not_found
  • not_member
  • rate_limited

呼び出しの見本

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

curl -X POST "https://bounty.spikes.4s.link/api/messages/reports" \
  -H "Authorization: Bearer $BEARER_AUTH" \
  -H "Content-Type: application/json" \
  -d '{
    "targetUserId": "00000000-0000-4000-8000-000000000000",
    "reason": "spam"
  }'
POST /api/messages/reports | Bounty Developer