チャットのメンバー一覧を取得するAPIの仕様
公式仕様ではチャットのメンバー一覧を取得するAPIの仕様は以下のようになっています。このAPIを利用することで指定されたルームIDのメンバー一覧を取得でき、各メンバーのアカウント情報や役割などを含む詳細情報を取得することができるようです。
リクエスト仕様
- HTTP メソッド:
GET
- リクエストURL:
https://api.chatwork.com/v2/rooms/{room_id}/members
パラメータ
パラメータ名 | 種類 | 必須 | 型 | 説明 |
---|---|---|---|---|
room_id |
パス | 必須 | integer (int64 ) |
対象のチャットルームのID |
room_id
はURLパスに含めて指定する必要があります。
レスポンス仕様
- ステータスコード:
200 OK
(成功時)
レスポンスボディ
Content-Type: application/json
形式: 配列(array
)形式でメンバーのオブジェクトを返します。
サンプルレスポンス
[
{
"account_id": 12345,
"role": "member",
"name": "John Doe",
"chatwork_id": "johndoe",
"organization_id": 1001,
"organization_name": "ABC Corporation",
"department": "Sales",
"avatar_image_url": "https://example.com/avatar/johndoe.png"
},
{
"account_id": 67890,
"role": "admin",
"name": "Jane Smith",
"chatwork_id": "janesmith",
"organization_id": 1002,
"organization_name": "XYZ Inc.",
"department": "HR",
"avatar_image_url": "https://example.com/avatar/janesmith.png"
}
]
レスポンスの詳細
フィールド名 | 型 | 説明 |
---|---|---|
account_id |
integer |
メンバーのアカウントID |
role |
string |
メンバーの役割(admin や member など) |
name |
string |
メンバーの名前 |
chatwork_id |
string |
メンバーのChatwork ID |
organization_id |
integer |
メンバーの所属する組織のID |
organization_name |
string |
メンバーの所属する組織名 |
department |
string |
メンバーの部署名 |
avatar_image_url |
string |
メンバーのアバター画像のURL |