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

Mengirim Paket ChatApp.

Deskripsi operasi

Call this operation to send messages. You can also send messages manually in the console at Channel Management > Manage > Message Sending.
Before calling this operation, you must create a channel and have an approved template.
For a WhatsApp channel, you must register and bind a WABA and add a phone number.
For a Messenger channel, you must connect to a Facebook Page.
For an Instagram channel, you must connect to an Instagram professional account.
For a Viber channel, you must apply for a service ID.

QPS limit

The QPS limit for this operation is 250 per user. API calls that exceed this limit are throttled. To prevent service disruptions, ensure your calls stay within this limit.

Status changes

You can receive notifications about message status changes by using MNS or HTTP callbacks. For more information, see 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	Tipe saluran. Nilai valid: whatsapp messenger instagram telegram viber.	whatsapp
Type	string	Yes	Tipe Paket. Nilai valid: `template`: Templat Paket yang disetujui di Konsol. Anda dapat mengirim tipe Paket ini kapan saja. `message`: Paket dengan format apa pun. Anda dapat mengirim tipe Paket ini hanya dalam pengatur waktu 24 jam setelah menerima Paket terakhir dari pengguna. Penting Jika Anda mengatur `Type` menjadi `template`, Anda harus mengatur parameter `TemplateCode`. Jika Anda mengatur `Type` menjadi `message`, Anda harus mengatur parameter `MessageType`. .	message
MessageType	string	No	Tipe Paket yang digunakan saat `Type` diatur ke `message`. Nilai valid bervariasi berdasarkan tipe saluran: WHATSAPP `text`: pesan teks. `image`: Paket gambar. `video`: Paket video. `audio`: Paket audio. `document`: Paket dokumen. `interactive`: Paket interaktif. `location`: Paket lokasi. `contacts`: Paket kontak. `reaction`: Paket reaksi. `sticker`: Paket stiker. `typing_indicator`: Paket indikator pengetikan. `pin`: pesan untuk menyematkan atau melepas sematan. Tipe ini hanya tersedia untuk pesan kelompok. `carousel`: Paket carousel. VIBER `text`: pesan teks. `image`: Paket gambar. `text_image_button`: pesan dengan teks, gambar, dan tombol. `text_button`: pesan dengan teks dan tombol. `document`: Paket dokumen. `video`: Paket video. `text_video`: pesan dengan teks dan video. `text_video_button`: pesan dengan teks, video, dan tombol. `text_image`: pesan dengan teks dan gambar. MESSENGER / INSTAGRAM `text`: pesan teks. `image`: Paket gambar. `video`: Paket video. `document`: Paket dokumen. `audio`: Paket audio. `interactive`: Paket interaktif. `couponTemplate`: Paket templat kupon. `regularTemplate`: Paket templat reguler. `quickReply`: Paket balasan cepat. `buttonTemplate`: Paket templat tombol. TELEGRAM `text`: pesan teks. `image`: Paket gambar. `video`: Paket video. `audio`: Paket audio. `document`: Paket dokumen. `location`: Paket lokasi. `gif`: Paket GIF animasi. `sticker`: Paket stiker. .	text
TemplateCode	string	No	Kode templat Paket. Anda dapat menemukan kode tersebut di halaman Channel Management > Manage > Template Design.	1119***************
Language	string	No	Bahasa templat Paket. Untuk daftar bahasa yang didukung dan kode yang sesuai, lihat kode bahasa.	en
From	string	Yes	Nomor atau ID pengirim. Jika `ChannelType` adalah whatsapp, ini adalah nomor telepon yang terdaftar di WhatsApp. Anda dapat menemukan nomor tersebut di halaman Channel Management > Manage > WABA Management > Phone Number Management. Jika `ChannelType` adalah messenger, ini adalah ID Halaman Facebook. Anda dapat menemukan ID ini di halaman Channel Management > Manage > Facebook Page. Jika `ChannelType` adalah instagram, ini adalah ID akun profesional Instagram (Account ID). Anda dapat menemukan ID tersebut di halaman Channel Management > Manage > Professional Account. Jika `ChannelType` adalah viber, ini adalah ID layanan Viber (Service ID). Anda dapat menemukan ID tersebut di halaman Channel Management > Manage > Service Number Management..	861387777****
To	string	Yes	Nomor atau ID penerima. Jika `ChannelType` adalah whatsapp, ini adalah nomor telepon penerima. Jika `ChannelType` adalah messenger, ini adalah Page-Scoped User ID (PSID) yang dihasilkan saat pengguna berinteraksi dengan Halaman Facebook Anda. Jika `ChannelType` adalah instagram, ini adalah Instagram-Scoped User ID (IGSID) yang dihasilkan saat pengguna berinteraksi dengan akun bisnis atau kreator Instagram Anda. Jika `ChannelType` adalah viber, ini adalah nomor telepon penerima..	861388988****
TemplateParams	object	No	Parameter untuk templat Paket.
	string	No	A key-value pair for a template parameter. The key is the parameter's name and the value is its corresponding value.	{ "param1": "value1", "param2": "value2" }
Content	string	No	Konten Paket, dalam format string JSON. Catatan untuk Paket WhatsApp: Jika `MessageType` adalah `text`, bidang `text` wajib diisi, dan bidang `Caption` tidak didukung. 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 `aksi` 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 Paket Messenger: Jika `MessageType` adalah `text`, bidang `text` wajib diisi. Jika `MessageType` adalah `image`, `video`, `audio`, atau `document`, bidang `link` wajib diisi. Catatan untuk Paket Instagram: Jika `MessageType` adalah `text`, bidang `text` wajib diisi. Jika `MessageType` adalah `image`, `video`, atau `audio`, bidang `link` wajib diisi. Catatan untuk Paket Viber: Jika `MessageType` adalah `text`, bidang `text` wajib diisi. Jika `MessageType` adalah `image`, bidang `link` wajib diisi. Jika `MessageType` adalah `video`, bidang `link`, `Gambar mini`, `fileSize`, dan `Durasi` wajib diisi. Jika `MessageType` adalah `document`, bidang `link`, `fileName`, dan `fileType` wajib diisi. Jika `MessageType` adalah `text_button`, bidang `text`, `caption`, dan `aksi` wajib diisi. Jika `MessageType` adalah `text_image_button`, bidang `text`, `link`, `caption`, dan `aksi` wajib diisi. Jika `MessageType` adalah `text_video`, bidang `text`, `link`, `Gambar mini`, `fileSize`, dan `Durasi` wajib diisi. Jika `MessageType` adalah `text_video_button`, bidang `text`, `link`, `Gambar mini`, `fileSize`, `Durasi`, dan `caption` wajib diisi. Bidang `aksi` tidak didukung..	{ "text": "hello,whatsapp", "link": "https://*****", "caption": "", "fileName": "**" }
Payload	array	No	Array string data kustom yang dikirim ke webhook Anda saat pengguna mengklik tombol yang sesuai.	payloadtext1,payloadtext2,payloadtext3
	string	No	The payload for a button in the message template.	payloadtext
CustWabaId `deprecated`	string	No	Tidak digunakan lagi. Gunakan `CustSpaceId` sebagai gantinya. ID WABA pelanggan ISV. Untuk pelanggan langsung, ini adalah ID Instans. Anda dapat menemukan ID tersebut di halaman Channel Management.	cams-8c8*********
FallBackId	string	No	ID strategi fallback. Parameter ini hanya tersedia di Situs Internasional dan dapat diabaikan jika Anda menggunakan Situs Tiongkok.Anda dapat menemukan ID strategi di halaman Fallback Policy..	S0****
FallBackContent	string	No	Konten kustom Paket fallback. Parameter ini hanya tersedia di Situs Internasional dan dapat diabaikan jika Anda menggunakan Situs Tiongkok.	Fallback SMS
IsvCode `deprecated`	string	No	Tidak digunakan lagi. Kode verifikasi yang digunakan untuk mengotorisasi sub-akun ISV. Anda dapat mengabaikan parameter ini.	123123******
CustSpaceId	string	No	ID Space sub-akun ISV. Untuk pelanggan langsung, ini adalah ID Instans. Anda dapat menemukan ID tersebut di halaman Channel Management.	cams-8c8*********
ContextMessageId	string	No	ID Paket yang Anda balas.	61851ccb2f1365b16aee****
TrackingData	string	No	Data pelacakan kustom untuk Paket Viber. Parameter ini hanya tersedia di Situs Internasional dan dapat diabaikan jika Anda menggunakan Situs Tiongkok.	Tracking Data
Label	string	No	Tipe Paket Viber. Parameter ini hanya tersedia di Situs Internasional dan dapat diabaikan jika Anda menggunakan Situs Tiongkok. Nilai valid: promotion: Paket promosi atau pemasaran. transaction: pesan Notifikasi..	promotion
Ttl	integer	No	pengatur waktu-to-live (TTL) untuk Paket Viber. Parameter ini hanya tersedia di Situs Internasional dan dapat diabaikan jika Anda menggunakan Situs Tiongkok.Unit: seconds. Nilai harus antara 30 dan 1209600..	50
Tag	string	No	Tag kustom untuk Paket Viber.	tag
TaskId	string	No	ID tugas kustom.	10000****
FallBackDuration	integer	No	Durasi setelah fallback dipicu. Parameter ini hanya tersedia di Situs Internasional dan dapat diabaikan jika Anda menggunakan Situs Tiongkok.Jika tanda terima pengiriman tidak dikembalikan dalam periode yang ditentukan, fallback akan dipicu. Jika parameter ini dihilangkan, fallback hanya dipicu jika Paket gagal dikirim atau tanda terima pengiriman gagal dikembalikan. Unit: seconds. Nilai harus antara 60 dan 43200..	120
ProductAction	object	No	Informasi produk yang telah Anda unggah ke Meta. Parameter ini hanya berlaku untuk saluran WhatsApp.
ThumbnailProductRetailerId	string	No	The product catalog ID. You can get this ID by calling the ListProductCatalog operation.	skkks99****
Sections	array<object>	No	A list of product categories. You can specify up to 10 categories and a total of 30 products.
	array<object>	No	A product category.
Title	string	No	The category name. You can find the name on the Channel Management > Manage > Catalog Management > Product Management page, or obtain it by calling the ListProduct operation.	abcd
ProductItems	array<object>	No	A list of product information.
	object	No	The product information.
ProductRetailerId	string	No	The product ID. View the ID on the Channel Management > Manage > Catalog Management > Product Management page or get it by calling the ListProduct API.	ksi3****
FallBackRule	string	No	Aturan fallback. Parameter ini hanya tersedia di Situs Internasional dan dapat diabaikan jika Anda menggunakan Situs Tiongkok. Nilai valid: undelivered: Fallback dipicu jika pengiriman Paket gagal. Templat dan parameter harus valid pada pengatur waktu pengiriman. Templat atau nomor telepon yang diblokir tidak divalidasi. Ini adalah aturan default jika parameter kosong. sentFailed: Fallback dipicu jika Paket gagal dalam validasi parameter, seperti untuk templat atau parameter templat. Hanya keberadaan `channelType`, `type`, `messageType`, `to`, dan `from` yang divalidasi secara ketat..	undelivered
FlowAction	object	No	Objek Paket Flow.
FlowActionData	object	No	A collection of default flow parameters.
	any	No	A default flow parameter in key-value format. The key is the parameter name, and the value is the parameter value.	{ "name": "name" }
FlowToken	string	No	The custom flow token.	kde****
TemplateName	string	No	Nama templat. Anda dapat menemukan nama templat di halaman Channel Management > Manage > Template Design.	test_name
RecipientType	string	No	Tipe penerima. Nilai valid: `individual`: Penerima tunggal. `group`: kelompok.	individual
MessageCampaignId	string	No	ID kampanye Paket. Catatan Parameter ini untuk pengujian internal, tidak tersedia secara umum, dan dapat diabaikan.	123123********
AdAccountId	string	No	ID akun iklan Meta. Catatan Parameter ini untuk pengujian internal, tidak tersedia secara umum, dan dapat diabaikan.	123123********
TokenType	string	No	Tipe token. Catatan Parameter ini untuk pengujian internal, tidak tersedia secara umum, dan dapat diabaikan.	bearer
Category	string	No	Kategori Paket untuk pengiriman WhatsApp langsung. Peringatan Tentukan parameter ini hanya jika Anda adalah pelanggan yang diundang oleh Meta. Jika tidak, Paket mungkin gagal dikirim. .	UTILITY

Elemen respons

Element	Type	Description	Example
	object	The response data.
AccessDeniedDetail	string	Details about the access denial.	None
RequestId	string	The ID of the request.	90E63D28-E31D-1EB2-8939-A94866******
Message	string	The error message.	User not authorized to operate on the specified resource.
Code	string	The status code of the request. A value of OK indicates a successful request. For other status codes, see error codes.	OK
MessageId	string	The ID of the message.	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.