Kueri Partisipan Grup IM dengan ListChatGroupParticipants API - Chat App Message Service - Alibaba Cloud - Chat App Message Service

Deskripsi operasi

Penting

This operation is an internal preview feature. Contact your account manager to request access.

Before calling this operation, ensure you have created an IM group with an invitation link, and that members have joined by using that link.
To create an IM group and add an invitation link, call the AddChatGroup and AddChatGroupInviteLink operations.

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

cams:ListChatGroupParticipants

list

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
BusinessNumber	string	Yes	Nomor bisnis. Anda dapat memanggil operasi ListChatGroup untuk mendapatkan nomor bisnis.	8613800***
ChannelType	string	No	Tipe saluran. Nilai valid: WHATSAPP Catatan Operasi ini hanya mendukung saluran WhatsApp.	WHATSAPP
GroupId	string	Yes	ID kelompok. Anda dapat memanggil operasi ListChatGroup untuk mendapatkan ID kelompok.	EA939****
CustSpaceId	string	Yes	ID instans untuk pelanggan langsung atau SpaceId untuk pelanggan sub-ISV. Anda dapat menemukan ID tersebut di halaman Channel Management pada Konsol.	cams-k***
Page	object	No	Informasi paging.
Size	integer	No	The page size.	20
Index	integer	No	The page number.	1

Elemen respons

Element	Type	Description	Example
	object
AccessDeniedDetail	string	The details about the access denial.	None
Message	string	The error message.	None
RequestId	string	The request ID.	90E63D28-E31D-1EB2-8939-A94866411B2O
Data	object	The response data.
Total	integer	The total number of participants.	8
List	array<object>	The list of group members.
	object	Information about a group member.
ParticipantNumber	string	The group member.	861382***
Code	string	The request status code. Valid values: OK: The request was successful. For other values, see the error code list.	OK
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true

Contoh

Respons sukses

JSONformat

{
  "AccessDeniedDetail": "None",
  "Message": "None",
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2O",
  "Data": {
    "Total": 8,
    "List": [
      {
        "ParticipantNumber": "861382***"
      }
    ]
  },
  "Code": "OK",
  "Success": true
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.