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

Intelligent Media Services は、メディアアセットのアップロード、メディア処理、およびオンライン編集のためのコールバックイベントを提供します。これらのイベントを設定して、ジョブの進行状況とステータスに関する最新情報をタイムリーに受け取ることができます。このトピックでは、各イベントタイプのメッセージ本文の例とパラメーターの詳細について説明します。

使用上の注意

HTTP(S) コールバックを使用する場合、メッセージ本文はリクエストパケットの内容です。Message Service (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：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	はい	ソースファイルの 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/API-Test/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: ジョブは成功です。 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: メディアアセットの削除が完了しました

説明：

このコールバックは、以下の操作を呼び出したときにトリガーされます：

メッセージ本文の例：

{
    "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: メディアアセットの基本情報の変更が完了

説明：

このコールバックは、以下の操作を呼び出したときにトリガーされます：

メッセージ本文の例：

{
  "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: メディアアセットの基本情報を更新します。この場合、`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"}`。