本文へ移動
Bounty Developer

POST/api/messages/{id}/keep

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

要約

このチャットを残す（すべての会話に同じ規則。イベント終了から消える時刻までのあいだに、メンバーの誰か 1 人が押せば全員に残る。イベント終了前は 409 keep_not_open で message = 押せるようになる時刻の ISO。本文なし）

呼び方と印

ログイン・レート制限

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

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

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

  • idpath必須string(uuid)

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

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

  • keptAtstring
  • keptBystring
  • expiresAtstring
  • alreadyboolean

失敗したとき（エラー）

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

  • 400入力の誤り（error = invalid_input など）
  • 401未ログイン（unauthorized）/ Bearer が無効（invalid_token。WWW-Authenticate 付き）
  • 403権限が無い
  • 429レート制限（Retry-After 付き）
  • conversation_not_found
  • conversation_expired
  • not_member
  • not_keepable
  • keep_not_open
  • keep_window_passed
  • rate_limited

呼び出しの見本

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

curl -X POST "https://bounty.spikes.4s.link/api/messages/{id}/keep" \
  -H "Authorization: Bearer $BEARER_AUTH"
POST /api/messages/{id}/keep | Bounty Developer