メンション候補の取得
GET
/chat-rooms/:id/mention-candidates@ メンションできる相手を返します。メッセージ送信時の mentions は、ここに出てくる相手だけが有効です(サーバー側で同じ判定をします)。コミュニティチャットでは承認済みのコミュニティメンバーが対象で、メンバー一覧 API(ChatRoomMember の行)とは集合が異なります。イベントチャットではメンションを使わないため常に空配列を返します。ページネーションはありません。limit で打ち切られるので、絞り込みは q で行ってください。
| 認証 | 要ログイン |
|---|
パスパラメータ
idstring必須チャットルーム ID。
クエリパラメータ
qstring名前・スラッグの部分一致。半角/全角スペース区切りで AND 検索。
limitnumber最大件数。既定 20、上限 50。**上限で打ち切られます**(続きは取得できないので q で絞ってください)。
レスポンス
| フィールド | 型 | 説明 |
|---|---|---|
users | User[] | メンションできるユーザーの配列。 |
リクエスト
curl https://api.4s.link/chat-rooms/ID/mention-candidates \-H "Authorization: Bearer 4s_at_..."
レスポンス例
{"users": [{ "id": "a1b2c3d4-...", "slug": "taro", "firstName": "太郎", "lastName": "山田", "nativeName": "山田太郎", "avatarUrl": "https://.../avatar.png" }]}