Message body examples and parameter details for event types - Intelligent Media Services

Intelligent Media Services provides callback events for media asset uploads, media processing, and online editing. You can configure these events to receive timely updates on job progress and status. This topic describes message body examples and parameter details for each event type.

Usage notes

If you use HTTP(S) callbacks, the message body is the content of the request packet. If you use Message Service (MNS) queue callbacks, the message body is the content of the message received by the queue.

Event details

FileUploadComplete: Audio or video upload is complete

Message body example:

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

Message body parameters:

Parameter		Type	Required	Description
EventType		String	Yes	The event type.
UserId		Long	Yes	The user ID.
EventTime		String	Yes	The time when the event occurred. The time is in UTC and the format is `yyyy-MM-ddTHH:mm:ssZ`.
MessageBody	-	Object	-	The message body.
	MediaId	String	Yes	The media asset ID.
	MediaType	String	Yes	The media asset type. Valid values: audio: audio video: video
	FileUrl	String	Yes	The file URL.
	Size	String	Yes	The file size.
	AppId	String	Yes	The application ID.
	UserData	String	No	The user-defined data.
	Status	String	Yes	The status. Valid values: Success, Fail.

UploadByURLComplete: Upload from URL is complete

Message body example:

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

Message body parameters:

Parameter		Type	Required	Description
EventType		String	Yes	The event type.
UserId		Long	Yes	The user ID.
EventTime		String	Yes	The time when the event occurred. The time is in UTC and the format is `yyyy-MM-ddTHH:mm:ssZ`.
MessageBody	-	Object	-	The message body.
	MediaId	String	Yes	The media asset ID.
	MediaType	String	Yes	The media asset type. Valid values: audio: audio video: video
	SourceURL	String	Yes	The source file URL.
	JobId	String	Yes	The job ID.
	AppId	String	Yes	The application ID.
	UserData	String	No	The user-defined data.
	Status	String	Yes	The status. Valid values: Success, Fail.

ImageUploadComplete: Image upload is complete

Message body example:

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

Message body parameters:

Parameter		Type	Required	Description
EventType		String	Yes	The event type.
UserId		Long	Yes	The user ID.
EventTime		String	Yes	The time when the event occurred. The time is in UTC and the format is `yyyy-MM-ddTHH:mm:ssZ`.
MessageBody	-	Object	-	The message body.
	MediaId	String	Yes	The media asset ID.
	MediaType	String	Yes	The media asset type. Valid value: image.
	FileUrl	String	Yes	The file URL.
	Size	String	Yes	The file size.
	AppId	String	Yes	The application ID.
	UserData	String	No	The user-defined data.
	Status	String	Yes	The status. Valid values: Success, Fail.

AttachedMediaUploadComplete: Auxiliary media asset upload is complete

Message body example:

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

Message body parameters:

Parameter		Type	Required	Description
EventType		String	Yes	The event type.
UserId		Long	Yes	The user ID.
EventTime		String	Yes	The time when the event occurred. The time is in UTC and the format is `yyyy-MM-ddTHH:mm:ssZ`.
MessageBody	-	Object	Yes	The message body.
	MediaId	String	Yes	The media asset ID.
	MediaType	String	Yes	The media asset type. Valid value: text.
	FileUrl	String	Yes	The file URL.
	Size	String	Yes	The file size.
	AppId	String	Yes	The application ID.
	UserData	String	No	The user-defined data.
	Status	String	Yes	The status. Valid values: Success, Fail.

RegisterStreamComplete: Media stream registration is complete

Message body example:

{
    "EventType": "RegisterStreamComplete",
    "UserId": 127753575120****,
    "EventTime": "2022-07-13T09:34:39Z",
    "MessageBody": {
        "Status": "Success",
        "FileUrl": "https://***.oss-cn-shenzhen.aliyuncs.com/API-Test/900d1-b****.aac",
        "MediaId": "fa04bee0028e71edb10f81848c01****",
        "UserData": "{\"MessageCallback\":{\"CallbackURL\":\"***\",\"CallbackType\":\"http\"}}"
    }
}

Message body parameters:

Parameter		Type	Required	Description
EventType		String	Yes	The event type.
UserId		Long	Yes	The user ID.
EventTime		String	Yes	The time when the event occurred. The time is in UTC and the format is `yyyy-MM-ddTHH:mm:ssZ`.
MessageBody	-	Object	Yes	The message body.
	MediaId	String	Yes	The media asset ID.
	FileUrl	String	Yes	The file URL.
	UserData	String	No	The user-defined data.
	Status	String	Yes	The status. Valid values: Success, Fail.

StreamUploadComplete: Media stream upload is complete

Message body example:

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

Message body parameters:

Parameter		Type	Required	Description
EventType		String	Yes	The event type.
UserId		Long	Yes	The user ID.
EventTime		String	Yes	The time when the event occurred. The time is in UTC and the format is `yyyy-MM-ddTHH:mm:ssZ`.
MessageBody	-	Object	Yes	The message body.
	MediaId	String	Yes	The media asset ID.
	FileUrl	String	Yes	The file URL.
	UserData	String	No	The user-defined data.
	Status	String	Yes	The status. Valid values: Success, Fail.

UploadStreamByURLComplete: Media stream upload from URL is complete

Message body example:

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

Message body parameters:

Parameter		Type	Required	Description
EventType		String	Yes	The event type.
UserId		Long	Yes	The user ID.
EventTime		String	Yes	The time when the event occurred. The time is in UTC and the format is `yyyy-MM-ddTHH:mm:ssZ`.
MessageBody	-	Object	Yes	The message body.
	MediaId	String	Yes	The media asset ID.
	SourceURL	String	Yes	The source file URL.
	JobId	String	Yes	The job ID.
	UserData	String	No	The user-defined data.
	Status	String	Yes	The status. Valid values: Success, Fail.

CreateAuditComplete: Manual review is complete

Message body example:

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

Message body parameters:

Parameter		Type	Required	Description
EventType		String	Yes	The event type.
UserId		Long	Yes	The user ID.
EventTime		String	Yes	The time when the event occurred. The time is in UTC and the format is `yyyy-MM-ddTHH:mm:ssZ`.
MessageBody	-	Object	Yes	The message body.
	MediaId	String	Yes	The media asset ID.
	AuditStatus	String	Yes	The review status. Valid values: Init: initialization Normal: Normal Blocked: Blocked
	Auditor	String	Yes	The reviewer.
	Reason	String	Yes	The reason.
	Comment	String	Yes	The comment.
	CreationTime	String	Yes	The creation time.
	Status	String	Yes	The status of the manual review job. Valid values: Success: The job is successful. Failed: The job failed.

RegisterMediaComplete: Media asset registration is complete

Description:

This callback is triggered after media asset analysis is complete. This occurs when you call the RegisterMediaInfo operation to register a resource in the content library.

Message body example:

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

Message body parameters:

Parameter		Type	Required	Description
EventType		String	Yes	The event type.
UserId		Long	Yes	The user ID.
EventTime		String	Yes	The time when the event occurred. The time is in UTC and the format is `yyyy-MM-ddTHH:mm:ssZ`.
MessageBody	-	Object	Yes	The message body.
	MediaId	String	Yes	The media asset ID.
	Status	String	Yes	The status of the media asset registration job. Valid values: Success: The job is successful. Failed: The job failed.
	UserData	String	No	The user-defined data.
	ErrorCode	String	No	The error code.
	ErrorMessage	String	No	The error message.

DeleteMediaComplete: Media asset deletion is complete

Description:

This callback is triggered when you call the following operations:

Message body example:

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

Message body parameters:

Parameter		Type	Required	Description
EventType		String	Yes	The event type.
UserId		Long	Yes	The user ID.
EventTime		String	Yes	The time when the event occurred. The time is in UTC and the format is `yyyy-MM-ddTHH:mm:ssZ`.
MessageBody	-	Object	Yes	The message body.
	MediaId	String	Yes	The media asset ID.
	Status	String	Yes	The status of the media asset deletion job. Valid values: Success: The job is successful. Failed: The job failed.
	DeleteType	String	Yes	The type of resource to delete. Valid values: all: all media information and the source file. stream: transcoded stream information. info: logical deletion only.
	FileURLs	String	No	This parameter is returned only when DeleteType is set to stream.
	ErrorCode	String	No	The error code.
	ErrorMessage	String	No	The error message.

MediaBaseChangeComplete: Change to basic media asset information is complete

Description:

This callback is triggered when you call the following operations:

Message body example:

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

Message body parameters:

Parameter			Type	Required	Description
EventType			String	Yes	The event type.
UserId			Long	Yes	The user ID.
EventTime			String	Yes	The time when the event occurred. The time is in UTC and the format is `yyyy-MM-ddTHH:mm:ssZ`.
MessageBody	-		Object	Yes	The message body.
	Status		String	Yes	The status of the job to change basic media asset information. Valid values: Success: The job is successful. Failed: The job failed.
	MediaType		String	Yes	The media type. Valid values: video: video audio: audio image: image text: caption font material: resource plan
	MediaId		String	Yes	The media ID.
	OperateMode		String	Yes	The operation mode. Valid values: create: Adds basic information about the media asset. In this case, the `OldValue` field in the `MediaContent` parameter is empty. update: Updates the basic information of the media asset. In this case, the `OldValue` field is the value before the update, and the `NewValue` field is the value after the update. delete: Deletes the basic information of the media asset. In this case, the `NewValue` field in the `MediaContent` parameter is empty.
	MediaContent	-	Object	Yes	The modified content of the media asset. This is a JSON string that supports basic audio and video information.
		Title	String	No	The title. This is a JSON string. Example: `{"OldValue":"OldTitle", "NewValue":"NewTitle"}`.
		Description	String	No	The description. This is a JSON string. Example: `{"OldValue":"OldDesc", "NewValue":"NewDesc"}`.
		CoverURL	String	No	The thumbnail image. This is a JSON string. Example: `{"OldValue":"OldCoverURL", "NewValue": "NewCoverURL"}`.
		CateId	String	No	The category ID. This is a JSON string. Example: `{"OldValue":123, "NewValue":456}`.
		Tags	String	No	The tags. This is a JSON string. Example: `{"OldValue":"OldTag", "NewValue" :"NewTag"}`.

Intelligent Media Services:Event list

Usage notes

Directory

Event details

FileUploadComplete: Audio or video upload is complete

UploadByURLComplete: Upload from URL is complete

ImageUploadComplete: Image upload is complete

AttachedMediaUploadComplete: Auxiliary media asset upload is complete

RegisterStreamComplete: Media stream registration is complete

StreamUploadComplete: Media stream upload is complete

UploadStreamByURLComplete: Media stream upload from URL is complete

CreateAuditComplete: Manual review is complete

RegisterMediaComplete: Media asset registration is complete

DeleteMediaComplete: Media asset deletion is complete

MediaBaseChangeComplete: Change to basic media asset information is complete

Event	Description
FileUploadComplete	Audio or video upload is complete
UploadByURLComplete	Upload from URL is complete
ImageUploadComplete	Image upload is complete
AttachedMediaUploadComplete	Auxiliary media asset upload is complete
RegisterStreamComplete	Media stream registration is complete
StreamUploadComplete	Media stream upload is complete
UploadStreamByURLComplete	Media stream upload from URL is complete

Event	Description
CreateAuditComplete	Manual review is complete
RegisterMediaComplete	Media asset registration is complete
DeleteMediaComplete	Media asset deletion is complete
MediaBaseChangeComplete	Change to basic media asset information is complete