Gunakan ListChatappTemplate untuk kueri template pesan - Chat App Message Service

Mengambil daftar templat pesan.

Deskripsi operasi

Batas QPS

Anda dapat memanggil operasi ini hingga lima kali per detik per akun. Jika jumlah panggilan per detik melebihi batas tersebut, Pembatasan kecepatan akan dipicu, yang berpotensi mengganggu bisnis Anda. Kami menyarankan agar Anda memperhatikan batas ini saat melakukan panggilan terhadap operasi ini.

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

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
Name	string	No	Nama templat.	hello_whatsapp
Language	string	No	Bahasa yang digunakan dalam templat pesan. Untuk informasi selengkapnya, lihat Kode bahasa.	en
AuditStatus	string	No	Status tinjauan templat. Nilai yang valid: pass: Templat disetujui. fail: Templat ditolak. auditing: Templat sedang dalam proses peninjauan. unaudit: Peninjauan dihentikan sementara.	pass
Page	object	No	Pengaturan paginasi.	"page": "{\"index\": 1,\"size\": 20}
Index	integer	Yes	Nomor halaman. Nilai default: 1.	1
Size	integer	Yes	Jumlah entri per halaman. Nilai default: 10.	10
CustWabaId `deprecated`	string	No	ID WhatsApp Business Account (WABA) dari RAM user dalam akun independent software vendor (ISV). Catatan CustWabaId adalah parameter usang. Gunakan CustSpaceId sebagai gantinya.	65921621816****
IsvCode	string	No	Kode verifikasi ISV. Parameter ini digunakan untuk memverifikasi apakah RAM user telah diberi otorisasi oleh akun ISV.	skdi3kksloslikdkkdk
CustSpaceId	string	Yes	ID ruang dari RAM user dalam akun ISV.	28251486512358****
TemplateType	string	No	Jenis templat pesan. WHATSAPP VIBER	WHATSAPP
Code	string	No	Kode templat pesan.	838888822*****

Elemen respons

Element	Type	Description	Example
	object	Parameter respons.
RequestId	string	ID permintaan.	90E63D28-E31D-1EB2-8939-A9486641****
Code	string	Kode status HTTP yang dikembalikan. Nilai OK menunjukkan bahwa pemanggilan berhasil. Nilai lain menunjukkan bahwa pemanggilan gagal. Untuk informasi selengkapnya, lihat Kode error.	OK
Message	string	Pesan error yang dikembalikan.	User not authorized to operate on the specified resource.
ListTemplate	array<object>	Templat pesan.
	object	Templat yang ditanyakan.
TemplateName	string	Nama templat pesan.	hello_whatsapp
TemplateCode	string	Kode templat pesan.	744c4b5c79c9432497a075bdfca3****
AuditStatus	string	Status tinjauan templat. Nilai yang valid: pass: Templat disetujui. fail: Templat ditolak. auditing: Templat sedang dalam proses peninjauan. unaudit: Peninjauan dihentikan sementara.	pass
Language	string	Bahasa yang digunakan dalam templat pesan. Untuk informasi selengkapnya, lihat Kode bahasa.	en
Category	string	Kategori templat pesan WhatsApp. Nilai yang valid: UTILITY MARKETING AUTHENTICATION Kategori templat Viber. Nilai yang valid: text: templat yang hanya berisi teks image: templat yang hanya berisi citra text_image_button: templat yang berisi teks, citra, dan tombol text_button: templat yang berisi teks dan tombol document: templat yang hanya berisi dokumen video: templat yang hanya berisi video text_video: templat yang berisi teks dan video text_video_button: templat yang berisi teks, video, dan tombol text_image: templat yang berisi teks dan citra	UTILITY
TemplateType	string	Jenis templat. Nilai yang valid: WHATSAPP dan VIBER.	WHATSAPP
Reason	string	Alasan penolakan templat.	None
LastUpdateTime	integer	Waktu terakhir templat dimodifikasi. Nilai ini merupakan Stempel waktu UNIX yang merepresentasikan jumlah milidetik sejak 1 Januari 1970 pukul 00:00:00 UTC.	1711006633000
Total	integer	Total jumlah entri yang dikembalikan.	1
AccessDeniedDetail	string	Detail penolakan akses.	无

Contoh

Respons sukses

JSONformat

{
  "RequestId": "90E63D28-E31D-1EB2-8939-A9486641****",
  "Code": "OK",
  "Message": "User not authorized to operate on the specified resource.",
  "ListTemplate": [
    {
      "TemplateName": "hello_whatsapp",
      "TemplateCode": "744c4b5c79c9432497a075bdfca3****",
      "AuditStatus": "pass",
      "Language": "en",
      "Category": "UTILITY",
      "TemplateType": "WHATSAPP",
      "Reason": "None",
      "LastUpdateTime": 1711006633000
    }
  ],
  "Total": 1,
  "AccessDeniedDetail": "无"
}

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.