Membuat aplikasi pesan interaktif.
Deskripsi operasi
Saat memanggil operasi API pesan interaktif lainnya, Pusat data lokal harus sama dengan yang digunakan untuk membuat aplikasi pesan interaktif.
Anda dapat membuat hingga 300 aplikasi pesan interaktif di bawah satu akun Alibaba Cloud.
Batas QPS
Batas QPS pengguna tunggal untuk operasi API ini adalah 50 panggilan per detik. Jika batas terlampaui, panggilan API akan dibatasi, yang dapat memengaruhi bisnis Anda. Panggil operasi ini dengan tepat.
Coba sekarang
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
live:CreateLiveMessageApp |
create |
*Semua Sumber daya.
|
None | None |
Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| AppName |
string |
No |
Nama aplikasi. Nama harus terdiri dari 2 hingga 16 karakter. |
testApp |
| AuditType |
integer |
No |
Mode audit keamanan. Nilai valid:
Valid values:
|
2 |
| AuditUrl |
string |
No |
URL untuk audit keamanan kustom. Parameter ini diperlukan saat audit keamanan kustom dipilih (AuditType=2). URL harus diawali dengan http:// atau https://, tidak boleh berisi alamat IP pribadi, 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, logout, join kelompok, dan leave kelompok klien. Jika parameter ini kosong, callback event dinonaktifkan. Untuk operasi API yang memicu callback, lihat Akses klien. URL callback event harus diawali dengan http:// atau https://, tidak boleh berisi alamat IP pribadi, 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:
Catatan
Saat memanggil operasi API pesan interaktif lainnya, Pusat data lokal harus sama dengan yang digunakan untuk membuat aplikasi pesan interaktif. |
cn-shanghai |
| MsgLifeCycle |
integer |
No |
Tingkatan durasi penyimpanan untuk pesan kelompok dalam aplikasi. Nilai valid:
|
1 |
Deskripsi konten audit keamanan kustom:
Protokol permintaan: HTTP
Metode permintaan: POST
Contoh permintaan:
{
"content": "testaudit"
}
Contoh respons:
{
"pass": true,
"reason":"****" |Jika pass bernilai true, audit berhasil. Jika tidak, audit tidak berhasil. reason menunjukkan alasan kegagalan.
}
Kode status HTTP 200 menunjukkan keberhasilan. Kode status selain 200 menunjukkan bahwa layanan tidak tersedia, dan sistem akan beralih ke melewati audit untuk pesan tersebut.
Callback event
HTTP/HTTPS POST. Body berupa 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: klien terhubung kembali setelah pemutusan jaringan
"r": 1, |Alasan logout. Atribut ini tidak ada untuk event lainnya. Enumerasi. 1: panggilan normal, 3: waktu habis, 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. Saat klien terhubung kembali setelah pemutusan jaringan, ini berisi kelompok yang telah diikuti klien. Atribut ini tidak ada untuk event lainnya.
}]
}]
}
Kode status HTTP 200 menunjukkan keberhasilan. Kode status lainnya menunjukkan kegagalan, dan sistem akan mencoba ulang pengiriman.
Deskripsi otentikasi callback
Saat 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), di mana CONTENT = nama domain callback + nilai Ali-Live-Timestamp + kunci otentikasi. Nama domain callback adalah nama domain dari URL callback yang dikonfigurasi. 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 dalam operasi berikutnya seperti bergabung ke kelompok. |
demo |
| AppKey |
string |
AppKey, yang digunakan untuk menghasilkan otentikasi untuk berbagai operasi yang terkait dengan AppId ini. |
********************************** |
| 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 di bawah 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 error yang 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.