Gunakan API ListChatGroup untuk Query Data Grup IM - Chat App Message Service - Alibaba Cloud - Chat App Message Service

Mengambil daftar grup IM.

Deskripsi operasi

Penting

Mengambil daftar grup IM melalui API adalah fitur beta. Hubungi manajer akun Anda untuk ditambahkan ke daftar yang diizinkan.

Anda harus memiliki grup IM sebelum memanggil operasi ini.
Jika Anda tidak memiliki grup IM, Anda hanya dapat membuatnya dengan memanggil API AddChatGroup.
Parameter opsional untuk operasi ini memfilter daftar grup IM. Jika Anda tidak menentukan filter apa pun, operasi akan mengembalikan daftar grup IM lengkap.

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:ListChatGroup

list

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
BusinessNumber	string	Yes	Nomor bisnis.	8613800***
ChannelType	string	No	Jenis saluran. Nilai yang valid: WHATSAPP. Catatan Hanya saluran WhatsApp yang didukung.	WHATSAPP
CustSpaceId	string	Yes	ID instans (atau SpaceId) dari sub-pelanggan ISV, yang juga berfungsi sebagai ID saluran. Anda dapat menemukannya di halaman Manajemen Saluran.	cams-x***
GroupStatus	string	No	Status grup. Nilai yang valid: ACTIVE: Sedang digunakan. INACTIVE: Tidak diaktifkan. SUSPENDED: Ditangguhkan. CREATING: Sedang dibuat. DELETING: Sedang dihapus. UPDATING: Sedang diperbarui.	ACTIVE
Subject	string	No	Judul grup.	test
GroupType	string	No	Jenis grup Telegram.	example
GroupLink	string	No	Tautan grup Telegram.	example
Page	object	Yes	Informasi paginasi.	示例值
Size	integer	Yes	Jumlah entri per halaman.	20
Index	integer	Yes	Nomor halaman.	1

Elemen respons

Element	Type	Description	Example
	object
AccessDeniedDetail	string	Detail tentang kesalahan akses ditolak.	None
Message	string	Pesan respons. Parameter ini hanya dikembalikan jika terjadi kesalahan.	None
RequestId	string	ID permintaan.	90E63D28-E31D-1EB2-8939-A94866411B2O
Data	object	Data yang dikembalikan.
Total	integer	Jumlah total entri.	51
List	array<object>	Daftar grup.
	object	Objek grup.
Description	string	The description of the group.	test
BusinessNumber	string	The business number associated with the group.	8613800**
InviteLink	string	The invitation link for the group.	https://chat.whatsapp.com/***
GroupStatus	string	The status of the group.	ACTIVE
ProfilePictureFile	string	The profile picture of the group.	https://*********/png.jpg
Subject	string	The title of the group.	This is a test subject
GroupId	string	The ID of the group.	EA30d***
GroupLink	string	The link to the group.	example
TotalParticipantCount	integer	The total number of participants in the group.	35
GroupType	string	The group type.	example
BusinessRole	string	The role of the bot in the group.	example
GmtModifier	integer	The time when the group was last updated.	94
Code	string	Kode status. Nilai yang valid: `OK`: Permintaan berhasil. Untuk kode kesalahan lainnya, lihat Kode kesalahan.	OK
Success	boolean	Menunjukkan apakah permintaan berhasil. Nilai yang valid: true: Permintaan berhasil. false: Permintaan gagal.	true

Contoh

Respons sukses

JSONformat

{
  "AccessDeniedDetail": "None",
  "Message": "None",
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2O",
  "Data": {
    "Total": 51,
    "List": [
      {
        "Description": "test",
        "BusinessNumber": "8613800**",
        "InviteLink": "https://chat.whatsapp.com/***",
        "GroupStatus": "ACTIVE",
        "ProfilePictureFile": "https://*********/png.jpg",
        "Subject": "This is a test subject",
        "GroupId": "EA30d***",
        "GroupLink": "example",
        "TotalParticipantCount": 35,
        "GroupType": "example",
        "BusinessRole": "example",
        "GmtModifier": 94
      }
    ]
  },
  "Code": "OK",
  "Success": true
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.