# 获取房间用户列表 ## OpenAPI Specification ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /chatroom/v2/room/users: get: summary: 获取房间用户列表 deprecated: false description: '' tags: - HTTP接口/房间接口 parameters: - name: heybox_id in: query description: 用户id required: true example: '84005510' schema: type: string - name: offset in: query description: '' required: true example: '0' schema: type: string - name: limit in: query description: 最大值300 required: true example: '50' schema: type: string - name: room_id in: query description: 房间id required: true example: '3348654035061186560' schema: type: string - name: client_type in: query description: 声明请求黑盒语音 required: true example: heybox_chat schema: type: string default: heybox_chat - name: x_client_type in: query description: 声明客户端类型 required: true example: web schema: type: string default: web - name: os_type in: query description: 声明客户端类型 required: true example: web schema: type: string default: web - name: x_os_type in: query description: 声明客户端是bot required: true example: bot schema: type: string default: bot - name: x_app in: query description: 声明请求黑盒语音 required: true example: heybox_chat schema: type: string default: heybox_chat - name: chat_os_type in: query description: 声明客户端是bot required: true example: bot schema: type: string default: bot - name: chat_version in: query description: 客户端版本号,不同版本返回的结果可能有区别 required: true example: 1.30.0 schema: type: string default: 1.30.0 responses: '200': description: '' content: application/json: schema: type: object properties: msg: type: string result: type: object properties: room_info: type: object properties: room_id: type: string title: 房间id user_count: type: integer title: 用户总数 page: type: integer title: 页数 user_info: type: array items: type: object properties: user_id: type: integer title: 用户id username: type: string title: 用户名 avatar: type: string title: 头像 nickname: type: string title: 昵称 level: type: integer title: 等级 avatar_decoration: type: object properties: src_type: type: string title: 图片类型 src_url: type: string title: 图片url required: - src_type - src_url x-apifox-orders: - src_type - src_url medals: type: array items: type: object properties: name: type: string title: 勋章名 name_short: type: string title: 短勋章名 description: type: string title: 描述 color: type: string title: 颜色 img_url: type: string title: 图片链接 medal_id: type: integer title: 勋章id x-apifox-orders: - name - name_short - description - color - img_url - medal_id title: 勋章 room_nickname: type: string title: 用户房间昵称 joined_at: type: integer title: 加入时间 roles: type: array items: type: string title: 权限组 color: type: integer title: 颜色 game_state: type: string title: 游戏状态 online_state: type: integer title: 在线状态 state: type: integer title: 在线状态 user_state: type: object properties: game_name: type: string title: 游戏名 game_icon: type: string title: 游戏图标 music_name: type: string title: 音乐名 steam_game_name: type: string title: steam游戏名 steam_game_state: type: string title: steam游戏状态 steam_game_icon: type: string title: steam游戏图标 game_time: type: integer title: 游戏时长 music_time: type: integer title: 音乐时长 steam_game_time: type: integer title: steam游戏时长 required: - game_name - game_icon - music_name - steam_game_name - steam_game_state - steam_game_icon - game_time - music_time - steam_game_time x-apifox-orders: - game_name - game_icon - music_name - steam_game_name - steam_game_state - steam_game_icon - game_time - music_time - steam_game_time title: 用户状态 last_login: type: integer title: 上次登录时间 logout_time: type: integer title: 登出时间 ban: type: object properties: operator_id: type: integer title: 操作者id reason: type: string title: 封禁原因 until: type: string title: 封禁时间 notify: type: boolean title: 是否通知 required: - reason - until - notify x-apifox-orders: - operator_id - reason - until - notify title: 封禁信息 bot: type: boolean title: 是否为bot color_list: type: 'null' title: 颜色列表 continuous_days: type: integer title: 连续发言天数 hide_fire_flag: type: boolean title: 隐藏房间火花 required: - user_id - username - avatar - nickname - level - avatar_decoration - medals - room_nickname - joined_at - roles - color - game_state - online_state - state - user_state - last_login - logout_time - ban - bot - color_list - continuous_days - hide_fire_flag x-apifox-orders: - user_id - username - avatar - nickname - level - avatar_decoration - medals - room_nickname - joined_at - roles - color - game_state - online_state - state - user_state - last_login - logout_time - ban - bot - color_list - continuous_days - hide_fire_flag title: 用户信息 online_count: type: integer title: 在线用户数 offline_count: type: integer title: 离线用户数 required: - room_id - user_count - page - user_info - online_count - offline_count x-apifox-orders: - room_id - user_count - page - user_info - online_count - offline_count required: - room_info x-apifox-orders: - room_info status: type: string required: - msg - result - status x-apifox-orders: - msg - result - status headers: {} x-apifox-name: 成功 security: - apikey-header-token: [] x-apifox-folder: HTTP接口/房间接口 x-apifox-status: developing x-run-in-apifox: https://app.apifox.com/web/project/4856361/apis/api-326508787-run components: schemas: {} securitySchemes: token: type: apikey in: header name: token token: ODYzNzY0NDM7MTc1NTc1OTk1NzYyODYzNjQ0NzsxNTU0MDM2NTkxNzk2OTM1OTY5 apikey-header-token: type: apiKey in: header name: token servers: - url: http://prod-cn.your-api-server.com description: 正式环境 security: - apikey-header-token: [] ```