Appearance
消息通知API文档
消息通知API
接口说明
此接口用于接受系统推送的消息通知,采用指定域名URL接收方式。接收到通知消息后,需要返回
success字符串代表接收成功。
- 请求方式:
POST - 认证方式: 预设URL域名
- 响应要求: 接受到消息后必须返回
success字符串
请求参数(RequestBody)
请求格式:
application/json
| 字段名 | 类型 | 必选 | 说明 |
|---|---|---|---|
| data | object | Y | 通知数据对象 |
| notify_id | string | Y | 通知ID |
| notify_time | string | Y | 通知时间 |
data对象结构
| 字段名 | 类型 | 必选 | 说明 |
|---|---|---|---|
| ppt_id | string | N | 生成PPT-ID |
| type | string | Y | 通知类型(执行的操作),枚举值见下方说明 |
| time | string | Y | 时间(Y-m-d H:i:s)格式 |
| app_name | string | Y | 应用名称 |
| union_id | string | N | 用户唯一识别ID |
type字段枚举值说明
| 枚举值 | 描述 |
|---|---|
| PPT-Download | PPT下载 |
| SYSTEM | 系统通知 |
| PPT-Online-Download | 编辑器下载 |
| PPT-Create | PPT生成 |
请求示例
json
{
"data": {
"ppt_id": "eTrNUASpGSb7CbXjh5huQPEMJBKyZwTv",
"type": "PPT-Download",
"time": "2025-01-06 14:33:47",
"app_name": "智能PPT"
},
"notify_id": "756571379632283648",
"notify_time": "2025-03-06 11:45:24"
}响应示例
✅成功响应
- 状态码:
200 - 响应内容: 必须返回字符串
json
"success"❌错误响应
- 状态码: 非200状态码
- 响应内容: 错误信息
⚠️注意事项
- 请确保在接受消息时,返回
success字符串,否则将无法确认消息已接受 - 接收到消息后必须返回
success字符串,否则发送方会认为消息发送失败 - 建议在接收到消息后尽快处理并返回响应,避免超时