Mengkueri daftar pengguna dalam sebuah kelompok.
Deskripsi operasi
Sebelum memanggil operasi ini, Anda harus telah membuat kelompok pesan interaktif dengan memanggil CreateLiveMessageGroup.
Untuk kelompok sangat besar (kelompok dengan lebih dari 2.000 anggota), kueri daftar anggota tidak lagi didukung. Selain itu, notifikasi untuk anggota yang bergabung atau keluar dari kelompok dikirim dengan interval minimal 5 detik. Notifikasi tidak menampilkan daftar lengkap pengguna yang bergabung atau keluar, tetapi menampilkan jumlah anggota kelompok yang tepat. Setelah kelompok ditingkatkan menjadi kelompok sangat besar, daftar anggota segera dihapus. Kelompok tidak dapat dikembalikan ke kelompok reguler hingga semua anggota keluar dari kelompok (kelompok ditutup). Ketika kelompok dibuka kembali, kelompok tersebut dipulihkan menjadi kelompok reguler.
Batas QPS
Batas QPS per pengguna tunggal untuk operasi 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
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
live:ListLiveMessageGroupUsers |
list |
*Rtc.
|
None | None |
Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| AppId |
string |
Yes |
ID aplikasi interaktif langsung yang akan dikueri. |
demo |
| GroupId |
string |
Yes |
ID kelompok dari kelompok yang akan dikueri. |
grouptest |
| PageSize |
integer |
Yes |
Jumlah pengguna yang ditampilkan per halaman. Nilai valid: 10 hingga 50. |
10 |
| SortType |
integer |
Yes |
Urutan pengurutan. Pengguna diurutkan berdasarkan pengatur waktu mereka bergabung dengan kelompok. Nilai valid:
Valid values:
|
1 |
| NextPageToken |
integer |
No |
Posisi awal halaman kueri. Jika parameter ini dibiarkan kosong, halaman pertama dikembalikan secara default. |
1 |
| DataCenter |
string |
No |
Pusat data lokal. Nilai ini harus sama dengan pusat data lokal yang ditentukan dalam CreateLiveMessageApp. Nilai valid: cn-shanghai (Shanghai) dan ap-southeast-1 (Singapura). |
cn-shanghai |
Elemen respons
|
Element |
Type |
Description |
Example |
|
object |
Skema Respons. |
||
| RequestId |
string |
ID permintaan. |
A1D75BEA-1329-116F-B29C-76F3F200**** |
| GroupId |
string |
ID kelompok dari kelompok yang akan dikueri. |
grouptest |
| NextPageToken |
integer |
Posisi awal halaman berikutnya. Nilai 0 menunjukkan bahwa tidak ada halaman berikutnya. |
0 |
| Hasmore |
boolean |
Menunjukkan apakah ada halaman berikutnya. |
false |
| UserList |
array<object> |
Array objek. |
|
|
object |
Detail array. |
||
| UserId |
string |
ID pengguna. |
uid1 |
| UserInfo |
string |
Informasi tambahan dari pengguna. |
info1 |
Contoh
Respons sukses
JSONformat
{
"RequestId": "A1D75BEA-1329-116F-B29C-76F3F200****",
"GroupId": "grouptest",
"NextPageToken": 0,
"Hasmore": false,
"UserList": [
{
"UserId": "uid1",
"UserInfo": "info1"
}
]
}
Kode kesalahan
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 420 | SuperLargeGroup | %s. | Ketika kelompok memiliki lebih dari 2000 anggota, kelompok tersebut ditingkatkan menjadi kelompok super dan tidak lagi mendukung pengkuerian daftar pengguna. |
| 400 | InputInvalid | %s. | Parameter input tidak valid. |
| 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.