API 文档

SafeW Bot API 完整参考文档,帮助您快速构建智能机器人

Base URL: https://api.safew.im/bot/v1

概述

SafeW Bot API 允许开发者创建智能机器人,实现消息自动回复、群组管理、数据查询等功能。 API 基础地址:https://api.safew.im/bot/v1 所有请求和响应均使用 JSON 格式。API 采用 RESTful 设计风格,使用标准 HTTP 方法和状态码。 速率限制: 普通机器人每秒最多 30 次请求,企业版可申请更高配额。

认证

所有 API 请求需要在 Header 中携带 Bot Token 进行认证。Token 通过 BotFather 创建机器人时获取。

HTTP Header
Authorization: Bearer YOUR_BOT_TOKEN
GET/getMe

获取机器人基本信息,可用于验证 Token 是否有效

响应示例

{"ok":true,"result":{"id":123456789,"is_bot":true,"first_name":"MyBot","username":"my_safew_bot"}}
POST/setWebhook

设置 Webhook URL,用于接收消息推送

参数名类型必填说明
urlstring必填Webhook 回调地址(HTTPS)
secret_tokenstring可选用于验证请求来源的密钥

消息

消息相关接口用于发送文本、图片、文件等各类消息,以及对已发送的消息进行编辑、删除和转发操作。

POST/sendMessage

发送文本消息

参数名类型必填说明
chat_idstring|integer必填目标聊天 ID
textstring必填消息文本内容,最大 4096 字符
parse_modestring可选文本解析模式:Markdown 或 HTML
POST/editMessageText

编辑已发送的文本消息

参数名类型必填说明
chat_idstring|integer必填聊天 ID
message_idinteger必填要编辑的消息 ID
textstring必填新的消息文本
POST/deleteMessage

删除消息

参数名类型必填说明
chat_idstring|integer必填聊天 ID
message_idinteger必填要删除的消息 ID
POST/forwardMessage

转发消息到指定聊天

参数名类型必填说明
chat_idstring|integer必填目标聊天 ID
from_chat_idstring|integer必填源聊天 ID
message_idinteger必填要转发的消息 ID

群组

群组管理接口用于获取群组信息、管理成员、设置群组属性等操作。

GET/getChat

获取聊天详细信息

参数名类型必填说明
chat_idstring|integer必填聊天 ID
GET/getChatMemberCount

获取群组成员数量

参数名类型必填说明
chat_idstring|integer必填群组 ID
POST/banChatMember

封禁群组成员

参数名类型必填说明
chat_idstring|integer必填群组 ID
user_idinteger必填用户 ID
POST/setChatTitle

设置群组标题

参数名类型必填说明
chat_idstring|integer必填群组 ID
titlestring必填新标题,1-128 字符

媒体文件

媒体文件接口用于发送图片、视频、音频、文档等多媒体内容。SafeW 对文件大小没有限制。

POST/sendPhoto

发送图片

参数名类型必填说明
chat_idstring|integer必填目标聊天 ID
photostring|file必填图片文件或 URL
POST/sendVideo

发送视频

参数名类型必填说明
chat_idstring|integer必填目标聊天 ID
videostring|file必填视频文件或 URL
POST/sendDocument

发送文件

参数名类型必填说明
chat_idstring|integer必填目标聊天 ID
documentstring|file必填文件或 URL

Webhooks

Webhook 允许您的服务器实时接收来自 SafeW 的消息更新,无需轮询。当有新消息或事件时,SafeW 会主动向您设置的 URL 发送 POST 请求。

POST/setWebhook

设置或更新 Webhook

参数名类型必填说明
urlstring必填Webhook 回调 URL
max_connectionsinteger可选最大并发连接数(1-100),默认 40
GET/getWebhookInfo

获取当前 Webhook 配置信息

POST/deleteWebhook

删除 Webhook,切换到轮询模式