跳到主要内容

DeBox 开发者 OpenAPI

接口清单（按路由顺序）​

  1. POST /openapi/bot/sendMessage
  2. POST /openapi/bot/sendMessageToFans
  3. POST /openapi/bot/editMessage
  4. POST /openapi/bot/getMe
  5. POST /openapi/bot/getUpdates
  6. GET /openapi/group/info
  7. GET /openapi/group/is_join
  8. POST /openapi/group/admin/dao_member
  9. GET /openapi/user/info
  10. GET /openapi/user/is_follow
  11. GET /openapi/token/info
  12. GET /openapi/box/info

Base URL​

https://open.debox.pro

鉴权​

除 GET /openapi/box/info 外，均需请求头：

X-API-KEY: <your_api_key>

返回包裹格式​

标准包裹（group/user/token/box）​

{
  "code": 200,
  "success": true,
  "data": {}
}

Bot 包裹（bot 路由）​

{
  "ok": true,
  "success": true,
  "result": {}
}

全局参数值域​

  • chat_type：group | private
  • chat_id：
    • chat_type=group 时：群 gid（如 cc0onr82）
    • chat_type=private 时：用户 user_id（invite code）
  • content：主参数
  • 文本类长度上限（text/richtext/Markdown/MarkdownV2/HTML）：5000 字符
  • parse_mode 默认值：richtext
  • parse_mode 值域：
    • richtext（默认）
    • text
    • Markdown
    • MarkdownV2
    • HTML
    • image
    • video
    • file

content 如何填写（关键）​

  • parse_mode=richtext：填普通文本或富文本字符串（默认）。
  • parse_mode=text：填纯文本（不解析 Markdown/HTML）。
  • parse_mode=Markdown：填 Markdown 内容。
  • parse_mode=MarkdownV2：填 MarkdownV2（需要按语法转义）。
  • parse_mode=HTML：填 HTML 片段（如 <b>Hello</b>）。
  • parse_mode=image：content 填可公网访问的图片 URL（如 https://cdn.example.com/a.png）。
  • parse_mode=video：content 填可公网访问的视频 URL（如 https://cdn.example.com/a.mp4）。
  • parse_mode=file：content 填可公网访问的文件 URL（如 https://cdn.example.com/a.pdf）。

reply_markup / user_action_markup 最小示例​

{
  "inline_keyboard": [
    [
      { "text": "查看详情", "url": "https://docs.debox.pro/zh/ApiOnePage" },
      { "text": "回调按钮", "callback_data": "detail" }
    ]
  ]
}

mention_type / mention_ids 使用建议​

  • 仅 parse_mode=text 时建议使用 mention_type 与 mention_ids。
  • 富文本模式（richtext/Markdown/MarkdownV2/HTML）建议直接在 content 中写 @ 文本，不依赖 mention_* 字段。
  • 若不需要 @ 功能，mention_type 与 mention_ids 可省略。

1. POST /openapi/bot/sendMessage​

Curl 示例​

curl -X POST "https://open.debox.pro/openapi/bot/sendMessage" \
  -H "Content-Type: application/json" \
  -H "X-API-KEY: YOUR_APP_KEY" \
  -d '{"chat_id":"cc0onr82","chat_type":"group","content":"hello","parse_mode":"richtext"}'

发送单条消息（群/私聊）。

上行参数（Body，JSON）​

  • chat_id string，必填
  • chat_type string，必填，值域：group | private
  • content string，必填
  • parse_mode string，选填，默认 richtext
  • message_id string，选填
  • mention_type int，选填
  • mention_ids string[]，选填
  • reply_markup object，选填
  • user_action_markup object，选填

成功响应示例​

{
  "ok": true,
  "success": true,
  "result": {
    "message_id": "01JYXXXX",
    "text": "Hello from DeBox",
    "parse_mode": "richtext"
  }
}

失败响应示例​

{
  "ok": false,
  "success": false,
  "message": "message can't be empty"
}

2. POST /openapi/bot/sendMessageToFans​

Curl 示例​

curl -X POST "https://open.debox.pro/openapi/bot/sendMessageToFans" \
  -H "Content-Type: application/json" \
  -H "X-API-KEY: YOUR_APP_KEY" \
  -d '{"chat_id":"cc0onr82","chat_type":"group","content":"broadcast","parse_mode":"richtext"}'

向粉丝批量发送。

上行参数（Body，JSON）​

  • chat_id string，必填
  • chat_type string，必填，值域：group | private
  • content string，必填
  • parse_mode string，选填，默认 richtext

约束：content 最大 2000 字节。

成功响应示例​

{
  "ok": true,
  "success": true,
  "result": true
}

失败响应示例​

{
  "ok": false,
  "success": false,
  "message": "message must be less than 2000 bytes"
}

3. POST /openapi/bot/editMessage​

Curl 示例​

curl -X POST "https://open.debox.pro/openapi/bot/editMessage" \
  -H "Content-Type: application/json" \
  -H "X-API-KEY: YOUR_APP_KEY" \
  -d '{"chat_id":"cc0onr82","chat_type":"group","message_id":"01JYXXXX","content":"edited","parse_mode":"richtext"}'

编辑历史消息文本。

上行参数（Body，JSON）​

  • chat_id string，必填
  • chat_type string，必填，值域：group | private
  • message_id string，必填
  • content string，必填
  • parse_mode string，选填，默认 richtext

成功响应示例​

{
  "ok": true,
  "success": true,
  "result": true
}

失败响应示例​

{
  "ok": false,
  "success": false,
  "message": "EditMessageText param Group Id is error"
}

4. POST /openapi/bot/getMe​

Curl 示例​

curl -X POST "https://open.debox.pro/openapi/bot/getMe" \
  -H "X-API-KEY: YOUR_APP_KEY"

获取当前 API Key 绑定账户信息。

上行参数​

无。

成功响应示例​

{
  "ok": true,
  "success": true,
  "result": {
    "name": "DeBox Bot",
    "address": "0x...",
    "pic": "https://...",
    "user_id": "u1",
    "level": 3,
    "level_icon": "https://.../icon/level/v3.png"
  }
}

失败响应示例​

{
  "ok": false,
  "success": false,
  "message": "invalid param"
}

5. POST /openapi/bot/getUpdates​

Curl 示例​

curl -X POST "https://open.debox.pro/openapi/bot/getUpdates" \
  -H "Content-Type: application/json" \
  -H "X-API-KEY: YOUR_APP_KEY" \
  -d '{"timeout":30}'

拉取 Bot 更新（长轮询）。

注意：如果你在开放平台配置了 Webhook URL，Webhook 会成为唯一有效收消息链路；此时本接口将拿不到或几乎拿不到消息。

上行参数（Body，JSON）​

  • timeout int，选填，值域 1~60，默认 30

成功响应示例（有消息）​

{
  "ok": true,
  "success": true,
  "result": [
    {
      "id": 123,
      "message": {
        "message_id": "01JYXXXX",
        "from": {
          "user_id": "u1",
          "name": "Alice",
          "address": "0x..."
        },
        "chat": {
          "id": "cc0onr82",
          "type": "group"
        },
        "text": "Ping",
        "parse_mode": "richtext"
      }
    }
  ]
}

成功响应示例（超时无消息）​

{
  "ok": true,
  "success": true,
  "result": []
}

失败响应示例​

{
  "ok": false,
  "success": false,
  "message": "Invalid timeout value"
}

6. GET /openapi/group/info​

Curl 示例​

curl "https://open.debox.pro/openapi/group/info?gid=cc0onr82" \
  -H "X-API-KEY: YOUR_APP_KEY"

查询群信息。

Query 参数​

  • gid string，必填

成功响应示例​

{
  "code": 200,
  "success": true,
  "data": {
    "is_charge": false,
    "subchannel_number": 2,
    "group_name": "DeBox Dev",
    "gid": "cc0onr82",
    "group_number": 345,
    "group_pic": "https://...",
    "create_time": "2026-05-14 14:00:00",
    "maximum": "无限制",
    "mod": ["Alice", "Bob"],
    "mod_info": [
      {
        "name": "Alice",
        "address": "0x...",
        "pic": "https://...",
        "user_id": "u1"
      }
    ]
  }
}

失败响应示例​

{
  "code": -3001,
  "success": false,
  "message": "No such group"
}

7. GET /openapi/group/is_join​

Curl 示例​

curl "https://open.debox.pro/openapi/group/is_join?gid=cc0onr82&walletAddress=0x1234567890abcdef1234567890abcdef12345678" \
  -H "X-API-KEY: YOUR_APP_KEY"

查询钱包是否已加入群。

Query 参数​

  • gid string，必填
  • walletAddress string，必填，EVM 地址

成功响应示例​

{
  "code": 200,
  "data": true
}

失败响应示例​

{
  "error": "Bad Request",
  "code": 401,
  "message": "Param error"
}

8. POST /openapi/group/admin/dao_member​

Curl 示例​

curl -X POST "https://open.debox.pro/openapi/group/admin/dao_member" \
  -H "Content-Type: application/json" \
  -H "X-API-KEY: YOUR_APP_KEY" \
  -H "nonce: RANDOM_NONCE" \
  -H "timestamp: 1715500000" \
  -H "signature: SHA1(app_secret+nonce+timestamp)" \
  -d '{"gid":"cc0onr82","page":1,"size":20}'

查询群成员（需签名鉴权 + 管理员权限）。

额外请求头（必填）​

  • nonce string
  • timestamp string
  • signature string

签名算法：sha1(app_secret + nonce + timestamp)。

上行参数（Body，JSON）​

  • gid string，必填，长度 1~8
  • page int，选填，<=0 时按 1
  • size int，选填，默认 50，最大 50

成功响应示例​

{
  "code": 200,
  "success": true,
  "data": [
    {
      "user_id": "u1",
      "name": "Alice",
      "pic": "https://...",
      "address": "0x...",
      "signature": "builder"
    }
  ]
}

失败响应示例​

{
  "code": -4017,
  "success": false,
  "message": "permission denied"
}

9. GET /openapi/user/info​

Curl 示例​

curl "https://open.debox.pro/openapi/user/info?user_id=u1" \
  -H "X-API-KEY: YOUR_APP_KEY"

查询用户资料。

Query 参数​

  • user_id string，选填
  • address string，选填，EVM 地址
  • 至少一个必填

成功响应示例​

{
  "code": 200,
  "success": true,
  "data": {
    "user_id": "u1",
    "name": "Alice",
    "address": "0x...",
    "pic": "https://...",
    "signature": "gm builder"
  }
}

失败响应示例​

{
  "code": -2004,
  "success": false,
  "message": "invalid param"
}

10. GET /openapi/user/is_follow​

Curl 示例​

curl "https://open.debox.pro/openapi/user/is_follow?walletAddress=0x1234567890abcdef1234567890abcdef12345678&followAddress=0xabcdefabcdefabcdefabcdefabcdefabcdefabcd" \
  -H "X-API-KEY: YOUR_APP_KEY"

查询用户关注关系。

Query 参数​

  • walletAddress string，必填，EVM 地址
  • followAddress string，必填，EVM 地址

成功响应示例​

{
  "code": 200,
  "data": true
}

失败响应示例​

{
  "error": "Bad Request",
  "code": 401,
  "message": "Please input the wallet address correctly"
}

11. GET /openapi/token/info​

Curl 示例​

curl "https://open.debox.pro/openapi/token/info?contract_address=0x55d398326f99059fF775485246999027B3197955&chain_id=56" \
  -H "X-API-KEY: YOUR_APP_KEY"

查询 Token 元信息。

Query 参数​

  • contract_address string，必填
  • chain_id int，选填；缺失/负值按 0

成功响应示例​

{
  "code": 200,
  "success": true,
  "data": {
    "chain_id": 56,
    "token": "0x55d398326f99059fF775485246999027B3197955",
    "decimal": 18,
    "name": "Tether USD",
    "symbol": "USDT",
    "logo_url": "https://..."
  }
}

失败响应示例​

{
  "code": -2004,
  "success": false,
  "message": "参数错误,contract_address must be a valid contract address"
}

12. GET /openapi/box/info​

Curl 示例​

curl "https://open.debox.pro/openapi/box/info"

查询 BOX 基础信息（无需 API Key）。

Query 参数​

无。

成功响应示例​

{
  "code": 200,
  "success": true,
  "data": {
    "max_supply": "1000000000",
    "burned": "...",
    "supply": "...",
    "locked": "...",
    "address": "0x...",
    "symbol": "BOX",
    "chainId": 1,
    "icon": "https://...",
    "stake": "..."
  }
}