韦尼克 Logo
韦尼克平台
AI Document Platform
⌘K
开发文档API 调试台AI接入助手

Docs Map

文档目录

产品介绍选择接入方式先读企业认证 & API Key 获取方式共用
用户授权(OAuth + PKCE)用户体系与事件回调用户管理 API消息通知 API
首页消息通知 API

消息通知 API

说明 SaaS 消息通知的接收方式、请求结构与响应要求,适用于事件回调与运营集成场景。

上一页
用户管理 API
下一页
架构与依赖关系

接口说明

消息通知采用服务端回调方式。系统向预设域名下的接收地址发送 POST 请求,接收方处理完成后需返回字符串 success 作为成功确认。

  • 请求方式:POST
  • 认证方式:预设 URL 域名
  • 响应要求:接收到消息后必须返回 success

请求参数

请求体格式:application/json

字段名类型必选说明
dataobject是通知数据对象
notify_idstring是通知 ID
notify_timestring是通知时间

data 对象结构:

字段名类型必选说明
ppt_idstring否生成 PPT 的任务 ID
typestring是通知类型
timestring是事件时间,格式为 Y-m-d H:i:s
app_namestring是应用名称
union_idstring否用户唯一识别 ID

type 字段枚举值:

枚举值描述
PPT-DownloadPPT 下载
SYSTEM系统通知
PPT-Online-Download编辑器下载
PPT-CreatePPT 生成

请求示例

{
  "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"
}

响应示例

成功响应:

"success"

接入建议

  • 回调接口应优先保证快速返回,避免因处理耗时过长导致通知失败
  • 建议先记录 notify_id、type、ppt_id 等关键字段,再进入异步业务处理
  • 对于 PPT-Create、PPT-Download 等事件,建议在业务系统中补充操作日志,便于审计与问题排查

注意事项

  1. 接收到通知后必须返回 success,否则发送方会认为通知失败
  2. 回调地址需提前配置在可访问且稳定的服务域名下
  3. 建议对重复通知做幂等处理,避免重复写入业务状态