Skip to content

介绍

我们的服务通过iframe页面向您的应用程序发送消息通知,以便实时通信和数据更新。您需要在您的应用程序中进行一些设置,以确保能够正确地接收这些通知。

说明

事件类型边界

预装版(UI 版本)有两类消息能力:

类型触发方式适合处理
事件通知iframe 页面通过 onMessage(type, data) 主动通知宿主页面路由变化、扣费、创建任务、生成完成、保存、下载、错误、回退
事件推送回调接入方在配置中提供回调地址或回调能力,由 AiPPT 在特定业务动作后推送保存 PPT 等需要服务端感知的结果

如果只是前端页面联动,优先使用事件通知;如果接入方服务端必须记录业务结果,再配置事件推送回调。

事件阶段速查

阶段事件边界说明
路由与异常ROUTERERRORTOKEN_EXPIREBACK_BUTTON页面跳转、初始化失败、Code 过期和回退处理
创建任务CREATE_TASK_BEFORECREATE_TASK_SUCCESSCHARGING生成任务创建前后,以及扣费通知
大纲与内容AI_CONTENT_COMPLETEOUTLINE_CONFIRMOUTLINE_DOWNLOADRETRY_OUTLINE_CONFIRMOUTLINE_DOWNLOAD 发生在大纲弹框位置,不属于编辑器内下载
模板与合成TEMPLATE_SELECTEDGENERATE_PPT_SUCCESSGENERATE_PPT_SUCCESS 表示合成新作品成功
编辑器内操作PPT_EDIT_FILENAMEPPT_SAVEPPT_DOWNLOADPPT_SAVE 是进入编辑器之后的保存;PPT_DOWNLOAD 是作品下载
场景鉴权SCENE_AUTH开启 scene_auth 后,iframe 暂停流程,宿主调用 sceneAuthContinue 决定继续或取消
推送回调SAVE_PPT_PUSH_CALLBACK宿主调用 事件推送 后,用于接收保存推送结果

事件边界

GENERATE_PPT_SUCCESS 是生成流程中合成新作品成功;PPT_SAVE 是进入编辑器之后的保存;OUTLINE_DOWNLOAD 发生在生成流程的大纲弹框位置,不是 PPT 编辑器内下载。

相关参数

相关代码

ts
AipptIframe.show({
  appkey: appkey,
  channel: channel,
  code: code,
  editorModel: editorModel,
  container: container,
  onMessage(type, data) {
    // 以下消息通知全部集成在此处
  } 
})

相关事件

路由通知

接口扣费通知

创建任务前

创建任务完成

AI内容接收完成

大纲点击下一步

点击下载大纲

点击换个大纲

选择模板点击下一步

PPT创建成功

PPT修改文件名称

保存PPT

下载PPT

鉴权消息

Code过期

错误消息

回退事件

事件推送回调