本文へ移動
Bounty Developer

GET/api/messages

「メッセージ」の分類の、情報を読み出す API。ログインした本人として呼ぶ。

要約

トーク一覧（今メンバーの生きている会話）と、招待されているグループ（invitations）。?event=<slug> はそのイベントが記録された会話だけ

呼び方と印

ログイン・ポーリング

画面が一定の間隔で呼び直す前提の API（ポーリング）。

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

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

  • eventquery任意string
    /^[A-Za-z0-9_-]{1,100}$/

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

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

  • revinteger
  • nowstring
  • conversationsarray<object>
    • idstring
    • kind"dm" | "group"
    • groupKindenum(7) | null"adhoc" "referral" "staff" "trio" "content" "boshu" "event"
    • titlestring
    • peoplearray<object>
      • idstring
      • displayNamestring
      • avatarUrlstring | null
      • titlestring | null
      • orgNamestring | null
    • memberCountinteger
    • lastMessageobject | null
      • kindenum(6)"text" "stamp" "system" "image" "unsent" "location"
      • bodystring
      • userIdstring | null
      • senderNamestring | null
      • createdAtstring
    • unreadinteger
    • expiresAtstring
    • updatedAtstring
    • myRole"owner" | "member"
    • mutedUntilstring | null
    • mutedboolean
    • origin任意"match" | "trio" | null
    • keep任意object | null
      • phase"before" | "open" | "closed" | "kept"
      • opensAtstring
      • closesAtstring
      • keptAtstring | null
      • keptBystring | null
    • trio任意object | null
      • idstring
      • reasonstring
      • activatedboolean
    • eventsarray<object>
      • idstring
      • slugstring
      • titlestring
  • invitationsarray<object>
    • conversationIdstring
    • namestring
    • groupKindenum(7) | null"adhoc" "referral" "staff" "trio" "content" "boshu" "event"
    • invitedByobject | null
      • idstring
      • displayNamestring
      • avatarUrlstring | null
      • titlestring | null
      • orgNamestring | null
    • invitedAtstring
    • memberCountinteger
    • peoplearray<object>
      • idstring
      • displayNamestring
      • avatarUrlstring | null
      • titlestring | null
      • orgNamestring | null
    • expiresAtstring
  • announcements任意object
    • countinteger
    • unreadinteger
    • lastobject | null
      • titlestring
      • createdAtstring

失敗したとき（エラー）

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

  • 400入力の誤り（error = invalid_input など）
  • 401未ログイン（unauthorized）/ Bearer が無効（invalid_token。WWW-Authenticate 付き）
  • 403権限が無い
  • event_not_found

呼び出しの見本

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

curl "https://bounty.spikes.4s.link/api/messages" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET /api/messages | Bounty Developer