Elai
  1. WEBHOOK
Elai
  • 简介
  • 个性化 API
    • 创建个性化视频
    • 渲染/创建个性化批次
      POST
  • 视频 API
    • 创建视频
      • 创建视频
      • 来自模板
      • 来自 PPTX/PPT
      • 复制视频
      • 翻译视频
    • 渲染视频
      POST
    • 列出视频
      GET
    • 检索视频
      GET
    • 更新视频
      PATCH
    • 删除视频
      DELETE
  • 故事 API
    • 概述
    • OpenAI GPT-3.5 增强功能
      • 通过 GPT 从头生成
      • 增强整个视频
      • 增强特定幻灯片
    • 生成/创建故事
      POST
    • 生成幻灯片/转换故事
      POST
  • 头像 API
    • 概述
    • 头像列表
      GET
    • 更新头像
      PATCH
    • 创建照片头像
      POST
  • 用户 API
    • 列出用户
      GET
    • 邀请用户
      POST
    • 更新用户
      PATCH
    • 删除用户
      DELETE
  • 语言 API
    • 语言/声音列表
    • 获取大致持续时间
  • 实时 API
    • 实时 API 概览(测试版)
    • 创建流
    • 检索流
    • 开始流
    • 提交 webRTC 候选
    • 渲染文本
    • 关闭流
  • WEBHOOK
    • Webhook 概述
    • 订阅
      POST
    • 取消订阅
      DELETE
    • 设置秘密令牌
      POST
  • 上传媒体
    • 检索签名 URL
    • 确认上传
  1. WEBHOOK

Webhook 概述

Webhook 允许您订阅由我们的系统触发的事件。

到目前为止,我们支持以下类型的事件:#

事件描述
video_ready 字符串当任何视频的状态变为“就绪”时触发
video_error 字符串当任何视频出现验证或渲染错误时触发
video_moderation 字符串当任何视频被发送到审核时触发

Webhook 有效负载的示例:#

JSON
Delivery-ID: xQHSyokZ
Elai-Timestamp: 1652706345008
Elai-Signature: bd72f3294000e64ac62724836071483fc6abcb9b1ab4e39e446e04d8314c3334

{
    "event": "video_ready",
    "error": null,
    "video": {
      "_id": "627e1c5ef461482766f35f4a",
      "status": "ready",
      "public": false,
      "name": "Hello John!",
      "tags": [],
      "deleted": false,
      "status": "draft",
      "public": false,
      "userId": "61b1529d2055d2805c0",
      "accountId": "61b1529d2055d2805c",
     	"createdAt": "2022-08-25T09:25:56.228Z",
      "updatedAt": "2022-08-26T09:40:03.337Z",
      "data": {},
      "duration": 3.456,
      "thumbnail": "https://elai-media.s3.eu-west-2.amazonaws.com/staging/videos/630740247ca13c26ac13886d/slide733399051519_screenshot_1661506361822.jpg",
      "url": "https://elai-media.s3.eu-west-2.amazonaws.com/staging/videos/630740247ca13c26ac13886d/kreativnyi-brif_kama.mp4"
    }
}
Payload一般包含以下字段:
Webhook 字段描述
事件 字符串指定的事件类型之一。
错误 字符串如果视频处理过程中出现错误,其摘要描述将在此字段中。
requestId 字符串如果视频是使用个性化 API 创建的,则此字段将包含相关请求 ID
batchRowId 字符串如果视频是使用个性化API创建的,则此字段将包含批量请求中视频的相关索引
视频 对象实际视频信息。
我们期望在 10 秒内收到非错误响应代码 (2xx),以认为事件传递成功。

❗️发生错误时#

10 次投递失败(webhook 返回非 2xx 状态)后,我们会暂时禁用 webhook。然后您应该修复端点并通过重新订阅 API 或访问API 设置页面来重新激活 webhook 。
如果您想验证请求的来源,以确保 Elai 发出了请求,我们会使用特定标头对每个事件进行签名。要了解有关如何验证签名的更多信息,请参阅本指南。
您可以使用API 设置页面启用 webhook 。
截图 2022-05-18 21.25.27.png
或者您也可以通过相关的API方法订阅webhook 。
修改于 2024-06-13 06:17:59
上一页
关闭流
下一页
订阅
Built with