文档

事件列表

更新时间:

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

使用说明

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

目录

表 1. 媒资上传

事件

描述

FileUploadComplete

音视频上传完成

UploadByURLComplete

URL上传完成

ImageUploadComplete

图片上传完成

AttachedMediaUploadComplete

辅助媒资上传完成

RegisterStreamComplete

媒体流注册完成

StreamUploadComplete

媒体流上传完成

UploadStreamByURLComplete

媒体流URL上传完成

表 2. 媒资管理

事件

描述

CreateAuditComplete

人工审核完成

RegisterMediaComplete

媒资注册完成

DeleteMediaComplete

媒资删除完成

MediaBaseChangeComplete

媒资基础信息变更完成

表 3. 工作流

事件

描述

WorkflowTaskComplete

工作流处理结果

表 4. 点播媒体处理

事件

描述

VideoAnalysisComplete

音视频分析完成

SnapshotComplete

视频截图完成

DynamicImageComplete

视频动图完成

TranscodeComplete

子任务转码完成

TranscodeParentComplete

主任务转码完成

表 5. 视频AI

事件

描述

AIMediaAuditComplete

AI审核完成

AIProduceComplete

AI生产完成

表 6. 智能剪辑

事件

描述

ProduceMediaComplete

媒体合成完成

BatchProduceMediaComplete

批量智能一键成片任务完成

表 7. 实时媒体处理

事件

描述

LiveRecordFileCreated

直播文件生成

LiveRecordTaskStatus

直播录制状态

LiveSnapshotFileCreated

直播截图回调

事件详情

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

状态。

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

状态。

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

状态。

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

状态。

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

状态。

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

状态。

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

状态。

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

WorkflowTaskComplete:工作流处理结果

消息体示例:

{
  "EventType": "WorkflowTaskComplete",
  "UserId": 183322097735****,
  "EventTime": "2022-07-08T02:22:48Z",
  "MessageBody": {
    "TaskInput": "{\"Type\":\"Media\",\"Media\":\"4c3a4a30041b71edbfc96732b68f****\"}",
    "TaskId": "71151b80f2d471ecb21b472190a9****",
    "WorkflowId": "SW-1010****",
    "Status": "Succeed",
    "CreateTime": "2022-07-08T02:19:19Z"
  }
}
            

消息体参数字段说明:

参数名称

类型

必选

描述

EventType

String

事件类型。

UserId

Long

用户ID。

EventTime

String

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

MessageBody

-

Object

-

消息体。

TaskInput

String

工作流任务输入。

TaskId

String

工作流任务ID。

WorkflowId

String

工作流ID。

Status

String

工作流任务状态,取值:

  • Init:任务初始化。

  • Processing:任务执行中。

  • Succeed:任务执行成功。

  • Failed:任务执行失败。

  • Canceled:任务被取消。

CreateTime

String

工作流任务创建时间(UTC时间),格式为yyyy-MM-ddTHH:mm:ssZ

VideoAnalysisComplete:音视频分析完成

消息体示例:

{
    "EventType": "VideoAnalysisComplete",
    "UserId": 183322097756****,
    "EventTime": "2022-07-15T08:52:17Z",
    "MessageBody": {
        "Status": "Success",
        "FileUrl": "https://outin-***.oss-cn-shanghai.aliyuncs.com/sv/51246387-182010e2655/51246387-182010e****.mp4",
        "MediaId": "4c3a4a30041b71edbfc96732b68f****",
        "MetaInfo": {
            "Size": "77570208",
            "Fps": 24.0,
            "Duration": "68.576667",
            "Height": "1440",
            "Width": "3120",
            "Bitrate": "9049.17"
        }
    }
}

消息体参数字段说明:

参数名称

类型

必选

描述

EventType

String

事件类型。

UserId

Long

用户ID。

EventTime

String

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

MessageBody

-

Object

消息体。

MediaId

String

媒资ID。

FileUrl

String

文件地址。

UserData

String

用户自定义数据。

Status

String

状态。

MetaInfo

-

Object

分析结果。

Duration

String

时长,单位:秒。

Height

String

高,单位:px。

Width

String

宽,单位:px。

Bitrate

String

码率,单位:Kbps。

Size

String

大小,单位:Byte。

Fps

Double

帧率,单位:帧/每秒。

SnapshotComplete:视频截图完成

消息体示例:

{
  "EventType": "SnapshotComplete",
  "UserId": 183320223010****,
  "EventTime": "2021-09-28T01:30:19Z",
  "MessageBody": {
    "JobId": "11a32131403478e92cc01399855****",
    "TriggerSource": "API",
    "Name": "test job",
    "Type": "Sprite",
    "Input": "{\"type\":\"OSS\",\"media\":\"http://bucket-empty.oss-cn-shanghai.aliyuncs.com/xxx.mp4\",\"ossFile\":{\"Bucket\":\"bucket-empty\",\"Location\":\"oss-cn-shanghai\",\"Object\":\"xxx.mp4\"}}",
    "Output": "{\"type\":\"OSS\",\"media\":\"http://bucket-empty.oss-cn-shanghai.aliyuncs.com/yyy-{Count}.jpg\",\"ossFile\":{\"Bucket\":\"bucket-empty\",\"Location\":\"oss-cn-shanghai\",\"Object\":\"yyy-{Count}.jpg\"}}",
    "Count": 5,
    "TemplateConfig": "{\"Count\":5,\"FrameType\":\"normal\",\"Height\":720,\"Interval\":5,\"Time\":20,\"Type\":\"Normal\",\"Width\":1280}",
    "TemplateId": "2590d131403478e92cc01399833****",
    "PipelineId": "3a791131403478e92cc01399862****",
    "Status": "Success",
    "ErrorCode": "ResourceNotFound",
    "ErrorMessage": "The input resource cannot be found.",
    "UserData": "{\"aaa\": \"bbb\"}",
    "SubmitTime": "2021-09-28T01:10:19Z",
    "FinishTime": "2021-09-28T01:20:19Z"
  }
}

消息体参数字段说明:

参数名称

类型

必选

描述

JobId

String

任务ID。

TriggerSource

String

触发来源,取值:

  • API:OpenAPI。

  • Console:控制台。

  • Workflow:工作流。

Name

String

任务名称。

Type

String

截图任务类型,取值:

  • Normal:普通静态截图。

  • Sprite:雪碧图。

  • WebVtt:WebVTT截图。

Input

String

任务输入,JSON字符串。

Output

String

任务输出,JSON字符串。

Count

Integer

截图数量。

TemplateConfig

String

任务参数。

TemplateId

String

任务模板ID。

PipelineId

String

管道ID。

SubmitTime

String

任务发起时间(UTC时间),格式为yyyy-MM-ddTHH:mm:ssZ

FinishTime

String

任务结束时间(UTC时间),格式为yyyy-MM-ddTHH:mm:ssZ

UserData

String

用户自定义透传数据。

Status

String

任务状态,取值:

  • Success:任务执行成功。

  • Fail:任务执行失败。

ErrorCode

String

错误码,任务失败时非空。

ErrorMessage

String

错误消息,任务失败时非空。

DynamicImageComplete:视频动图完成

消息体示例:

{
  "EventType": "DynamicImageComplete",
  "UserId": 183320223010****,
  "EventTime": "2021-09-28T01:30:19Z",
  "MessageBody": {
    "JobId": "11a32131403478e92cc01399855****",
    "TriggerSource": "API",
    "Name": "test job",
    "Input": "{\"type\":\"OSS\",\"media\":\"http://bucket-empty.oss-cn-shanghai.aliyuncs.com/xxx.mp4\",\"ossFile\":{\"Bucket\":\"bucket-empty\",\"Location\":\"oss-cn-shanghai\",\"Object\":\"xxx.mp4\"}}",
    "Output": "{\"type\":\"OSS\",\"media\":\"http://bucket-empty.oss-cn-shanghai.aliyuncs.com/yyy.gif\",\"ossFile\":{\"Bucket\":\"bucket-empty\",\"Location\":\"oss-cn-shanghai\",\"Object\":\"yyy.gif\"}}",
    "TemplateConfig": "{\"Count\":5,\"FrameType\":\"normal\",\"Height\":720,\"Interval\":5,\"Time\":20,\"Type\":\"Normal\",\"Width\":1280}",
    "TemplateId": "2590d131403478e92cc01399833****",
    "PipelineId": "3a791131403478e92cc01399862****",
    "Status": "Success",
    "ErrorCode": "ResourceNotFound",
    "ErrorMessage": "The input resource cannot be found.",
    "UserData": "{\"aaa\": \"bbb\"}",
    "SubmitTime": "2021-09-28T01:10:19Z",
    "FinishTime": "2021-09-28T01:20:19Z"
  }
}

消息体参数字段说明:

参数名称

类型

必选

描述

JobId

String

任务ID。

TriggerSource

String

触发来源,取值:

  • API:OpenAPI。

  • Console:控制台。

  • Workflow:工作流。

Name

String

任务名称。

Input

String

任务输入,JSON字符串。

Output

String

任务输出,JSON字符串。

TemplateConfig

String

任务参数。

TemplateId

String

任务模板ID。

PipelineId

String

管道ID。

SubmitTime

String

任务发起时间(UTC时间),格式为yyyy-MM-ddTHH:mm:ssZ

FinishTime

String

任务结束时间(UTC时间),格式为yyyy-MM-ddTHH:mm:ssZ

UserData

String

用户自定义透传数据。

Status

String

任务状态,取值:

  • Success:任务执行成功。

  • Fail:任务执行失败。

ErrorCode

String

错误码,任务失败时非空。

ErrorMessage

String

错误消息,任务失败时非空。

TranscodeComplete:子任务转码完成

消息体示例:

{
  "EventType": "TranscodeComplete",
  "UserId": 183322097756****,
  "EventTime": "2022-06-27T08:41:32Z",
  "MessageBody": {
    "Status": "Success",
    "FinishTime": "2022-06-27T08:41:32Z",
    "OutFileMeta": {
      "audioStreamInfoList": [],
      "subtitleStreamInfoList": [],
      "videoStreamInfoList": [
        {
          "time_base": "1/12800",
          "level": "31",
          "sar": "32:21",
          "profile": "High",
          "fps": "25.0",
          "index": "0",
          "avg_fps": "25.0",
          "codec_name": "h264",
          "duration": "403.040000",
          "pixFmt": "yuv420p",
          "bit_rate": "316.728",
          "start_time": "0.000000",
          "codec_tag": "0x31637661",
          "has_b_frames": "4",
          "dar": "16:9",
          "codec_time_base": "1/50",
          "width": "700",
          "codec_tag_string": "avc1",
          "lang": "und",
          "codec_long_name": "H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10",
          "height": "600"
        }
      ],
      "fileBasicInfo": {
        "duration": "403",
        "fileName": "yinhuazengqinag0627001.mp4",
        "fileSize": "16078713",
        "fileStatus": "Normal",
        "formatName": "mov,mp4,m4a,3gp,3g2,mj2",
        "width": "700",
        "bitrate": "319",
        "fileUrl": "http://laisi-vedio-****.oss-cn-shanghai.aliyuncs.com/output/01iceout/yinhuazengqinag062****.mp4",
        "region": "cn-shanghai",
        "fileType": "transcode_file",
        "height": "600"
      }
    },
    "ParentJobId": "a11f624c98e84f6b839d4ffb74b7****",
    "TriggerSource": "Console",
    "JobId": "533d2c5eac5b4f0aaf2d09c7ee884cae",
    "OutputUrl": "http://laisi-vedio-****.oss-cn-shanghai.aliyuncs.com/output/01iceout/yinhuazengqinag062****.mp4"
  }
}

消息体参数字段说明:

参数名称

类型

必选

描述

ParentJobId

String

主任务ID。

JobId

String

子任务ID。

TriggerSource

String

触发来源,取值:

  • API:OpenAPI。

  • Console:控制台。

  • Workflow:工作流。

OutFileMeta

Object

输出文件信息,详情请参见GetTranscodeJob返回参数

OutputUrl

String

输出文件URL。

FinishTime

String

任务结束时间(UTC时间),格式为yyyy-MM-ddTHH:mm:ssZ

UserData

String

用户自定义透传数据。

Status

String

任务状态,取值:

  • Success:任务执行成功。

  • Fail:任务执行失败。

ErrorCode

String

错误码,任务失败时非空。

ErrorMessage

String

错误消息,任务失败时非空。

TranscodeParentComplete:主任务转码完成

消息体示例:

{
  "EventType": "TranscodeParentComplete",
  "UserId": 183322097756****,
  "EventTime": "2022-06-27T08:41:32Z",
  "MessageBody": {
    "Status": "Success",
    "FinishTime": "2022-06-27T08:41:32Z",
    "Jobs": [
      {
        "Status": "Success",
        "JobId": "533d2c5eac5b4f0aaf2d09c7ee88****",
        "OutputUrl": "http://laisi-vedio****.oss-cn-shanghai.aliyuncs.com/output/01iceout/yinhuazengqinag062****.mp4"
      }
    ],
    "ParentJobId": "a11f624c98e84f6b839d4ffb74b7****",
    "TriggerSource": "Console",
    "Name": "音画增强-0001"
  }
}

消息体参数字段说明:

参数名称

类型

必选

描述

ParentJobId

String

主任务ID。

Jobs

Array

子任务信息,包含字段:

  • Status:子任务状态,取值:Success、Fail。

  • JobId:子任务ID。

  • OutputUrl:输出URL。

TriggerSource

String

触发来源,取值:

  • API:OpenAPI。

  • Console:控制台。

  • Workflow:工作流。

Name

String

任务名称。

FinishTime

String

任务结束时间(UTC时间),格式为yyyy-MM-ddTHH:mm:ssZ

UserData

String

用户自定义透传数据。

Status

String

任务状态,取值:

  • Success:任务执行成功。

  • Fail:任务执行失败。

AIMediaAuditComplete:AI审核完成

消息体示例:

{
    "EventType":"AIMediaAuditComplete",
    "UserId":183322097756****,
    "EventTime":"2022-07-19T03:06:12Z",
    "MessageBody":{
        "Status":"Success",
        "MediaId":"{\"media\":\"02389c00031e71edbfdc90a58843****\",\"type\":\"Media\"}",
        "JobId":"12fa59321345435e84d610d4cb1e****"
    }
}

消息体参数字段说明:

参数名称

类型

必选

描述

EventType

String

事件类型。

UserId

Long

用户ID。

EventTime

String

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

MessageBody

JobId

String

事件ID。

Status

String

任务状态,取值:

  • Success:任务执行成功。

  • Fail:任务执行失败。

MediaId

String

媒体ID。

AIProduceComplete:AI生产完成

消息体示例:

{
    "EventType": "AIProduceComplete",
    "UserId": 171533008416****,
    "EventTime": "2022-07-14T02:26:54Z",
    "MessageBody": {
        "Status": "Success",
        "FunctionName": "Cover",
        "UserData": "{\"www\":111}",
        "OutputFiles": ["meinv-00002.jpg", "meinv-00001.jpg", "meinv-00003.jpg"],
        "JobId": "168510ad1a2a4806bfce31fe1799532c",
        "Result": "[{\"Score\":5.891979105782871,\"Time\":\"1966.6666666666665\",\"Url\":\"meinv-00002.jpg\"},{\"Score\":5.610427496267542,\"Time\":\"2966.666666666667\",\"Url\":\"meinv-00001.jpg\"},{\"Score\":4.963208311043985,\"Time\":\"10966.666666666666\",\"Url\":\"meinv-00003.jpg\"}]"
    }
}

消息体参数字段说明:

参数名称

类型

必选

描述

EventType

String

事件类型。

UserId

Long

用户ID。

EventTime

String

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

MessageBody

JobId

String

事件ID。

Status

String

任务状态,取值:

  • Success:任务执行成功。

  • Fail:任务执行失败。

FunctionName

String

AI生产类型,取值:

  • Cover:智能封面,包含静态封面和动态封面。

  • VideoClip:视频摘要。

  • VideoDelogo:擦除图标。

  • VideoDetext:擦除字幕。

OutputFiles

String[]

生成的文件列表。

Result

String

算法输出的额外信息,例如,置信度等。

UserData

String

用户自定义数据。

ProduceMediaComplete:媒体合成完成

消息体示例:

{
  "EventType": "ProduceMediaComplete",
  "UserId": 183320223000****,
  "EventTime": "2022-07-13T10:49:45Z",
  "MessageBody": {
    "Status": "Success",
    "MediaURL": "https://your-bucket.oss-cn-shanghai.aliyuncs.com/xxxxx.mp4",
    "MediaId": "1d1cbbc46da24edd9cf11ba5d193****",
    "ProjectId": "aded28bac782446a8e5a7cf86b67****",
    "ErrorCode": "",
    "ErrorMessage": "",
    "JobId": "8bc08c859569446ca5303ea903ca****",
    "UserData": "{\"NotifyAddress\":\"http://xx.xx.xxx\"}"
  }
}

消息体参数字段说明:

参数名称

类型

必选

描述

EventType

String

事件类型。

UserId

Long

用户ID。

EventTime

String

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

MessageBody

-

Object

-

消息体。

Status

String

任务状态。

MediaURL

String

云剪辑成片地址。

MediaId

String

云剪辑成片媒资ID。

ProjectId

String

云剪辑工程ID。

ErrorCode

String

云剪辑错误码。

ErrorMessage

String

云剪辑错误信息。

JobId

String

云剪辑任务ID。

UserData

String

客户自定义设置。

MasterJobId

String

如果当前云剪辑任务是批量智能一键成片任务的一个子任务,该字段不为空,表示主任务的任务ID。

BatchProduceMediaComplete:批量智能一键成片任务完成

消息体示例:

{
	"EventType": "BatchProduceMediaComplete",
	"UserId": 183320223000****,
	"EventTime": "2024-01-09T08:37:24Z",
	"MessageBody": {
		"Status": "Finished",
		"UserData": "{\"NotifyAddress\":\"https://**.**.**\"}",
		"JobId": "61195f35cc7d4786a0bda02390cb4587"
	}
}

消息体参数字段说明:

参数名称

类型

必选

描述

EventType

String

事件类型。

UserId

Long

用户ID。

EventTime

String

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

MessageBody

-

Object

-

消息体。

Status

String

任务状态。

JobId

String

批量智能一键成片任务ID。

UserData

String

客户自定义设置。

LiveRecordFileCreated:直播文件生成

消息体示例:

{
    "EventType": "LiveRecordFileCreated",
    "UserId": 123456,
    "EventTime": "2022-06-29T01:36:02Z",
    "MessageBody": {
        "duration": 35.09,
        "jobId": "d6a856d4-ca81-47e8-9d66-*****",
        "record_id": "13a10bbb-f717-4228-9e53-db8f****",
        "start_time": 1656466420,
        "stop_time": 1656466456,
        "uri": "record/d6a856d4-ca81-47e8-9d66-*****/***.m3u8"
    }
}

消息体参数字段说明:

参数名称

类型

必选

描述

EventType

String

事件类型。

UserId

Long

用户ID。

EventTime

String

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

MessageBody

-

Object

消息体。

duration

float

录制文件时长,单位:秒。

jobId

String

UUID格式的录制任务ID。

record_id

String

UUID格式的录制文件ID。

start_time

Long

录制文件开始的时间戳。

stop_time

Long

录制文件结束的时间戳。

uri

String

录制文件在OSS Bucket中的储存路径。

LiveRecordTaskStatus:直播录制状态

消息体示例:

{
    "EventType": "LiveRecordTaskStatus",
    "UserId": 123456,
    "EventTime": "2022-06-29T01:35:32Z",
    "MessageBody": {
        "jobId": "d6a856d4-ca81-47e8-9d66-*****",
        "created": "2022-06-29T01:35:31.716Z",
        "session": "725d15ba-c589-3aeb-a3b6-*****",
        "event": "record_paused"
    }
}

消息体参数字段说明:

参数名称

类型

必选

描述

EventType

String

事件类型。

UserId

Long

用户ID。

EventTime

String

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

MessageBody

-

Object

消息体。

event

String

录制事件,取值:

  • record_error:录制任务错误。

  • record_started:开始录制任务。

  • record_paused:暂停录制任务。

  • record_resumed:继续录制任务。

  • record_force_transcode_fail:录制强制转码失败。

jobId

String

UUID格式的录制任务ID。

session

String

录制会话ID。

created

String

录制会话创建时间。

error_info

-

Object

录制错误回调信息。

code

String

错误码。

message

String

错误消息。

file_info

-

Object

文件消息。

uri

String

文件路径。

start_time

Long

录制文件开始时间,使用UNIX时间戳表示。

stop_time

Long

录制文件结束时间,使用UNIX时间戳表示。

LiveSnapshotFileCreated:直播截图回调

消息体示例:

{
    "MessageBody": {
        "SnapshotUrl": "http://example.com/bucket/snapshot.jpg",
        "JobId": "cef3de8c-b02c-4462-ad02-****",
        "StreamInputUrl": "rtmp://example.com/app/stream",
        "Bucket": "OssBucket",
        "Height": 720,
        "Width": 1280,
        "Endpoint": "oss-cn-shanghai.aliyuncs.com",
        "Object": "app/snapshot.jpg",
        "Size": 50000
    },
    "EventTime": "2022-08-08T09:10:02Z",
    "UserId": 123456,
    "EventType": "LiveSnapshotFileCreated"
}

消息体参数字段说明:

参数名称

类型

必选

描述

EventType

String

事件类型。

UserId

Long

用户ID。

EventTime

String

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

MessageBody

-

Object

消息体。

SnapshotUrl

String

截图文件地址。

jobId

String

UUID格式的录制任务ID。

StreamInputUrl

String

直播流名。

Bucket

String

OSS bucket名称。

Height

Integer

截图高度,单位:px。

Width

Integer

截图宽度,单位:px。

Endpoint

String

OSS Endpoint。

Object

String

OSS对象储存路径。

Size

Integer

文件大小,单位:Byte。

  • 本页导读 (1)
文档反馈