Protocol V2
首页GitHub
首页GitHub
  1. API
  • API
    • Broadcast
    • Title
    • Action Bar
    • Private Message
    • Rcon
  • Event
    • 事件测试
  • 数据模型
    • API
      • Response
    • EventModel
      • Base
        • BaseEvent
        • BaseMessageEvent
        • BaseNoticeEvent
        • BasePlayerMessageEvent
        • BasePlayerNoticeEvent
      • Achievement
        • Display
        • Achievement
    • Event
      • Player
        • Player
        • PlayerChatEvent
        • PlayerCommandEvent
        • PlayerJoinEvent
        • PlayerQuitEvent
        • PlayerAchievementEvent
  1. API

Private Message

ws://127.0.0.1:8080
PrivateMessage
最后修改时间:2025-10-17 03:27:14

🛰️ WebSocket 接口文档#

📡 接口名称#

私聊消息接口(send_private_msg)

🧭 字段描述#

字段路径类型默认值说明
uuidstring-接收者 UUID(优先使用),可选,如果为空则使用 nickname。
nicknamestring-接收者昵称,当 uuid 为空时使用。
message文本组件(JsonElement)-私聊消息内容。参考 Minecraft 文本组件。
发送的聊天消息会在前方添加前缀,默认为:[鹊桥]
uuid 与 nickname 至少传递一个
若都传递,则优先使用 uuid

🧱 数据结构#

🔹 消息格式#

{
    "api": "send_private_msg",
    "data": {
        "uuid": null,
        "nickname": "17TheWord",
        "message": [
            {
                "text": "[私聊消息]",
                "color": "aqua"
            },
            {
                "text": "说:",
                "color": "white"
            },
            {
                "text": "聊天内容",
                "color": "white"
            }
        ]
    },
    "echo": "1"
}

🔹 返回信息#

{
    "code": 200,
    "post_type": "response",
    "status": "SUCCESS",
    "message": "success",
    "data": {
        "target_player": {
            "display_name": "17TheWord",
            "player_list_name": "17TheWord",
            "address": "/[0:0:0:0:0:0:0:1]:62258",
            "is_health_scaled": false,
            "health_scale": 20.0,
            "exp": 0.0,
            "total_exp": 0,
            "level": 0,
            "locale": "zh_cn",
            "ping": 0,
            "player_time": 79884,
            "is_player_time_relative": true,
            "player_time_offset": 0,
            "walk_speed": 0.2,
            "fly_speed": 0.1,
            "allow_flight": true,
            "is_sprinting": false,
            "is_sneaking": false,
            "is_flying": false,
            "is_op": true,
            "nickname": "17TheWord",
            "uuid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        },
        "message": "Send private message success."
    },
    "echo": "1"
}

请求参数

Header 参数

修改于 2025-10-17 03:27:14
上一页
Action Bar
下一页
Rcon
Built with