You need to enable JavaScript to run this app.
文档中心
AI MediaKit

AI MediaKit

复制全文
下载 pdf
其他
事件回调
复制全文
下载 pdf
事件回调
对于 AI MediaKit 的异步媒体处理任务(如音视频拼接、画质增强等),为了及时获取任务结果,建议您配置事件回调。当任务执行完成时,AI MediaKit 会主动向您指定的服务器地址发送 POST 请求,推送任务状态及结果数据。​
回调机制​
您需要部署一个 HTTP/HTTPS 服务来接收回调消息,并在 AI MediaKit 控制台中配置回调地址。AI MediaKit 的回调机制具体如下:​
  • 请求方式:当事件发生时,AI MediaKit 会向您配置的回调地址发起 POST 请求。​
  • 响应要求:您的 HTTP/HTTPS 服务收到回调后,需返回 200 状态码表示接收成功,其它状态码表示失败。​
  • 重试机制:若回调失败(响应非 200 或连接超时),AI MediaKit 会发起最多 3 次重试,重试间隔依次为 5 秒、10 秒和 30 秒。若 3 次重试均失败,该通知将被丢弃。​
  • 安全说明:当前版本暂不支持回调签名鉴权。请确保您的接收地址能够处理来自公网的 POST 请求,并建议在业务层根据 task_id 进行幂等校验。​
配置回调订阅​
步骤 1:勾选事件​
  1. 访问 AI MediaKit 控制台基础配置页面。​
  1. 在回调管理页签下,单击修改,勾选需要接收的事件类型。当前仅支持单任务执行完成事件。​
步骤 2:配置接收地址​
在回调订阅区域,创建新的回调订阅,用于指定接收回调通知的地址和方式。具体步骤如下:​
  1. 单击添加回调订阅。​
  1. 配置以下信息:​
  • 回调方式:固定为 http(s)。​
  • 请求 Content-Type:选择回调请求的 Content-Type。这将影响 AI MediaKit 服务向回调地址发送请求时请求体的数据格式。支持以下两种类型:​
  • application/json​
  • application/octet-stream​
  • 接收地址:(必填)输入用于接收回调通知的 URL 地址。必须以 http:// 或 https:// 开头。​
  1. 单击确定。修改配置后,生效时间为几分钟,请耐心等待。​
步骤 3:进行连通性测试​
  1. 在回调订阅列表中,单击操作列的测试。​
  • ​​​
  1. 在地址测试弹框中勾选待测试事件,单击确定。​
  1. 在回调记录页签下等待回调完成,系统将自动弹出提示框,显示回调测试结果(成功或失败)。状态为回调成功,表示接收地址可用。​
单任务执行完成事件​
当您提交的异步任务(如视频拼接、画质增强等)执行完成(无论成功或失败)时,AI MediaKit 会向您配置的回调地址推送此事件。​
参数说明​
​
字段​
类型​
是否必填​
示例​
描述​
RequestId​
String​
是​
2026032520...​
本次回调请求的唯一 ID。​
Version​
String​
是​
1.0​
事件版本号,例如 "1.0"。​
EventType​
String​
是​
AIMediaKitTaskComplete​
事件类型,固定为 AIMediaKitTaskComplete。​
EventTime​
String​
是​
2026-03-25T12:44:34Z​
事件发生的 UTC 时间,格式为 YYYY-MM-DDTHH:mm:ssZ。​
Data​
Object​
是​
{...}​
包含任务处理结果的核心数据对象。详见 Data 对象。​
TaskId​
String​
是​
amk_tool_...​
任务的唯一标识,与 Data.TaskId 的值相同。​
​
Data 对象​
Data 对象包含了任务的最终状态和结果。​
​
字段​
类型​
是否必填​
示例​
描述​
Code​
String​
是​
Success​
任务执行结果的状态码。​
  • Success 表示成功。​
  • Failed 表示失败。​
Message​
String​
是​
AIMediaKit Task Success​
任务执行结果的描述信息。​
TaskId​
String​
是​
amk_tool_...​
任务的唯一标识。​
Result​
Object​
是​
{...} 或 null​
任务成功时返回的结果数据对象,失败时为 null。具体结构因任务类型而异。您可参考提交具体任务的 API 文档。​
CallbackArgs​
String​
否​
{"user_id":"abc"}​
自定义回调参数。如果您在提交任务时设置了 callback_args 参数,其内容将在此字段中原样返回。如果提交时未设置,则回调中不包含此字段。​
QueueId​
String​
是​
q00a9731598092652e4a95292434198​
任务所属的队列 ID。​
​
回调示例​
以音视频合成任务为例:​
​
{​
"RequestId": "20260325204413EB38CD20C7D66989462D",​
"Version": "1.0",​
"EventType": "AIMediaKitTaskComplete",​
"EventTime": "2026-03-25T12:44:34Z",​
"Data": {​
"Code": "Success",​
"Message": "AIMediaKit Task Success",​
"TaskId": "amk_tool_mux_audio_video_14***24",​
"Result": {​
"duration": 240.578,​
"resolution": "540p",​
"video_url": "https://example.volcengine.com/output?auth_key=..."​
}​
},​
"TaskId": "amk_tool_mux_audio_video_14***24",​
"QueueId": "q00a9731598092652e4a95292434198"​
}​
​
​
最近更新时间:2026.07.31 15:27:22
这个页面对您有帮助吗?
有用
有用
无用
无用