Event message body examples and parameter descriptions - Intelligent Media Services

Usage

For an HTTP(S) request, the message body is the request body. For an MNS queue, it is the content of the received message.

Event list

Table 1. Media asset upload

Event	Description
FileUploadComplete	An audio or video file is uploaded.
UploadByURLComplete	A file is uploaded from a URL.
ImageUploadComplete	An image is uploaded.
AttachedMediaUploadComplete	An auxiliary media asset is uploaded.
RegisterStreamComplete	A media stream is registered.
StreamUploadComplete	A media stream is uploaded.
UploadStreamByURLComplete	A media stream is uploaded from a URL.

Table 2. Media asset management

Event	Description
CreateAuditComplete	A manual review is complete.
RegisterMediaComplete	A media asset is registered.
DeleteMediaComplete	A media asset is deleted.
MediaBaseChangeComplete	A media asset's basic information is updated.

Event

FileUploadComplete

Sample message body:

{
    "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	Event time (UTC time), in the format `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` `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 event status. Valid values: `Success` and `Fail`.

UploadByURLComplete

Sample message body:

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

The following table describes the parameters for the message body.

Parameter		Type	Required	Description
EventType		String	Yes	The event type.
UserId		Long	Yes	The user ID.
EventTime		String	Yes	The time the event occurred, in UTC. 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` `video`
	SourceURL	String	Yes	The source file URL.
	JobId	String	Yes	The task ID.
	AppId	String	Yes	The application ID.
	UserData	String	No	The user-defined data.
	Status	String	Yes	The task status. Valid values: `Success` and `Fail`.

ImageUploadComplete

Sample message body:

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

The message body contains the following 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, in UTC. 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` and `Fail`.

AttachedMediaUploadComplete

Sample message body:

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

The message body contains the following parameters.

Parameter		Type	Required	Description
EventType		String	Yes	The event type.
UserId		Long	Yes	The user ID.
EventTime		String	Yes	The time at which the event occurred, in UTC. 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 upload status. Valid values: `Success` and `Fail`.

RegisterStreamComplete

Sample message body:

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

The following table lists the parameters of the message body.

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

StreamUploadComplete

Sample message body:

{
    "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 fields:

Parameter		Type	Required	Description
EventType		String	Yes	The event type.
UserId		Long	Yes	The user ID.
EventTime		String	Yes	The event time in UTC. 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` and `Fail`.

UploadStreamByURLComplete: Media stream URL upload complete

Sample message body:

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

This table lists the message body parameters.

Parameter		Type	Required	Description
EventType		String	Yes	The event type.
UserId		Long	Yes	The user ID.
EventTime		String	Yes	The time the event occurred, in UTC. 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 data.
	Status	String	Yes	The job status. Valid values: Success or Fail.

CreateAuditComplete: Manual review complete

Sample message body:

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

The message body contains the following parameters:

Parameter		Type	Required	Description
EventType		String	Yes	The event type.
UserId		Long	Yes	The user ID.
EventTime		String	Yes	The time the event occurred, in UTC. 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: The media asset is initializing for manual review. Normal: The media asset passed the manual review. Blocked: The media asset was blocked by the manual review.
	Auditor	String	Yes	The reviewer who performed the manual review.
	Reason	String	Yes	The reason for the review result.
	Comment	String	Yes	The reviewer's comment.
	CreationTime	String	Yes	The creation time of the manual review task.
	Status	String	Yes	The state of the manual review task. Valid values: Success: The task completed. Failed: The task failed.

RegisterMediaComplete

Event description:

To register a media asset with the content library, call RegisterMediaInfo. A callback is triggered once the media asset analysis is complete.

Sample message body:

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

The message body includes the following parameters:

Parameter		Type	Required	Description
EventType		String	Yes	The type of event.
UserId		Long	Yes	The ID of the user.
EventTime		String	Yes	The event time in UTC, in ISO 8601 format: `yyyy-MM-ddTHH:mm:ssZ`.
MessageBody	-	Object	Yes	The body of the message.
	MediaId	String	Yes	The ID of the media asset.
	Status	String	Yes	The status of the registration task. Valid values include: `Success`: The task succeeded. `Failed`: The task failed.
	UserData	String	No	User-defined data.
	ErrorCode	String	No	The error code returned if the task fails.
	ErrorMessage	String	No	The error message returned if the task fails.

DeleteMediaComplete

Event

This callback is triggered when you call one of the following OpenAPI operations:

Sample message body:

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

The message body contains the following parameters.

Parameter		Type	Required	Description
EventType		String	Yes	The event type.
UserId		Long	Yes	The user ID.
EventTime		String	Yes	The time in UTC when the event occurred, in `yyyy-MM-ddTHH:mm:ssZ` format (ISO 8601).
MessageBody	-	Object	Yes	The message body.
	MediaId	String	Yes	The ID of the media asset.
	Status	String	Yes	The status of the media asset deletion task. Valid values: `Success`: The task succeeded. `Failed`: The task failed.
	DeleteType	String	Yes	The type of resource to delete. Valid values: `all`: Deletes all information about the media asset, including the source file. `stream`: Deletes information about the transcoded stream. `info`: Performs a logical delete only.
	FileURLs	String	No	This parameter is present only if `DeleteType` is set to `stream`.
	ErrorCode	String	No	The error code.
	ErrorMessage	String	No	The error message.

MediaBaseChangeComplete: Basic media information updated

Event description:

Calling one of the following OpenAPI operations triggers this callback:

Sample message body:

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

The message body contains the following 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, in UTC. The format must be `yyyy-MM-ddTHH:mm:ssZ`.
MessageBody	-		Object	Yes	The message body.
	Status		String	Yes	The status of the media asset update task. Valid values: `Success`: The task succeeded. `Failed`: The task failed.
	MediaType		String	Yes	The media type. Valid values: `video`: Video. `audio`: Audio. `image`: Image. `text`: Subtitle or font file. `material`: Resource package.
	MediaId		String	Yes	The media ID.
	OperateMode		String	Yes	The operation mode. Valid values: `create`: Creates the basic information for a media asset. The `OldValue` field in the `MediaContent` parameter is empty. `update`: Updates the basic information of a media asset. The `OldValue` field in the `MediaContent` parameter is the value before the update, and the `NewValue` field is the value after the update. `delete`: Deletes the basic information of a media asset. The `NewValue` field in the `MediaContent` parameter is empty.
	MediaContent	-	Object	Yes	The content of the media asset modification. This object contains basic information for audio and video files.
		Title	String	No	The title, formatted as a JSON string. Example: `{"OldValue": "OldTitle", "NewValue": "NewTitle"}`.
		Description	String	No	The description, formatted as a JSON string. Example: `{"OldValue": "OldDesc", "NewValue": "NewDesc"}`.
		CoverURL	String	No	The URL of the thumbnail image, formatted as a JSON string. Example: `{"OldValue": "OldCoverURL", "NewValue": "NewCoverURL"}`.
		CateId	String	No	The category ID, formatted as a JSON string. Example: `{"OldValue": 123, "NewValue": 456}`.
		Tags	String	No	The tags, formatted as a JSON string. Example: `{"OldValue": "OldTag", "NewValue": "NewTag"}`.