Contoh isi pesan event dan deskripsi parameter - Intelligent Media Services

Intelligent Media Services (IMS) menyediakan callback event untuk unggahan aset media, pemrosesan media, dan pengeditan cloud. Anda dapat mengonfigurasi callback event tertentu untuk menerima pembaruan tepat waktu mengenai progres dan status tugas. Topik ini menyajikan contoh isi pesan untuk setiap jenis event beserta penjelasan field-nya.

Penggunaan

Untuk permintaan HTTP(S), isi pesan merupakan badan permintaan. Untuk antrian MNS, isi pesan merupakan konten dari pesan yang diterima.

Daftar event

Tabel 1. Unggahan aset media

Event	Deskripsi
FileUploadComplete	Berkas audio atau video diunggah.
UploadByURLComplete	Berkas diunggah dari URL.
ImageUploadComplete	Gambar diunggah.
AttachedMediaUploadComplete	Aset media pendukung diunggah.
RegisterStreamComplete	Aliran media didaftarkan.
StreamUploadComplete	Aliran media diunggah.
UploadStreamByURLComplete	Aliran media diunggah dari URL.

Tabel 2. Manajemen aset media

Event	Deskripsi
CreateAuditComplete	Tinjauan manual selesai.
RegisterMediaComplete	Aset media didaftarkan.
DeleteMediaComplete	Aset media dihapus.
MediaBaseChangeComplete	Informasi dasar aset media diperbarui.

Event

FileUploadComplete

Contoh isi pesan:

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

Parameter isi pesan:

Parameter		Type	Wajib	Deskripsi
EventType		String	Ya	Jenis event.
UserId		Long	Ya	ID pengguna.
EventTime		String	Ya	Waktu event (waktu UTC), dalam format `yyyy-MM-ddTHH:mm:ssZ`.
MessageBody	-	Object	-	Isi pesan.
	MediaId	String	Ya	ID aset media.
	MediaType	String	Ya	Jenis aset media. Nilai yang valid: `audio` `video`
	FileUrl	String	Ya	URL berkas.
	Size	String	Ya	Ukuran berkas.
	AppId	String	Ya	ID aplikasi.
	UserData	String	Tidak	Data yang ditentukan pengguna.
	Status	String	Ya	Status event. Nilai yang valid: `Success` dan `Fail`.

UploadByURLComplete

Contoh isi pesan:

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

Tabel berikut menjelaskan parameter isi pesan.

Parameter		Tipe	Wajib	Deskripsi
EventType		String	Ya	Jenis event.
UserId		Long	Ya	ID pengguna.
EventTime		String	Ya	Waktu kejadian event, dalam UTC. Formatnya adalah `yyyy-MM-ddTHH:mm:ssZ`.
MessageBody	-	Object	-	Isi pesan.
	MediaId	String	Ya	ID aset media.
	MediaType	String	Ya	Jenis aset media. Nilai yang valid: `audio` `video`
	SourceURL	String	Ya	URL berkas sumber.
	JobId	String	Ya	ID tugas.
	AppId	String	Ya	ID aplikasi.
	UserData	String	Tidak	Data yang ditentukan pengguna.
	Status	String	Ya	Status tugas. Nilai yang valid: `Success` dan `Fail`.

ImageUploadComplete

Contoh isi pesan:

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

Isi pesan berisi parameter berikut:

Parameter		Tipe	Wajib	Deskripsi
EventType		String	Ya	Jenis event.
UserId		Long	Ya	ID pengguna.
EventTime		String	Ya	Waktu kejadian event, dalam UTC. Formatnya adalah `yyyy-MM-ddTHH:mm:ssZ`.
MessageBody	-	Object	-	Isi pesan.
	MediaId	String	Ya	ID aset media.
	MediaType	String	Ya	Jenis aset media. Nilai yang valid: `image`.
	FileUrl	String	Ya	URL berkas.
	Size	String	Ya	Ukuran berkas.
	AppId	String	Ya	ID aplikasi.
	UserData	String	Tidak	Data yang ditentukan pengguna.
	Status	String	Ya	Status. Nilai yang valid: `Success` dan `Fail`.

AttachedMediaUploadComplete

Contoh isi pesan:

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

Isi pesan berisi parameter berikut.

Parameter		Tipe	Wajib	Deskripsi
EventType		String	Ya	Jenis event.
UserId		Long	Ya	ID pengguna.
EventTime		String	Ya	Waktu kejadian event, dalam UTC. Formatnya adalah `yyyy-MM-ddTHH:mm:ssZ`.
MessageBody	-	Object	Ya	Isi pesan.
	MediaId	String	Ya	ID aset media.
	MediaType	String	Ya	Jenis aset media. Nilai yang valid: `text`.
	FileUrl	String	Ya	URL berkas.
	Size	String	Ya	Ukuran berkas.
	AppId	String	Ya	ID aplikasi.
	UserData	String	Tidak	Data yang ditentukan pengguna.
	Status	String	Ya	Status unggahan. Nilai yang valid: `Success` dan `Fail`.

RegisterStreamComplete

Contoh isi pesan:

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

Tabel berikut mencantumkan parameter isi pesan.

Parameter		Tipe	Wajib	Deskripsi
EventType		String	Ya	Jenis event.
UserId		Long	Ya	ID pengguna.
EventTime		String	Ya	Waktu kejadian event, dalam UTC. Waktunya dalam format `yyyy-MM-ddTHH:mm:ssZ`.
MessageBody	-	Object	Ya	Isi pesan.
	MediaId	String	Ya	ID media.
	FileUrl	String	Ya	URL berkas.
	UserData	String	Tidak	Data opsional yang ditentukan pengguna.
	Status	String	Ya	Status. Nilai yang valid adalah `Success` dan `Fail`.

StreamUploadComplete

Contoh isi pesan:

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

Field isi pesan:

Parameter		Tipe	Wajib	Deskripsi
EventType		String	Ya	Jenis event.
UserId		Long	Ya	ID pengguna.
EventTime		String	Ya	Waktu event dalam UTC. Formatnya adalah `yyyy-MM-ddTHH:mm:ssZ`.
MessageBody	-	Object	Ya	Isi pesan.
	MediaId	String	Ya	ID aset media.
	FileUrl	String	Ya	URL berkas.
	UserData	String	Tidak	Data yang ditentukan pengguna.
	Status	String	Ya	Status. Nilai yang valid: `Success` dan `Fail`.

UploadStreamByURLComplete: Unggahan URL aliran media selesai

Contoh isi pesan:

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

Tabel ini mencantumkan parameter isi pesan.

Parameter		Jenis	Wajib	Deskripsi
EventType		String	Ya	Jenis event.
UserId		Long	Ya	ID pengguna.
EventTime		String	Ya	Waktu kejadian event, dalam UTC. Formatnya adalah `yyyy-MM-ddTHH:mm:ssZ`.
MessageBody	-	Object	Ya	Isi pesan.
	MediaId	String	Ya	ID aset media.
	SourceURL	String	Ya	URL berkas sumber.
	JobId	String	Ya	ID pekerjaan.
	UserData	String	Tidak	Data pengguna.
	Status	String	Ya	Status pekerjaan. Nilai yang valid: Success atau Fail.

CreateAuditComplete: Tinjauan manual selesai

Contoh isi pesan:

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

Isi pesan berisi parameter berikut:

Parameter		Tipe	Wajib	Deskripsi
EventType		String	Ya	Jenis event.
UserId		Long	Ya	ID pengguna.
EventTime		String	Ya	Waktu kejadian event, dalam UTC. Formatnya adalah `yyyy-MM-ddTHH:mm:ssZ`.
MessageBody	-	Object	Ya	Isi pesan.
	MediaId	String	Ya	ID aset media.
	AuditStatus	String	Ya	Status tinjauan. Nilai yang valid: Init: Aset media sedang diinisialisasi untuk tinjauan manual. Normal: Aset media lulus tinjauan manual. Blocked: Aset media diblokir oleh tinjauan manual.
	Auditor	String	Ya	Peninjau yang melakukan tinjauan manual.
	Reason	String	Ya	Alasan hasil tinjauan.
	Comment	String	Ya	Komentar peninjau.
	CreationTime	String	Ya	Waktu pembuatan tugas tinjauan manual.
	Status	String	Ya	Status tugas tinjauan manual. Nilai yang valid: Success: Tugas selesai. Failed: Tugas gagal.

RegisterMediaComplete

Deskripsi event:

Untuk mendaftarkan aset media ke pustaka konten, panggil RegisterMediaInfo. Callback dipicu setelah analisis aset media selesai.

Contoh isi pesan:

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

Isi pesan mencakup parameter berikut:

Parameter		Tipe	Wajib	Deskripsi
EventType		String	Ya	Jenis event.
UserId		Long	Ya	ID pengguna.
EventTime		String	Ya	Waktu event dalam UTC, dalam format ISO 8601: `yyyy-MM-ddTHH:mm:ssZ`.
MessageBody	-	Object	Ya	Isi pesan.
	MediaId	String	Ya	ID aset media.
	Status	String	Ya	Status tugas pendaftaran. Nilai yang valid meliputi: `Success`: Tugas berhasil. `Failed`: Tugas gagal.
	UserData	String	Tidak	Data yang ditentukan pengguna.
	ErrorCode	String	Tidak	Kode kesalahan yang dikembalikan jika tugas gagal.
	ErrorMessage	String	Tidak	Pesan kesalahan yang dikembalikan jika tugas gagal.

DeleteMediaComplete

Event

Event ini dipicu saat Anda memanggil salah satu operasi OpenAPI berikut:

Contoh isi pesan:

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

Isi pesan berisi parameter berikut.

Parameter		Jenis	Wajib	Deskripsi
EventType		String	Ya	Jenis event.
UserId		Long	Ya	ID pengguna.
EventTime		String	Ya	Waktu dalam UTC saat event terjadi, dalam format `yyyy-MM-ddTHH:mm:ssZ` (ISO 8601).
MessageBody	-	Object	Ya	Isi pesan.
	MediaId	String	Ya	ID aset media.
	Status	String	Ya	Status tugas penghapusan aset media. Nilai yang valid: `Success`: Tugas berhasil. `Failed`: Tugas gagal.
	DeleteType	String	Ya	Jenis resource yang dihapus. Nilai yang valid: `all`: Menghapus semua informasi tentang aset media, termasuk berkas sumber. `stream`: Menghapus informasi tentang aliran yang telah dikodekan ulang. `info`: Melakukan penghapusan logis saja.
	FileURLs	String	Tidak	Parameter ini hanya ada jika `DeleteType` diatur ke `stream`.
	ErrorCode	String	Tidak	Kode kesalahan.
	ErrorMessage	String	Tidak	Pesan kesalahan.

MediaBaseChangeComplete: Informasi dasar media diperbarui

Deskripsi event:

Memanggil salah satu operasi OpenAPI berikut memicu callback ini:

Contoh isi pesan:

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

Isi pesan berisi parameter berikut:

Parameter			Jenis	Wajib	Deskripsi
EventType			String	Ya	Jenis event.
UserId			Long	Ya	ID pengguna.
EventTime			String	Ya	Waktu kejadian event, dalam UTC. Formatnya harus `yyyy-MM-ddTHH:mm:ssZ`.
MessageBody	-		Object	Ya	Isi pesan.
	Status		String	Ya	Status tugas pembaruan aset media. Nilai yang valid: `Success`: Tugas berhasil. `Failed`: Tugas gagal.
	MediaType		String	Ya	Jenis media. Nilai yang valid: `video`: Video. `audio`: Audio. `image`: Gambar. `text`: Berkas subtitle atau font. `material`: Paket resource.
	MediaId		String	Ya	ID media.
	OperateMode		String	Ya	Mode operasi. Nilai yang valid: `create`: Membuat informasi dasar untuk aset media. Field `OldValue` dalam parameter `MediaContent` kosong. `update`: Memperbarui informasi dasar aset media. Field `OldValue` dalam parameter `MediaContent` adalah nilai sebelum pembaruan, dan field `NewValue` adalah nilai setelah pembaruan. `delete`: Menghapus informasi dasar aset media. Field `NewValue` dalam parameter `MediaContent` kosong.
	MediaContent	-	Object	Ya	Konten modifikasi aset media. Objek ini berisi informasi dasar untuk berkas audio dan video.
		Title	String	Tidak	Judul, diformat sebagai string JSON. Contoh: `{"OldValue": "OldTitle", "NewValue": "NewTitle"}`.
		Description	String	Tidak	Deskripsi, diformat sebagai string JSON. Contoh: `{"OldValue": "OldDesc", "NewValue": "NewDesc"}`.
		CoverURL	String	Tidak	URL gambar thumbnail, diformat sebagai string JSON. Contoh: `{"OldValue": "OldCoverURL", "NewValue": "NewCoverURL"}`.
		CateId	String	Tidak	ID kategori, diformat sebagai string JSON. Contoh: `{"OldValue": 123, "NewValue": 456}`.
		Tags	String	Tidak	Tag, diformat sebagai string JSON. Contoh: `{"OldValue": "OldTag", "NewValue": "NewTag"}`.