OneBot动作API终极手册：发送消息、撤回消息、上传文件等核心操作详解

OneBot动作API终极手册：发送消息、撤回消息、上传文件等核心操作详解

【免费下载链接】onebot OneBot：统一的聊天机器人应用接口标准 项目地址: https://gitcode.com/gh_mirrors/on/onebot

OneBot是统一的聊天机器人应用接口标准，为开发者提供了简洁高效的API来实现聊天机器人的各种核心功能。本文将详细介绍OneBot中发送消息、撤回消息、上传文件等核心动作API的使用方法，帮助新手快速掌握机器人开发的关键技能。

OneBot简介

OneBot作为统一的聊天机器人接口标准，旨在为不同平台的聊天机器人提供一致的开发体验。通过OneBot，开发者可以使用相同的API接口与各种聊天平台进行交互，大大降低了跨平台开发的复杂度。

OneBot标志：象征着统一和高效的聊天机器人接口标准

核心动作API详解

发送消息：send_message

发送消息是聊天机器人最基本也是最重要的功能之一。OneBot提供的send_message接口可以让你轻松实现向不同类型的聊天对象发送消息。

请求参数

字段名	数据类型	默认值	说明
detail_type	string	-	发送的类型，可以为 private、group、channel 或扩展的类型
user_id	string	-	用户 ID，当 detail_type 为 private 时必须传入
group_id	string	-	群 ID，当 detail_type 为 group 时必须传入
guild_id	string	-	Guild 群组 ID，当 detail_type 为 channel 时必须传入
channel_id	string	-	频道 ID，当 detail_type 为 channel 时必须传入
message	message	-	消息内容

发送群消息示例

{
    "action": "send_message",
    "params": {
        "detail_type": "group",
        "group_id": "12467",
        "message": [
            {
                "type": "text",
                "data": {
                    "text": "我是文字巴拉巴拉巴拉"
                }
            }
        ]
    }
}

响应示例

{
    "status": "ok",
    "retcode": 0,
    "data": {
        "message_id": "2452352435",
        "time": 1632847927.599013
    },
    "message": ""
}

撤回消息：delete_message

当需要撤回已发送的消息时，可以使用delete_message接口。这个功能在机器人发送了错误信息或需要清理聊天记录时非常有用。

请求参数

字段名	数据类型	默认值	说明
message_id	string	-	唯一的消息 ID

请求示例

{
    "action": "delete_message",
    "params": {
        "message_id": "2452352435"
    }
}

响应示例

{
    "status": "ok",
    "retcode": 0,
    "data": null,
    "message": ""
}

上传文件：upload_file

OneBot提供了文件上传功能，通过upload_file接口可以将本地文件或网络文件上传到聊天平台。

请求参数

字段名	数据类型	默认值	说明
type	string	-	上传文件的方式，可以为 url、path、data 或扩展的方式
name	string	-	文件名，如 foo.jpg
url	string	-	文件 URL，当 type 为 url 时必须传入
headers	map[string]string	-	下载 URL 时需要添加的 HTTP 请求头
path	string	-	文件路径，当 type 为 path 时必须传入
data	bytes	-	文件数据，当 type 为 data 时必须传入
sha256	string	-	文件数据的 SHA256 校验和，全小写，可选传入

从URL上传文件示例

{
    "action": "upload_file",
    "params": {
        "type": "url",
        "name": "logo.jpg",
        "url": "https://avatars.githubusercontent.com/u/56297293?s=200&v=4"
    }
}

响应示例

{
    "status": "ok",
    "retcode": 0,
    "data": {
        "file_id": "e30f9684-3d54-4f65-b2da-db291a477f16"
    },
    "message": ""
}

获取文件：get_file

上传文件后，可以使用get_file接口获取已上传的文件。这个接口支持多种获取方式，包括通过URL、本地路径或直接获取文件数据。

请求参数

字段名	数据类型	默认值	说明
file_id	string	-	文件 ID
type	string	-	获取文件的方式，可以为 url、path、data 或扩展的方式

请求示例

{
    "action": "get_file",
    "params": {
        "file_id": "e30f9684-3d54-4f65-b2da-db291a477f16",
        "type": "url"
    }
}

响应示例

{
    "status": "ok",
    "retcode": 0,
    "data": {
        "name": "logo.jpg",
        "url": "https://avatars.githubusercontent.com/u/56297293?s=200&v=4"
    },
    "message": ""
}

如何开始使用OneBot

要开始使用OneBot开发聊天机器人，你需要先克隆OneBot项目仓库：

git clone https://gitcode.com/gh_mirrors/on/onebot

然后参考项目中的文档来配置和使用OneBot接口。有关接口的更多详细信息，可以查阅以下文档：

• 接口规则：specs/interface/rules.md
• 消息类型：specs/interface/message/type.md
• 动作请求：specs/connect/data-protocol/action-request.md

总结

OneBot提供了一套简单而强大的动作API，使开发者能够轻松实现聊天机器人的核心功能。本文介绍的发送消息、撤回消息、上传文件和获取文件等API是开发聊天机器人的基础，掌握这些API将帮助你快速构建功能丰富的机器人应用。

无论是开发个人助手、群管理工具还是自动化客服系统，OneBot都能为你提供一致且高效的开发体验。开始探索OneBot的更多功能，打造属于你的聊天机器人吧！ 🚀

【免费下载链接】onebot OneBot：统一的聊天机器人应用接口标准 项目地址: https://gitcode.com/gh_mirrors/on/onebot