瞭解各類型事件的訊息體樣本和對應參數欄位詳細說明 - Intelligent Media Services

智能媒體服務提供媒資上傳、ApsaraVideo for Media Processing、雲剪輯等相關的回調事件，您可通過設定指定的回調事件及時擷取任務處理進展和狀態。通過閱讀本文，您可以瞭解各類型事件的訊息體樣本和對應參數欄位詳細說明。

使用說明

如果回調類型為HTTP(S)請求，本文中的訊息體為請求包內容；如果回調類型為MNS隊列，訊息體為隊列接收的訊息內容。

事件	描述
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	是	檔案地址。
	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	是	源檔案地址。
	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	是	檔案地址。
	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	是	檔案地址。
	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/%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	是	狀態。取值：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	是	檔案地址。
	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	是	源檔案地址。
	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：媒資刪除完成

事件說明：

調用以下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"}`。

Intelligent Media Services：事件列表

使用說明

目錄

事件詳情

FileUploadComplete：音視頻上傳完成

UploadByURLComplete：URL上傳完成

ImageUploadComplete：圖片上傳完成

AttachedMediaUploadComplete：輔助媒資上傳完成

RegisterStreamComplete：媒體流註冊完成

StreamUploadComplete：媒體流上傳完成

UploadStreamByURLComplete：媒體流URL上傳完成

CreateAuditComplete：人工審核完成

RegisterMediaComplete：媒資註冊完成

DeleteMediaComplete：媒資刪除完成

MediaBaseChangeComplete：媒資基礎資訊變更完成