メッセージ
メッセージの API。トークの一覧と会話を読み、文字・スタンプ・画像を送る。DM やグループを作る、招待する、既読にする、ミュート・ブロック・通報するのもここ。
この分類のあらまし
- 誰が呼べるか
ログインした本人。会話と画像を読めるのは、その会話の今のメンバーだけ。
ログイン 27 件
- 件数と印
この分類の API は 27 件・ポーリング 2 件・レート制限 13 件
画面が一定の間隔で呼び直す前提の API(ポーリング)。
短い時間に呼びすぎると断られる API(レート制限)。断られたら Retry-After の秒数を待って呼び直す。
- 契約での分類の説明
メッセージ
よく使う順番
上から順に呼ぶことが多い組み合わせ。行を押すと、その API の詳細が右に開く(スマホは下から)。
すべての API27 件
この分類の API をすべて並べている。行を押すと、頁を移らずにその API の詳細が右に開き、送るもの・返るもの・呼び出しの見本が読める。閉じると一覧の同じ位置に戻る。
行の左の札は HTTP のメソッド。GET は情報の取得、POST は作成や操作の実行、PUT と PATCH は更新、DELETE は削除を表す。
- トーク一覧(今メンバーの生きている会話)と、招待されているグループ(invitations)。?event=<slug> はそのイベントが記録された会話だけGET取得
/api/messagesログイン・ポーリング - 会話(メンバーと既読の位置・入力中・メッセージ)。?after=<ISO> はそれより後に作られた・更新されたメッセージだけ(ポーリング。前回の now を渡す)、?before=<page.before>&limit= は古いページ。ETag / 304GET取得
/api/messages/{id}ログイン・ポーリング - 送信(text / stamp / location。replyToId で返信。本文の @表示名 はメンション = ミュートを越えて通知。location は { kind, location: { mapId, x, y, label } } で現在の会場図の場所だけ。本文は地点名、通知は「場所が送られました」だけ)POST作成・操作
/api/messages/{id}ログイン・レート制限 - グループ名を変える(owner だけ。system メッセージが残る)PATCH一部を更新
/api/messages/{id}ログイン・レート制限 - 既読にする(他の人からの未読があったときだけ既読の位置を進める = advanced)POST作成・操作
/api/messages/{id}/readログイン - 入力中({ typing?: boolean }。印の寿命は 6 秒。入力している間は数秒おきに送り直す)POST作成・操作
/api/messages/{id}/typingログイン・レート制限 - 画像を送る(multipart/form-data: file・caption・replyToId。JPEG / PNG / WebP / GIF・4 MB まで。SVG は不可)POST作成・操作
/api/messages/{id}/imagesログイン・レート制限 - リアクションのトグル(語彙は lib/messages/reactions-vocab.ts。1 人 1 つ・同じ絵文字で外す・別の絵文字で付け替え。通知は作らない)POST作成・操作
/api/messages/{id}/messages/{messageId}/reactionsログイン・レート制限 - 送信取消(送った本人が 24 時間以内。跡が残り、本文・画像・リアクションは消える)POST作成・操作
/api/messages/{id}/messages/{messageId}/unsendログイン - グループへ招待する(今のメンバーなら誰でも、自分のつながりを。招待された人は受けるまでメンバーではない)POST作成・操作
/api/messages/{id}/membersログイン・レート制限 - メンバー(招待中を含む)を外す(owner だけ。外された人は QR から入り直せない)DELETE削除
/api/messages/{id}/members/{userId}ログイン・レート制限 - オーナーを譲る(owner だけ)POST作成・操作
/api/messages/{id}/ownerログイン - 招待を受ける(accept = メンバーになる)/ 断る(decline)POST作成・操作
/api/messages/{id}/invitationログイン - この会話のミュート(1h / event_end / forever / off)。メッセージの通知とプッシュを止める。メンションは止めないPOST作成・操作
/api/messages/{id}/muteログイン - メッセージの画像(今のメンバーだけ。Cache-Control: private・ETag。公開 URL は無い)GET取得
/api/messages/attachments/{id}ログイン - このチャットを残す(すべての会話に同じ規則。イベント終了から消える時刻までのあいだに、メンバーの誰か 1 人が押せば全員に残る。イベント終了前は 409 keep_not_open で message = 押せるようになる時刻の ISO。本文なし)POST作成・操作
/api/messages/{id}/keepログイン・レート制限 - まとめて残す(選んだ会話を 1 回で。1 件ずつ「このチャットを残す」と同じ規則で、id ごとの結果 kept / already_kept / not_open / not_found を返す。一覧は GET /api/messages の conversations[].keep と expiresAt)POST作成・操作
/api/messages/keepログイン・レート制限 - DM を開く(無ければ作る。つながり・マッチ・ミートのどれかがあれば開ける。ブロックがあれば 403 blocked。新しく作るときだけ数える)POST作成・操作
/api/messages/dmログイン・レート制限 - グループを作る(選んだつながりはすぐメンバー・候補から選んだ人は招待。作成者は owner。消える時刻はすべての会話と同じ = イベント終了 + ゲーム設定 match.chatKeepDays)POST作成・操作
/api/messages/groupsログイン・レート制限 - つながり(会った / マッチした相手)GET取得
/api/messages/connectionsログイン - グループに足す候補(友だちの友だち・同じ招待グループの人。選ぶと招待になる)GET取得
/api/messages/suggestionsログイン - 自分がブロックしている人GET取得
/api/messages/blocksログイン - ブロックする(DM・招待を双方向に止め、共有グループでは相手の発言を自分の画面で隠す)POST作成・操作
/api/messages/blocksログイン - ブロックを解除するDELETE削除
/api/messages/blocks/{userId}ログイン - 通報する(人・任意で会話やメッセージ。メッセージを指すと本文の抜粋が運営に渡る)POST作成・操作
/api/messages/reportsログイン・レート制限 - グループから抜ける(DM は抜けられない)POST作成・操作
/api/messages/{id}/leaveログイン - QR(/g/<token>)からグループに参加するPOST作成・操作
/api/messages/groups/joinログイン・レート制限