消息类型
Bot API 目前支持发送文本消息，可以通过 payload 字段携带扩展信息。
支持的消息类型
| 类型 | 说明 |
|---|---|
| 文本消息 | 纯文本内容，支持换行 |
文本消息
基本格式
{
"workspaceId": 1001,
"userId": 123,
"text": "您好，这是一条文本消息"
}
多行文本
使用 \n 实现换行：
{
"workspaceId": 1001,
"userId": 123,
"text": "审批通知\n申请人：张三\n申请类型：请假\n请及时处理"
}
带扩展字段
使用 payload 字段携带业务数据：
{
"workspaceId": 1001,
"userId": 123,
"text": "您有一条新的审批待处理",
"payload": "{\"type\":\"approval\",\"approvalId\":456}"
}
消息格式建议
通知类消息
📢 通知标题
────────────
内容第一行
内容第二行
────────────
时间：2026-01-06 10:00
示例：
{
"text": "📢 会议通知\n────────────\n主题：项目周会\n时间：2026-01-06 14:00\n地点：3楼会议室\n────────────\n请准时参加"
}
审批类消息
📋 审批类型
申请人：xxx
申请内容：xxx
申请时间：xxx
请及时处理
示例：
{
"text": "📋 请假审批\n申请人：张三\n请假类型：事假\n请假时间：2026-01-06 至 2026-01-08\n请假原因：家里有事\n────────────\n请及时处理"
}
告警类消息
⚠️ 告警标题
告警级别：xxx
告警内容：xxx
发生时间：xxx
请立即处理！
示例：
{
"text": "⚠️ 生产异常告警\n告警级别：严重\n设备编号：CNC-001\n异常类型：温度过高\n当前温度：85°C\n发生时间：2026-01-06 10:30\n────────────\n请立即处理！"
}
发送频道消息
除了向用户发送消息，还可以向频道发送消息。
接口说明
| 属性 | 值 |
|---|---|
| 请求方式 | POST |
| 请求路径 | /im-user/api/v1/bot/send-channel-message |
| 鉴权方式 | Bot Token |
请求参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
workspaceId | number | 是 | 工作空间 ID |
channelId | number | 是 | 频道 ID |
text | string | 是 | 消息文本内容 |
payload | string | 否 | 扩展字段（JSON 格式） |
请求示例
curl -X POST 'https://api.im.example.com/im-user/api/v1/bot/send-channel-message' \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...' \
-H 'Content-Type: application/json' \
-d '{
"workspaceId": 1001,
"channelId": 5001,
"text": "📢 项目公告\n本周五下午进行系统升级，届时服务将暂停30分钟"
}'
Payload 扩展字段
payload 字段用于携带业务扩展数据，格式为 JSON 字符串。
使用场景
- 携带业务 ID，方便客户端跳转
- 携带操作类型，支持客户端交互
- 携带额外的业务数据
示例
{
"workspaceId": 1001,
"userId": 123,
"text": "您有一条新的请假审批待处理",
"payload": "{\"type\":\"leave_approval\",\"leaveId\":456,\"actions\":[\"approve\",\"reject\"]}"
}
Payload 结构建议
{
"type": "业务类型",
"id": "业务ID",
"actions": ["可执行的操作"],
"extra": {
"其他扩展数据": "..."
}
}