Gunakan ListChatappTemplate untuk kueri template pesan - Chat App Message Service - Alibaba Cloud - Chat App Message Service

Mengambil daftar templat Paket.

Deskripsi operasi

Batas QPS

Batas QPS untuk operasi ini adalah 5 panggilan per detik per pengguna. Jika batas terlampaui, panggilan API akan dibatasi, yang dapat memengaruhi bisnis Anda. Panggil operasi ini pada laju yang wajar.

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

list

*Semua sumber daya.

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
Name	string	No	Nama templat.	hello_whatsapp
Language	string	No	Bahasa templat. Untuk kode bahasa, lihat Kode bahasa.	en
AuditStatus	string	No	Status audit. Nilai valid: pass: Disetujui. fail: Ditolak. auditing: Sedang ditinjau. unaudit: Peninjauan ditangguhkan.	pass
Page	object	No	Pengaturan paginasi.	"page": "{\"index\": 1,\"size\": 20}
Size	integer	Yes	Jumlah templat yang dikembalikan per kueri. Nilai default: 10.	10
Index	integer	Yes	Nomor halaman. Nilai default: 1.	1
CustWabaId `deprecated`	string	No	WabaId pelanggan ISV. Catatan Parameter ini tidak digunakan lagi. Gunakan CustSpaceId sebagai gantinya.	65921621816****
CustSpaceId	string	No	SpaceId sub-pelanggan ISV atau ID instans pelanggan langsung.	28251486512358****
TemplateType	string	No	Tipe templat. Nilai valid: WHATSAPP VIBER	WHATSAPP
Code	string	No	Kode templat.	838888822*****
Category	string	No	Kategori templat.	AUTHENTICATION
IsvCode	string	No	Kode verifikasi ISV, digunakan untuk memverifikasi apakah sub-akun diotorisasi oleh ISV.	skdi3kksloslikdkkdk

Elemen respons

Element	Type	Description	Example
	object	Data yang dikembalikan.
AccessDeniedDetail	string	Detail penolakan akses.	None
Message	string	Paket kesalahan.	User not authorized to operate on the specified resource.
RequestId	string	ID permintaan.	90E63D28-E31D-1EB2-8939-A9486641****
ListTemplate	array<object>	Data daftar.
	object	Daftar templat.
TemplateCode	string	Kode templat.	744c4b5c79c9432497a075bdfca3****
AuditStatus	string	Status audit. Nilai valid: pass: Disetujui. fail: Ditolak. auditing: Sedang ditinjau. unaudit: Peninjauan ditangguhkan.	pass
Category	string	Kategori templat WhatsApp. Nilai valid: UTILITY: Terkait transaksi. MARKETING: Templat pemasaran. AUTHENTICATION: Verifikasi identitas. Kategori templat Viber: UTILITY: Terkait transaksi. MARKETING: Templat pemasaran. AUTHENTICATION: Verifikasi identitas.	UTILITY
Language	string	Bahasa templat. Untuk kode bahasa, lihat Kode bahasa.	en
LastUpdateTime	integer	Pengatur waktu modifikasi terakhir, dinyatakan sebagai Stempel waktu UNIX dalam milidetik.	1711006633000
TemplateName	string	Nama templat.	hello_whatsapp
TemplateType	string	Tipe templat. Nilai valid: WHATSAPP atau VIBER.	WHATSAPP
Reason	string	Alasan penolakan audit templat.	None
Total	integer	Jumlah total rekaman.	1
Code	string	Kode status permintaan. OK menunjukkan bahwa permintaan berhasil. Untuk kode kesalahan lainnya, lihat Daftar kode kesalahan.	OK
Success	boolean	Apakah panggilan berhasil. Nilai valid: true: Panggilan berhasil. false: Panggilan gagal.	false

Contoh

Respons sukses

JSONformat

{
  "AccessDeniedDetail": "None",
  "Message": "Pengguna tidak diizinkan untuk beroperasi pada Sumber daya tertentu.",
  "RequestId": "90E63D28-E31D-1EB2-8939-A9486641****",
  "ListTemplate": [
    {
      "TemplateCode": "744c4b5c79c9432497a075bdfca3****",
      "AuditStatus": "pass",
      "Category": "UTILITY",
      "Language": "en",
      "LastUpdateTime": 1711006633000,
      "TemplateName": "hello_whatsapp",
      "TemplateType": "WHATSAPP",
      "Reason": "None"
    }
  ],
  "Total": 1,
  "Code": "OK",
  "Success": false
}

Kode kesalahan

HTTP status code	Error code	Error message
400	Product.Unsubscript	You have not subscribed to the specified product.
400	Ram.PermissionDeny	You are not authorized to perform the operation.
400	System.LimitControl	The system is under flow control.
400	Unknown.ResourceOwnerId	The resource does not belong to the current user.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.