Gunakan CreateLiveMessageApp API untuk Membuat Aplikasi Pesan Langsung - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Deskripsi operasi

Saat memanggil operasi API pesan interaktif lainnya, Pusat data lokal harus sama dengan yang ditentukan saat membuat aplikasi pesan interaktif.
Maksimal 300 aplikasi pesan interaktif dapat dibuat di bawah satu akun Alibaba Cloud.

Batas QPS

Batas QPS per pengguna tunggal untuk operasi API ini adalah 50 panggilan per detik. Jika batas ini terlampaui, panggilan API akan dibatasi (throttled), yang dapat memengaruhi bisnis Anda. Panggil operasi ini dengan tepat.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

live:CreateLiveMessageApp

create

*Semua sumber daya.

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
AppName	string	No	Nama aplikasi. Panjang nama harus 2 hingga 16 karakter.	testApp
AuditType	integer	No	Mode audit keamanan. Nilai valid: 0: nilai default. Audit keamanan dinonaktifkan. 1: audit keamanan bawaan. 2: audit keamanan kustom. Valid values: 0 : audit keamanan dinonaktifkan. 1 : audit keamanan bawaan. 2 : audit keamanan kustom.	2
AuditUrl	string	No	URL untuk audit keamanan kustom. Parameter ini diperlukan ketika audit keamanan kustom dipilih (AuditType=2). URL harus dimulai dengan http:// atau https://, tidak boleh berisi alamat IP privat, dan tidak boleh menyertakan nomor Port. Untuk format konten audit keamanan kustom, lihat bagian berikut.	http://demo.aliyundoc.com/exampleaudit
EventCallbackUrl	string	No	URL callback event untuk event logon klien, logout, join kelompok, dan leave kelompok. Jika parameter ini kosong, callback event dinonaktifkan. Untuk operasi API callback yang dipicu, lihat Akses Klien. URL callback event harus dimulai dengan http:// atau https://, tidak boleh berisi alamat IP privat, dan tidak boleh menyertakan nomor Port. Untuk format callback event dan logika otentikasi callback, lihat bagian berikut.	http://demo.aliyundoc.com/examplecallback
DataCenter	string	No	Pusat data lokal. Nilai valid: cn-shanghai: nilai default. Shanghai. ap-southeast-1: Singapura. Catatan Saat memanggil operasi API pesan interaktif lainnya, Pusat data lokal harus sama dengan yang ditentukan saat membuat aplikasi pesan interaktif.	cn-shanghai
MsgLifeCycle	integer	No	Tingkat Durasi penyimpanan untuk pesan kelompok dalam aplikasi. Nilai valid: 0: nilai default. Pesan disimpan selama 30 hari. 1: pesan disimpan selama 90 hari. 2: pesan disimpan selama 180 hari.	1

Deskripsi konten audit keamanan kustom:

Protokol permintaan: HTTP
Metode permintaan: POST
Contoh permintaan:

{
  "content": "testaudit"
}

Contoh respons:

{
  "pass": true,
  "reason":"****"    |pass diatur ke true menunjukkan konten lulus audit. Jika tidak, konten tidak lulus. reason menunjukkan alasan penolakan.
}

Catatan

Kode status HTTP 200 menunjukkan keberhasilan. Kode status non-200 menunjukkan bahwa layanan tidak tersedia, dan sistem mengalami degradasi dengan melewatkan audit untuk pesan tersebut.

Callback event

HTTP/HTTPS POST. Body adalah string JSON UTF-8 dalam format berikut. Contoh callback event:

{
  "appid":"demo",
  "eves":[{
  "uid":"uid1",
  "sid":"sessionid",
  "events":[{
     "e": 3, |Tipe event. Enumerasi. 1: logon, 2: logout, 3: joingroup, 4: leavegroup, 5: koneksi ulang klien setelah pemutusan jaringan
     "r": 1, |Alasan logout. Atribut ini tidak ada untuk event lain. Enumerasi. 1: panggilan normal, 3: timeout, 4: logon dari perangkat lain
     "g": "testgroup", |ID kelompok. Nilai ini ada untuk event join dan leave kelompok. Atribut ini tidak ada untuk event logon dan logout.
     "gs":["testgroupid"] |Daftar ID kelompok. Ketika klien terhubung kembali setelah pemutusan jaringan, ini berisi kelompok yang telah diikuti klien. Atribut ini tidak ada untuk event lain.
  }]
  }]
}

Catatan

Kode status HTTP 200 menunjukkan keberhasilan. Kode status lain menunjukkan kegagalan, dan sistem akan mencoba kembali pengiriman.

Deskripsi otentikasi callback

Ketika layanan memulai permintaan, header permintaan HTTP(S) menyertakan bidang Ali-Live-Timestamp dan Ali-Live-Signature agar server penerima pesan callback dapat melakukan otentikasi tanda tangan. Nilai Ali-Live-Signature dihitung sebagai berikut: Ali-Live-Signature=sha256(CONTENT). CONTENT = nama domain callback + nilai Ali-Live-Timestamp + kunci otentikasi. Nama domain callback adalah nama domain yang dikonfigurasi dalam URL callback. Kunci otentikasi adalah AppKey yang dihasilkan saat AppId dibuat.

Elemen respons

Element	Type	Description	Example
	object	Parameter tanggapan.
RequestId	string	ID permintaan.	65EEDBEB-43FE-1E15-976F-3DDD753A****
AppId	string	ID aplikasi, yang digunakan untuk operasi berikutnya seperti join kelompok.	demo
AppKey	string	AppKey, yang digunakan untuk menghasilkan otentikasi untuk berbagai operasi terkait AppId.	**********************************
AppSign	string	Tanda tangan aplikasi. SDK layanan pesan interaktif memerlukan informasi ini.	**************************************************************************
DataCenter	string	Pusat data lokal.	cn-shanghai

Contoh

Respons sukses

JSONformat

{
  "RequestId": "65EEDBEB-43FE-1E15-976F-3DDD753A****",
  "AppId": "demo",
  "AppKey": "**********************************",
  "AppSign": "**************************************************************************",
  "DataCenter": "cn-shanghai"
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	InputInvalid	%s.	Parameter input tidak valid.
400	ErrorInvalidAppName	%s.	AppName tidak valid. Periksa nilai dan coba lagi.
400	ErrorTooManyApps	%s.	Maksimal 300 aplikasi dapat dibuat untuk setiap akun secara bersamaan.
400	ErrorInvalidEventCallbackUrl	%s.	EventCallbackUrl tidak valid. Periksa nilai dan coba lagi.
400	ErrorInvalidAuditUrl	%s.	AuditUrl tidak valid. Periksa nilai dan coba lagi.
500	ServerError	%s.	Terjadi kesalahan tidak diketahui. Coba lagi nanti atau ajukan tiket.
403	NoAuth	%s.	Anda tidak memiliki izin yang diperlukan.
404	ResourceNotExist	%s.	Sumber daya yang diminta tidak ada. Periksa permintaan dan coba lagi.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.