Gunakan API SendChatappMessage untuk Kirim Pesan Multi-Channel - Chat App Message Service - Alibaba Cloud - Chat App Message Service

Mengirimkan pesan ChatApp.

Deskripsi operasi

Anda dapat memanggil API ini untuk mengirim pesan atau mengirimnya secara manual melalui Konsol dengan menavigasi ke Channel Management > Manage > Message Sending.
Sebelum memanggil API ini, pastikan Anda telah membuat channel dan memiliki templat yang telah disetujui.
Untuk channel WhatsApp, Anda harus telah mendaftarkan dan mengikat WABA serta menambahkan nomor telepon.
Untuk channel Messenger, Anda harus telah terhubung ke Facebook Page.
Untuk channel Instagram, Anda harus telah terhubung ke akun profesional Instagram.
Untuk channel Viber, Anda harus telah mengajukan Service ID.

Batas QPS

Batas QPS untuk API ini adalah 250 permintaan per detik per pengguna. Melebihi batas tersebut akan menyebabkan pembatasan kecepatan (throttling) API, yang dapat berdampak pada bisnis Anda. Untuk mencegah throttling, pastikan jumlah panggilan Anda tidak melebihi batas tersebut.

Pembaruan status

Anda dapat memantau status pesan yang dikirim menggunakan Message Service (MNS) atau callback HTTP. Untuk detail selengkapnya, lihat message receipts.

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

create

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
ChannelType	string	Yes	Jenis channel. Nilai yang valid: whatsapp messenger instagram viber	whatsapp
Type	string	Yes	Jenis pesan. Nilai yang valid: `template`: Templat pesan yang telah disetujui di Konsol. Anda dapat mengirim jenis pesan ini kapan saja. `message`: Pesan dalam format apa pun. Anda hanya dapat mengirim jenis pesan ini dalam waktu 24 jam setelah pesan terakhir pengguna. Penting Jika `Type` diatur ke `template`, parameter `TemplateCode` wajib diisi. Jika `Type` diatur ke `message`, parameter `MessageType` wajib diisi.	message
MessageType	string	No	Jenis pesan ketika `Type` diatur ke `message`. Nilai yang valid bervariasi berdasarkan jenis channel: WHATSAPP `text`: Pesan teks. `image`: Pesan gambar. `video`: Pesan video. `audio`: Pesan audio. `document`: Pesan dokumen. `interactive`: Pesan interaktif. `location`: Pesan lokasi. `contacts`: Pesan kontak. `reaction`: Pesan reaksi. `sticker`: Pesan stiker. `typing_indicator`: Pesan indikator pengetikan. `pin`: Pesan untuk menyematkan atau melepas sematan pesan. Ini hanya tersedia untuk pesan grup. `carousel`: Pesan carousel. VIBER `text`: Pesan teks. `image`: Pesan gambar. `text_image_button`: Pesan yang berisi teks, gambar, dan tombol. `text_button`: Pesan yang berisi teks dan tombol. `document`: Pesan dokumen. `video`: Pesan video. `text_video`: Pesan yang berisi teks dan video. `text_video_button`: Pesan yang berisi teks, video, dan tombol. `text_image`: Pesan yang berisi teks dan gambar. MESSENGER / INSTAGRAM `text`: Pesan teks. `image`: Pesan gambar. `video`: Pesan video. `document`: Pesan dokumen. `audio`: Pesan audio. `interactive`: Pesan interaktif. `couponTemplate`: Pesan templat kupon. `regularTemplate`: Pesan templat reguler. `quickReply`: Pesan balasan cepat. `buttonTemplate`: Pesan templat tombol.	text
TemplateCode	string	No	Kode templat. Anda dapat menemukan kode templat di halaman Channel Management>Manage>Template Design.	1119***************
Language	string	No	Bahasa templat pesan. Untuk daftar bahasa yang didukung, lihat language code.	en
From	string	Yes	Nomor atau ID pengirim. Nilainya bervariasi berdasarkan jenis channel: Jika `ChannelType` diatur ke whatsapp, ini adalah nomor telepon yang terdaftar di WhatsApp. Anda dapat menemukannya di halaman Channel Management>Manage>WABA Management>Phone Number Management. Jika `ChannelType` diatur ke messenger, ini adalah ID Facebook Page. Anda dapat menemukannya di halaman Channel Management>Manage>Facebook Page. Jika `ChannelType` diatur ke instagram, ini adalah ID akun profesional Instagram. Anda dapat menemukannya di halaman Channel Management>Manage>Professional Account. Jika `ChannelType` diatur ke viber, ini adalah ID layanan Viber. Anda dapat menemukannya di halaman Channel Management>Manage>Service Number Management.	861387777****
To	string	Yes	Nomor atau ID penerima. Nilainya bervariasi berdasarkan jenis channel: Jika `ChannelType` diatur ke whatsapp, ini adalah nomor telepon penerima. Jika `ChannelType` diatur ke messenger, ini adalah Page-Scoped User ID (PSID) yang dihasilkan saat pengguna berinteraksi dengan Facebook Page Anda. Jika `ChannelType` diatur ke instagram, ini adalah Instagram-scoped User ID (IGSID) yang dihasilkan saat pengguna berinteraksi dengan akun bisnis atau kreator Instagram Anda. Jika `ChannelType` diatur ke viber, ini adalah nomor telepon penerima.	861388988****
TemplateParams	object	No	Objek JSON yang berisi variabel templat.
	string	No	Variabel templat, ditentukan dalam format pasangan kunci-nilai. Kuncinya adalah nama variabel dan nilainya adalah nilai variabel tersebut.	{ "param1": "value1", "param2": "value2" }
Content	string	No	Konten pesan, ditentukan sebagai string JSON. Catatan untuk pesan WhatsApp: Jika `MessageType` adalah `text`, bidang `text` wajib diisi, dan bidang `caption` tidak boleh disertakan. Jika `MessageType` adalah `image`, bidang `link` wajib diisi. Jika `MessageType` adalah `video`, bidang `link` wajib diisi. Jika `MessageType` adalah `audio`, bidang `link` wajib diisi. Bidang `caption` tidak didukung. Jika `MessageType` adalah `document`, bidang `link` dan `fileName` wajib diisi. Bidang `caption` tidak didukung. Jika `MessageType` adalah `interactive`, bidang `type` dan `action` wajib diisi. Jika `MessageType` adalah `contacts`, bidang `name` wajib diisi. Jika `MessageType` adalah `location`, bidang `longitude` dan `latitude` wajib diisi. Jika `MessageType` adalah `sticker`, bidang `link` wajib diisi. Bidang `caption` dan `fileName` tidak didukung. Jika `MessageType` adalah `reaction`, bidang `messageId` dan `emoji` wajib diisi. Catatan untuk pesan Messenger: Jika `MessageType` adalah `text`, bidang `text` wajib diisi. Jika `MessageType` adalah `image`, `video`, `audio`, atau `document`, bidang `link` wajib diisi. Catatan untuk pesan Instagram: Jika `MessageType` adalah `text`, bidang `text` wajib diisi. Jika `MessageType` adalah `image`, `video`, atau `audio`, bidang `link` wajib diisi. Catatan untuk pesan Viber: Jika `MessageType` adalah `text`, bidang `text` wajib diisi. Jika `MessageType` adalah `image`, bidang `link` wajib diisi. Jika `MessageType` adalah `video`, bidang `link`, `thumbnail`, `fileSize`, dan `duration` wajib diisi. Jika `MessageType` adalah `document`, bidang `link`, `fileName`, dan `fileType` wajib diisi. Jika `MessageType` adalah `text_button`, bidang `text`, `caption`, dan `action` wajib diisi. Jika `MessageType` adalah `text_image_button`, bidang `text`, `link`, `caption`, dan `action` wajib diisi. Jika `MessageType` adalah `text_video`, bidang `text`, `link`, `thumbnail`, `fileSize`, dan `duration` wajib diisi. Jika `MessageType` adalah `text_video_button`, bidang `text`, `link`, `thumbnail`, `fileSize`, `duration`, dan `caption` wajib diisi. Bidang `action` tidak didukung.	{ "text": "hello,whatsapp", "link": "https://*****", "caption": "", "fileName": "**" }
Payload	array	No	Array payload yang dipicu ketika pengguna mengklik tombol yang sesuai.	payloadtext1,payloadtext2,payloadtext3
	string	No	Payload yang dikirim ketika pengguna mengklik tombol dalam templat.	payloadtext
CustWabaId `deprecated`	string	No	Parameter ini sudah tidak digunakan lagi. Gunakan `CustSpaceId` sebagai gantinya. ID WABA. Untuk ISV, ini adalah ID WABA pelanggan sub-ISV. Untuk pelanggan langsung, ini adalah ID Instance. Anda dapat melihat ID tersebut di halaman Channel Management.	cams-8c8*********
FallBackId	string	No	ID kebijakan fallback. Parameter ini hanya tersedia di Situs Internasional (alibabacloud.com). Anda dapat memperoleh ID kebijakan dari halaman Fallback Policy.	S0****
FallBackContent	string	No	Konten fallback kustom. Parameter ini hanya tersedia di Situs Internasional (alibabacloud.com).	Fallback SMS
IsvCode `deprecated`	string	No	Kode verifikasi ISV, digunakan untuk memverifikasi apakah sub-akun telah diberi otorisasi oleh ISV. Parameter ini sudah tidak digunakan lagi dan dapat diabaikan.	123123******
CustSpaceId	string	No	ID Space pelanggan sub-ISV atau ID Instance pelanggan langsung. Anda dapat melihat ID tersebut di halaman Channel Management.	cams-8c8*********
ContextMessageId	string	No	ID pesan konteks. Ini adalah ID pesan yang sedang Anda balas.	61851ccb2f1365b16aee****
TrackingData	string	No	Data pelacakan kustom untuk pesan Viber. Parameter ini hanya tersedia di Situs Internasional.	Tracking Data
Label	string	No	Jenis pesan Viber. Parameter ini hanya tersedia di Situs Internasional. Nilai yang valid: promotion: Pesan pemasaran atau promosi. transaction: Pesan transaksional atau notifikasi.	promotion
Ttl	integer	No	Waktu hidup (TTL) untuk pesan Viber. Parameter ini hanya tersedia di Situs Internasional. Satuan: detik. Nilai yang valid: 30 hingga 1209600.	50
Tag	string	No	Tag kustom untuk pesan Viber.	tag
TaskId	string	No	ID tugas kustom.	10000****
FallBackDuration	integer	No	Durasi pemicu fallback. Parameter ini hanya tersedia di Situs Internasional. Fallback dipicu jika tanda terima pengiriman tidak diterima untuk pesan dalam durasi ini. Jika parameter ini tidak ditentukan, fallback hanya dipicu pada kegagalan pengiriman atau saat menerima laporan status gagal. Satuan: detik. Nilai yang valid: 60 hingga 43200.	120
ProductAction	object	No	Informasi produk yang telah Anda unggah ke Meta. Parameter ini hanya berlaku untuk jenis channel `whatsapp`.
ThumbnailProductRetailerId	string	No	ID katalog produk. Anda dapat memperoleh ID tersebut dengan memanggil operasi ListProductCatalog.	skkks99****
Sections	array<object>	No	Daftar kategori produk. Anda dapat menentukan maksimal 10 kategori dan 30 produk.
	array<object>	No	Kategori produk.
Title	string	No	Nama kategori. Anda dapat menemukannya di halaman Channel Management>Manage>Catalog Management>Product Management atau memperolehnya dengan memanggil operasi ListProduct.	abcd
ProductItems	array<object>	No	Daftar informasi produk.
	object	No	Informasi produk.
ProductRetailerId	string	No	ID produk. Anda dapat menemukannya di halaman Channel Management>Manage>Catalog Management>Product Management atau memperolehnya dengan memanggil operasi ListProduct.	ksi3****
FallBackRule	string	No	Aturan fallback. Parameter ini hanya tersedia di Situs Internasional. Nilai yang valid: undelivered: Fallback dipicu jika pesan tidak dapat dikirim ke penerima. Aturan ini mensyaratkan bahwa templat dan variabel lolos validasi saat pesan dikirim. Sistem tidak memvalidasi terhadap templat atau nomor telepon yang diblokir. Jika parameter ini dibiarkan kosong, aturan ini digunakan secara default. sentFailed: Fallback dipicu jika validasi gagal untuk parameter seperti templat atau variabel templat. Sistem hanya melakukan validasi ketat terhadap parameter `ChannelType`, `Type`, `MessageType`, `To`, dan `From` (keberadaan).	undelivered
FlowAction	object	No	Objek pesan Flow.
FlowActionData	object	No	Kumpulan parameter default untuk flow.
	any	No	Parameter default untuk flow, ditentukan dalam format pasangan kunci-nilai. Kuncinya adalah nama parameter dan nilainya adalah nilai parameter tersebut.	{ "name": "name" }
FlowToken	string	No	Informasi token flow kustom.	kde****
TemplateName	string	No	Nama templat. Anda dapat menemukan nama templat di halaman Channel Management>Manage>Template Design.	test_name
RecipientType	string	No	Jenis penerima. Nilai yang valid: `individual` `group`	individual
MessageCampaignId	string	No	ID pesan kampanye. Catatan Ini adalah parameter uji dan belum sepenuhnya tersedia. Harap abaikan parameter ini.	123123********
AdAccountId	string	No	ID akun iklan Meta. Catatan Ini adalah parameter uji dan belum sepenuhnya tersedia. Harap abaikan parameter ini.	123123********
TokenType	string	No	Jenis token. Catatan Ini adalah parameter uji dan belum sepenuhnya tersedia. Harap abaikan parameter ini.	bearer
Category	string	No	Kategori pesan, digunakan untuk pesan WhatsApp direct send. Peringatan Jangan tentukan parameter ini kecuali Anda merupakan pelanggan yang diundang untuk uji coba beta Meta. Jika tidak, pesan mungkin gagal dikirim.	UTILITY

Elemen respons

Element	Type	Description	Example
	object	Data respons.
AccessDeniedDetail	string	Detail tentang penolakan akses.	None
RequestId	string	Identifikasi unik dari permintaan.	90E63D28-E31D-1EB2-8939-A94866******
Message	string	Pesan kesalahan.	User not authorized to operate on the specified resource.
Code	string	Kode status respons. `OK` menunjukkan permintaan berhasil. Untuk kode kesalahan lainnya, lihat Error codes.	OK
MessageId	string	Identifikasi unik dari pesan.	61851ccb2f1365b16aee****

Contoh

Respons sukses

JSONformat

{
  "AccessDeniedDetail": "None",
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866******",
  "Message": "User not authorized to operate on the specified resource.",
  "Code": "OK",
  "MessageId": "61851ccb2f1365b16aee****"
}

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.