SafeW API 文档

集成 SafeW 到您的应用中,构建强大的即时通讯功能

认证

SafeW API 使用 Bearer Token 进行认证。您可以在开发者后台获取 API Token。

curl -X GET "https://api.safew.im/v1/me" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

获取 Token

登录 SafeW 开发者后台,创建应用并获取 API Token。

消息

发送和管理消息,支持文本、图片、文件等多种类型。

POST /v1/messages/send

发送消息到指定用户或群组

参数类型说明
chat_idstring聊天 ID(用户ID或群组ID)
textstring消息文本内容
parse_modestring解析模式:markdown / html
# 发送文本消息
curl -X POST "https://api.safew.im/v1/messages/send" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "chat_id": "123456789",
    "text": "Hello from SafeW API! 👋"
  }'

# 响应示例
{
  "ok": true,
  "result": {
    "message_id": 1234,
    "chat": { "id": 123456789, "type": "private" },
    "text": "Hello from SafeW API!"
  }
}

用户

获取用户信息和用户管理功能。

GET /v1/users/{user_id}

获取指定用户的信息

GET /v1/users/me

获取当前登录用户的信息

群组

创建和管理群组,控制群组成员和权限。

POST /v1/groups/create

创建新群组

参数类型说明
titlestring群组名称
descriptionstring群组描述(可选)
membersarray初始成员 ID 列表

文件

上传和下载文件,支持图片、视频、文档等。

POST /v1/files/upload

上传文件到 SafeW 服务器

# 上传文件
curl -X POST "https://api.safew.im/v1/files/upload" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "file=@/path/to/file.pdf"

Webhook

设置 Webhook 接收实时消息推送。

POST /v1/webhooks/set

设置 Webhook URL

参数类型说明
urlstring接收消息的 Webhook URL
secretstring用于验证的密钥(可选)
# 设置 Webhook
curl -X POST "https://api.safew.im/v1/webhooks/set" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{"url": "https://your-server.com/webhook"}'

# Webhook 消息格式
{
  "update_id": 123456,
  "message": {
    "message_id": 1234,
    "from": { "id": 111111, "name": "张三" },
    "chat": { "id": 222222, "type": "private" },
    "text": "Hello"
  }
}

开始使用 SafeW API

获取您的 API Token,开始构建您的应用

联系获取 API 权限