Bot API 可用方法速查 端点与参数清单
API 基础
基础 URL
https://a1.fanbook.cn/api/bot/{bot token}/{api}
通用规则
- 默认 POST 方法，按 RestFul 规范把 GET 请求的参数写在 URI 中
- 消息体推荐
application/json 编码 - 响应统一为 JSON 格式
- Token 放在 URL 路径中（不是 Header 或 Query 参数）
机器人端点
获取 BOT 自身信息
| 项目 | 内容 |
|---|
| 方法 | Get |
| URI | /getMe |
| 说明 | 返回 BOT 的 User 对象，含 WebSocket 连接用的 user token |
| 请求参数 | 无 |
| 响应 | ok: true, result: User 对象 |
频道端点
获取频道列表
| 项目 | 内容 |
|---|
| 方法 | Post |
| URI | /channel/list |
| 说明 | 获取服务器的频道列表，返回 Channel 数组 |
| 请求参数 | guild_id (String, 必填) — 服务器 ID |
| 响应 | ok: true, result: Channel[] |
获取频道消息列表
| 项目 | 内容 |
|---|
| 方法 | Post |
| URI | /channel/messages |
| 说明 | 获取指定频道的消息历史 |
| 请求参数 | channel_id, offset, limit |
| 响应 | ok: true, result: Message[] |
消息端点
发送消息
| 项目 | 内容 |
|---|
| 方法 | Post |
| URI | /sendMessage |
| 说明 | 发送消息到频道或私聊 |
| 请求参数 | |
chat_id: Integer (必填) — 频道的 channel_id，或私聊的 chat_id
text: String — 文本内容 (与 photo/voice 二选一)
photo: String — 图片地址 (可选)
voice: String — 语音地址 (可选)
reply_markup: Object — 内联键盘 (可选)
发送图片消息
| 项目 | 内容 |
|---|
| 方法 | Post |
| URI | /sendMessage |
| 说明 | photo 参数直接传图片 URL 或上传后得到的地址 |
邀请端点
获取服务器邀请码列表
| 项目 | 内容 |
|---|
| 方法 | Post |
| URI | /invite/guildList |
| 说明 | 获取服务器下所有活跃的邀请码 |
| 请求参数 | guild_id (String, 必填) |
获取频道邀请码列表
| 项目 | 内容 |
|---|
| 方法 | Post |
| URI | /invite/channelList |
| 说明 | 获取指定频道的邀请码列表 |
| 请求参数 | channel_id (String, 必填) |
成员端点
按名称搜索成员
| 项目 | 内容 |
|---|
| 方法 | Post |
| URI | /searchGuildMemberByName |
| 说明 | 用昵称搜索成员，支持模糊查询 |
| 请求参数 | guild_id, query (String, 必填 — 搜索关键词) |
| 响应 | ok: true, result: User[] |
获取服务器成员列表
| 项目 | 内容 |
|---|
| 方法 | Post |
| URI | /guild/members |
| 说明 | 获取服务器的成员列表 |
| 请求参数 | guild_id (String, 必填), offset, limit |
私聊端点
获取私聊频道
| 项目 | 内容 |
|---|
| 方法 | Post |
| URI | /getPrivateChat |
| 说明 | 与指定用户建立 / 获取私聊频道 |
| 请求参数 | user_id (String, 必填) |
| 响应 | 返回 chat_id，后续用此 ID 发送私聊消息 |
发送私聊消息
用 /sendMessage 端点，chat_id 填从 /getPrivateChat 拿到的值。
Bot API 完整文档
以上是最常用的端点速查。完整的 Bot API 文档请访问：
- 中文：open.fanbook.mobi/document/manage/doc/
- 英文：open.fanbook.mobi/document/en/manage/doc/
文档中包含每个端点的完整参数、响应示例、错误码说明以及可请求的具体对象类型定义。
API 调用示例（Python）
import requests
BOT_TOKEN = "YOUR_BOT_TOKEN"
BASE = f"https://a1.fanbook.cn/api/bot/{BOT_TOKEN}"
# 1. 获取自身信息
resp = requests.get(f"{BASE}/getMe")
print(resp.json())
# 2. 发送消息到频道
requests.post(f"{BASE}/sendMessage", json={
"chat_id": "123456789",
"text": "Hello from Fanbook BOT!"
})
# 3. 获取服务器频道列表
requests.post(f"{BASE}/channel/list", json={
"guild_id": "987654321"
})
# 4. 按名称搜索成员
requests.post(f"{BASE}/searchGuildMemberByName", json={
"guild_id": "987654321",
"query": "小明"
})
注意： 具体参数名以官方文档为准，不同版本的 API 可能有差异。