全部产品
Search
文档中心

智能媒体服务:事件列表

更新时间:Oct 15, 2024

智能媒体服务提供媒资上传、媒体处理、云剪辑等相关的回调事件,您可通过设置指定的回调事件及时获取任务处理进展和状态。通过阅读本文,您可以了解各类型事件的消息体示例和对应参数字段详细说明。

使用说明

如果回调类型为HTTP(S)请求,本文中的消息体为请求包内容;如果回调类型为MNS队列,消息体为队列接收的消息内容。

目录

表 1. 媒资上传

事件

描述

FileUploadComplete

音视频上传完成

UploadByURLComplete

URL上传完成

ImageUploadComplete

图片上传完成

AttachedMediaUploadComplete

辅助媒资上传完成

RegisterStreamComplete

媒体流注册完成

StreamUploadComplete

媒体流上传完成

UploadStreamByURLComplete

媒体流URL上传完成

表 2. 媒资管理

事件

描述

CreateAuditComplete

人工审核完成

RegisterMediaComplete

媒资注册完成

DeleteMediaComplete

媒资删除完成

MediaBaseChangeComplete

媒资基础信息变更完成

事件详情

FileUploadComplete:音视频上传完成

消息体示例:

{
    "EventType": "FileUploadComplete",
    "UserId": 183322097756****,
    "EventTime": "2022-07-15T08:48:14Z",
    "MessageBody": {
        "Status": "Success",
        "FileUrl": "http://outin-***.oss-cn-shanghai.aliyuncs.com/sv/93ad7c5-182010aa3dc/93ad7c5-182010a****.mp4",
        "MediaId": "c321b3a0041a71eda1590674a2ce****",
        "AppId": "app-1000000",
        "Size": "5510872",
        "MediaType": "video"
    }
}

消息体参数字段说明:

参数名称

类型

必填

描述

EventType

String

事件类型。

UserId

Long

用户ID。

EventTime

String

事件产生时间(UTC时间),格式为yyyy-MM-ddTHH:mm:ssZ

MessageBody

-

Object

-

消息体。

MediaId

String

媒资ID。

MediaType

String

媒资类型,取值:

  • audio:音频。

  • video:视频。

FileUrl

String

文件地址。

Size

String

文件大小。

AppId

String

应用ID。

UserData

String

用户自定义数据。

Status

String

状态。取值:Success、Fail。

UploadByURLComplete:URL上传完成

消息体示例:

{
    "EventType": "UploadByURLComplete",
    "UserId": 183322097756****,
    "EventTime": "2022-07-15T08:48:14Z",
    "MessageBody": {
        "Status": "Success",
        "SourceURL": "http://***/big_buck_bunny.mp4",
        "MediaId": "c321b3a0041a71eda1590674a2ce****",
        "AppId": "app-1000000",
        "MediaType": "video",
        "JobId": "88aabd2461ec4ad389f439f6ff92****"
    }
}

消息体参数字段说明:

参数名称

类型

必填

描述

EventType

String

事件类型。

UserId

Long

用户ID。

EventTime

String

事件产生时间(UTC时间),格式为yyyy-MM-ddTHH:mm:ssZ

MessageBody

-

Object

-

消息体。

MediaId

String

媒资ID。

MediaType

String

媒资类型,取值:

  • audio:音频。

  • video:视频。

SourceURL

String

源文件地址。

JobId

String

任务ID。

AppId

String

应用ID。

UserData

String

用户自定义数据。

Status

String

状态。取值:Success、Fail。

ImageUploadComplete:图片上传完成

消息体示例:

{
    "EventType": "ImageUploadComplete",
    "UserId": 183322097756****,
    "EventTime": "2022-07-06T08:27:52Z",
    "MessageBody": {
        "Status": "Success",
        "FileUrl": "https://outin-***.oss-cn-shanghai.aliyuncs.com/image/default/E81B931FA75246B3972844D35291****-6-2.jpg",
        "MediaId": "7e976e80fd0571ec82115523919d****",
        "AppId": "app-1000000",
        "Size": "132066",
        "MediaType": "image"
    }
}

消息体参数字段说明:

参数名称

类型

必填

描述

EventType

String

事件类型。

UserId

Long

用户ID。

EventTime

String

事件产生时间(UTC时间),格式为yyyy-MM-ddTHH:mm:ssZ

MessageBody

-

Object

-

消息体。

MediaId

String

媒资ID。

MediaType

String

媒资类型,取值:image。

FileUrl

String

文件地址。

Size

String

文件大小。

AppId

String

应用ID。

UserData

String

用户自定义数据。

Status

String

状态。取值:Success、Fail。

AttachedMediaUploadComplete:辅助媒资上传完成

消息体示例:

{
    "EventType": "AttachedMediaUploadComplete",
    "UserId": 183322097756****,
    "EventTime": "2022-07-15T06:38:33Z",
    "MessageBody": {
        "Status": "Success",
        "FileUrl": "https://outin-***.oss-cn-shanghai.aliyuncs.com/subtitle/4C3C3021EC704639A9F2F55BB0C9****-3-3.ass",
        "MediaId": "b3e59350040871ed9d535532918c****",
        "AppId": "app-1000000",
        "Size": "34758",
        "MediaType": "text"
    }
}

消息体参数字段说明:

参数名称

类型

必选

描述

EventType

String

事件类型。

UserId

Long

用户ID。

EventTime

String

事件产生时间(UTC时间),格式为yyyy-MM-ddTHH:mm:ssZ

MessageBody

-

Object

消息体。

MediaId

String

媒资ID。

MediaType

String

媒资类型,取值:text。

FileUrl

String

文件地址。

Size

String

文件大小。

AppId

String

应用ID。

UserData

String

用户自定义数据。

Status

String

状态。取值:Success、Fail。

RegisterStreamComplete:媒体流注册完成

消息体示例:

{
    "EventType": "RegisterStreamComplete",
    "UserId": 127753575120****,
    "EventTime": "2022-07-13T09:34:39Z",
    "MessageBody": {
        "Status": "Success",
        "FileUrl": "https://***.oss-cn-shenzhen.aliyuncs.com/%E6%8E%A5%E5%8F%A3%E6%B5%8B%E8%AF%95/900d1-b****.aac",
        "MediaId": "fa04bee0028e71edb10f81848c01****",
        "UserData": "{\"MessageCallback\":{\"CallbackURL\":\"***\",\"CallbackType\":\"http\"}}"
    }
}

消息体参数字段说明:

参数名称

类型

必选

描述

EventType

String

事件类型。

UserId

Long

用户ID。

EventTime

String

事件产生时间(UTC时间),格式为yyyy-MM-ddTHH:mm:ssZ

MessageBody

-

Object

消息体。

MediaId

String

媒资ID。

FileUrl

String

文件地址。

UserData

String

用户自定义数据。

Status

String

状态。取值:Success、Fail。

StreamUploadComplete:媒体流上传完成

消息体示例:

{
    "EventType": "StreamUploadComplete",
    "UserId": 174809843091****,
    "EventTime": "2022-07-05T12:53:30Z",
    "MessageBody": {
        "Status": "Success",
        "FileUrl": "http://***.aliyuncs.com/vod-f1e0dd/stream/b37ff450fc6071ec9c5e472190a9****/a0c69a523724cc432c897dcaa6f3****-fd.mp4",
        "MediaId": "b37ff450fc6071ec9c5e472190a9****",
        "UserData": "{\"MessageCallback\":\"{\\\"CallbackURL\\\":\\\"***\\\",\\\"CallbackType\\\":\\\"http\\\"}\"}"
    }
}

消息体参数字段说明:

参数名称

类型

必选

描述

EventType

String

事件类型。

UserId

Long

用户ID。

EventTime

String

事件产生时间(UTC时间),格式为yyyy-MM-ddTHH:mm:ssZ

MessageBody

-

Object

消息体。

MediaId

String

媒资ID。

FileUrl

String

文件地址。

UserData

String

用户自定义数据。

Status

String

状态。取值:Success、Fail。

UploadStreamByURLComplete:媒体流URL上传完成

消息体示例:

{
    "EventType": "UploadStreamByURLComplete",
    "UserId": 174809843091****,
    "EventTime": "2022-07-07T08:09:14Z",
    "MessageBody": {
        "Status": "Success",
        "SourceURL": "http://***/example/html5/mov_bbb.mp4",
        "MediaId": "0f65faa0fdcc71ecbfcd472190a9****",
        "UserData": "{\"MessageCallback\":\"{\\\"CallbackURL\\\":\\\"***\\\",\\\"CallbackType\\\":\\\"http\\\"}\"}",
        "JobId": "7f0d49297cb0fa50ab7341fd60f4****"
    }
}

消息体参数字段说明:

参数名称

类型

必选

描述

EventType

String

事件类型。

UserId

Long

用户ID。

EventTime

String

事件产生时间(UTC时间),格式为yyyy-MM-ddTHH:mm:ssZ

MessageBody

-

Object

消息体。

MediaId

String

媒资ID。

SourceURL

String

源文件地址。

JobId

String

任务ID。

UserData

String

用户自定义数据。

Status

String

状态。取值:Success、Fail。

CreateAuditComplete:人工审核完成

消息体示例:

{
    "EventType": "CreateAuditComplete",
    "UserId": 183320223010****,
    "EventTime": "2022-06-23T13:11:33Z",
    "MessageBody": {
        "Status": "Success",
        "Auditor": "auditor",
        "Comment": "test",
        "AuditStatus": "Normal",
        "MediaId": "71151b80f2d471ecb21b472190a9****",
        "CreationTime": "2022-06-23T13:11:33Z",
        "Reason": "test"
    }
}

消息体参数字段说明:

参数名称

类型

必选

描述

EventType

String

事件类型。

UserId

Long

用户ID。

EventTime

String

事件产生时间(UTC时间),格式为yyyy-MM-ddTHH:mm:ssZ

MessageBody

-

Object

消息体。

MediaId

String

媒资ID。

AuditStatus

String

审核状态,取值:

  • Init:初始化。

  • Normal:正常。

  • Blocked:屏蔽。

Auditor

String

审核员。

Reason

String

原因。

Comment

String

评论。

CreationTime

String

创建时间。

Status

String

人工审核任务状态,取值:

  • Success:任务执行成功。

  • Failed:任务执行失败。

RegisterMediaComplete:媒资注册完成

事件说明:

调用RegisterMediaInfo注册内容库资源,在媒资分析完成后触发回调。

消息体示例:

{
    "EventType": "RegisterMediaComplete",
    "UserId": 183320223010****,
    "EventTime": "2022-06-23T13:11:33Z",
    "MessageBody": {
        "Status": "Success",
        "MediaId": "71151b80f2d471ecb21b472190a9****"
    }
}

消息体参数字段说明:

参数名称

类型

必选

描述

EventType

String

事件类型。

UserId

Long

用户ID。

EventTime

String

事件产生时间(UTC时间),格式为yyyy-MM-ddTHH:mm:ssZ

MessageBody

-

Object

消息体。

MediaId

String

媒资ID。

Status

String

媒资注册任务状态,取值:

  • Success:任务执行成功。

  • Failed:任务执行失败。

UserData

String

用户自定义数据。

ErrorCode

String

错误码。

ErrorMessage

String

错误信息。

DeleteMediaComplete:媒资删除完成

事件说明:

调用以下OpenAPI时会触发回调:

消息体示例:

{
    "EventType": "DeleteMediaComplete",
    "UserId": 183320223010****,
    "EventTime": "2022-06-23T13:11:33Z",
    "MessageBody": {
        "Status": "Success",
        "MediaId": "71151b80f2d471ecb21b472190a9****",
        "DeleteType": "all"
    }
}

消息体参数字段说明:

参数名称

类型

必选

描述

EventType

String

事件类型。

UserId

Long

用户ID。

EventTime

String

事件产生时间(UTC时间),格式为yyyy-MM-ddTHH:mm:ssZ

MessageBody

-

Object

消息体。

MediaId

String

媒资ID。

Status

String

媒资删除任务状态,取值:

  • Success:任务执行成功。

  • Failed:任务执行失败。

DeleteType

String

删除资源类型,取值:

  • all:完整媒体信息,源文件。

  • stream:转码输出流信息。

  • info:仅逻辑删除。

FileURLs

String

仅当DeleteType为stream时才会返回。

ErrorCode

String

错误码。

ErrorMessage

String

错误信息。

MediaBaseChangeComplete:媒资基础信息变更完成

事件说明:

调用以下OpenAPI时会触发回调:

消息体示例:

{
  "EventType": "MediaBaseChangeComplete",
  "UserId": 183320223010****,
  "EventTime": "2022-06-23T13:11:33Z",
  "MessageBody": {
    "Status":"Success",
    "MediaId":"3b46b391419aj294m83b459f7435****",
    "MediaType":"video",
    "OperateMode":"update",
    "MediaContent":"{\"CoverURL\":\"{\\\"OldValue\\\":\\\"https://outin-8e7b1c7d2a3811eb83da00163e00****.oss-cn-shanghai.aliyuncs.com/0202342e8ae944d09695fd7dbc6d69dc/snapshots/4a6c26eb46a841a3b60c1d56acce****-00005.jpg\\\",\\\"NewValue\\\":\\\"http://cdn.com/ee.png\\\"}\"}"
  }
}

消息体参数字段说明:

参数名称

类型

必填

描述

EventType

String

事件类型。

UserId

Long

用户ID。

EventTime

String

事件产生时间(UTC时间),格式为yyyy-MM-ddTHH:mm:ssZ

MessageBody

-

Object

消息体。

Status

String

媒资基础信息变更任务状态,取值:

  • Success:任务执行成功。

  • Failed:任务执行失败。

MediaType

String

媒体类型,取值:

  • video:视频。

  • audio:音频。

  • image:图片。

  • text:字幕字体。

  • material:资源包。

MediaId

String

媒体ID。

OperateMode

String

操作方式,取值:

  • create:新增媒资基础信息,此时MediaContent参数中OldValue字段为空。

  • update:更新媒资基础信息,此时MediaContent参数中OldValue为修改前的值,NewValue为修改后的值。

  • delete:删除媒资基础信息,此时MediaContent参数中NewValue字段为空。

MediaContent

-

Object

媒资修改内容,JSON字符串,支持音视频基础信息。

Title

String

标题,JSON字符串, 取值示例:{"OldValue":"OldTitle", "NewValue":"NewTitle"}

Description

String

描述,JSON字符串,取值示例:{"OldValue":"OldDesc", "NewValue":"NewDesc"}

CoverURL

String

封面图片,JSON字符串,取值示例:{"OldValue":"OldCoverURL", "NewValue": "NewCoverURL"}

CateId

String

分类ID,JSON字符串,取值示例:{"OldValue":123, "NewValue":456}

Tags

String

标签,JSON字符串,取值示例:{"OldValue":"OldTag", "NewValue" :"NewTag"}