获取房间用户列表 - 黑盒语音机器人帮助文档

请求参数

Authorization

在 header 添加参数

token

示例：

token: ********************

Query 参数

heybox_id

string

用户id

必需

示例值:

84005510

offset

string

必需

示例值:

0

limit

string

最大值300

必需

示例值:

50

room_id

string

房间id

必需

示例值:

3348654035061186560

client_type

string

声明请求黑盒语音

必需

默认值:

heybox_chat

x_client_type

string

声明客户端类型

必需

默认值:

web

os_type

string

声明客户端类型

必需

默认值:

web

x_os_type

string

声明客户端是bot

必需

默认值:

bot

x_app

string

声明请求黑盒语音

必需

默认值:

heybox_chat

chat_os_type

string

声明客户端是bot

必需

默认值:

bot

chat_version

string

必需

客户端版本号,不同版本返回的结果可能有区别

默认值:

1.30.0

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://chat.xiaoheihe.cn/chatroom/v2/room/users?heybox_id=84005510&offset=0&limit=50&room_id=3348654035061186560&client_type=&x_client_type=&os_type=&x_os_type=&x_app=&chat_os_type=&chat_version=' \
--header 'token;'

返回响应

🟢200成功

application/json

Body

msg

string

必需

result

object

必需

room_info

object

必需

status

string

必需

示例

{
    "msg": "string",
    "result": {
        "room_info": {
            "room_id": "string",
            "user_count": 0,
            "page": 0,
            "user_info": [
                {
                    "user_id": 0,
                    "username": "string",
                    "avatar": "string",
                    "nickname": "string",
                    "level": 0,
                    "avatar_decoration": {
                        "src_type": "string",
                        "src_url": "string"
                    },
                    "medals": [
                        {
                            "name": "string",
                            "name_short": "string",
                            "description": "string",
                            "color": "string",
                            "img_url": "string",
                            "medal_id": 0
                        }
                    ],
                    "room_nickname": "string",
                    "joined_at": 0,
                    "roles": [
                        "string"
                    ],
                    "color": 0,
                    "game_state": "string",
                    "online_state": 0,
                    "state": 0,
                    "user_state": {
                        "game_name": "string",
                        "game_icon": "string",
                        "music_name": "string",
                        "steam_game_name": "string",
                        "steam_game_state": "string",
                        "steam_game_icon": "string",
                        "game_time": 0,
                        "music_time": 0,
                        "steam_game_time": 0
                    },
                    "last_login": 0,
                    "logout_time": 0,
                    "ban": {
                        "operator_id": 0,
                        "reason": "string",
                        "until": "string",
                        "notify": true
                    },
                    "bot": true,
                    "color_list": null,
                    "continuous_days": 0,
                    "hide_fire_flag": true
                }
            ],
            "online_count": 0,
            "offline_count": 0
        }
    },
    "status": "string"
}