イベントメッセージ本文の例とパラメーターの説明 - Intelligent Media Services

Intelligent Media Services (IMS) は、メディアアセットのアップロード、メディア処理、クラウド編集に関するコールバックイベントを提供します。特定のコールバックイベントを設定することで、タスクの進捗状況やステータスをリアルタイムで受け取ることができます。本トピックでは、各イベントタイプのメッセージ本文のサンプルとフィールドの説明を提供します。

使用方法

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	はい	ファイル URL。
	Size	String	はい	ファイルサイズ。
	AppId	String	はい	アプリケーション ID。
	UserData	String	いいえ	ユーザー定義データ。
	Status	String	はい	イベントステータス。有効な値：`Success` および `Fail`。

UploadByURLComplete

メッセージ本文のサンプル：

{
    "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	はい	ソースファイル URL。
	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	はい	ファイル URL。
	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	はい	ファイル URL。
	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/InterfaceTest/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	はい	ファイル URL。
	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	はい	ファイル URL。
	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	はい	ソースファイル URL。
	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：タスクが完了しました。失敗: タスクが失敗しました。

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)。ISO 8601 形式：`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` (ISO 8601) です。
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	はい	メディアアセット変更の内容。このオブジェクトには、音声および動画ファイルの基本情報が含まれます。
		Title	String	いいえ	タイトル。JSON 文字列形式。例：`{"OldValue": "OldTitle", "NewValue": "NewTitle"}`。
		Description	String	いいえ	説明。JSON 文字列形式。例：`{"OldValue": "OldDesc", "NewValue": "NewDesc"}`。
		CoverURL	String	いいえ	サムネイル画像の URL。JSON 文字列形式。例：`{"OldValue": "OldCoverURL", "NewValue": "NewCoverURL"}`。
		CateId	String	いいえ	カテゴリ ID。JSON 文字列形式。例：`{"OldValue": 123, "NewValue": 456}`。
		Tags	String	いいえ	タグ。JSON 文字列形式。例：`{"OldValue": "OldTag", "NewValue": "NewTag"}`。