Mengirimkan pesan secara massal.
Deskripsi operasi
-
Anda dapat memanggil API ini untuk mengirimkan pesan secara massal atau melalui Konsol. Untuk mengirim melalui Konsol, buka Channel Management, klik channel yang diinginkan, lalu pilih Message Sending.
-
Sebelum memanggil API ini, pastikan Anda telah membuat channel dan memiliki templat yang telah disetujui.
-
Untuk channel WhatsApp, Anda harus mendaftarkan dan mengikat WABA serta menambahkan nomor telepon.
-
Untuk channel Messenger, Anda harus menghubungkan ke Facebook Page.
-
Untuk channel Instagram, Anda harus menghubungkan ke akun profesional Instagram.
-
Untuk channel Viber, Anda harus menghubungkan ke akun profesional Instagram.
Batas QPS
-
API ini dibatasi hingga 10 permintaan per detik (QPS) per pengguna. Jika melebihi batas tersebut, pemanggilan API akan dikenai pengendalian aliran (throttled), yang dapat memengaruhi bisnis Anda. Pastikan Anda memanggil API ini dalam batas yang ditentukan.
-
Satu permintaan mendukung maksimal 1.000 nomor.
Perubahan status
Status pengiriman pesan dapat dipantau melalui Simple Message Service atau callback HTTP. Untuk detailnya, lihat .
Coba sekarang
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
cams:SendChatappMassMessage |
create |
*全部资源
|
None | None |
Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| ChannelType |
string |
Yes |
Jenis channel. Nilai yang valid:
|
|
| TemplateCode |
string |
No |
Kode templat. Lihat kode templat pada halaman Channel Management > Manage > Template Design. |
1119*************** |
| Language |
string |
Yes |
Bahasa. Untuk kode bahasa, lihat Kode bahasa. |
en |
| From |
string |
Yes |
Nomor pengirim.
|
861387777**** |
CustWabaId
deprecated
|
string |
No |
ID WhatsApp Business Account (WABA) pelanggan Independent Software Vendor (ISV). Ini adalah parameter yang sudah tidak digunakan lagi (deprecated). Gunakan CustSpaceId sebagai gantinya, yaitu ID instans pelanggan langsung. Lihat ID tersebut pada halaman Channel Management. |
cams-8c8********* |
| FallBackId |
string |
No |
ID kebijakan fallback. Parameter ini khusus untuk situs internasional (alibabacloud.com). Anda dapat mengabaikannya untuk situs Tiongkok (aliyun.com).Lihat ID kebijakan pada halaman Fallback Policy. |
S0**** |
| FallBackContent |
string |
No |
Konten fallback kustom. Parameter ini khusus untuk situs internasional (alibabacloud.com). Anda dapat mengabaikannya untuk situs Tiongkok (aliyun.com). |
Fallback SMS |
| TaskId |
string |
No |
ID tugas kustom. |
10000**** |
| SenderList |
array<object> |
Yes |
Daftar penerima. |
|
|
array<object> |
No |
Nomor telepon penerima. |
||
| TemplateParams |
object |
No |
Kumpulan parameter templat. |
|
|
string |
No |
Parameter templat dalam bentuk pasangan Key-Value. Key adalah nama parameter, dan Value adalah nilai parameter tersebut. |
{ "param1": "value1", "param2": "value2" } |
|
| FlowAction |
object |
No |
Objek pesan Flow. |
|
| FlowActionData |
object |
No |
Kumpulan parameter flow default. |
|
|
string |
No |
Parameter flow default dalam bentuk pasangan Key-Value. Key adalah nama parameter, dan Value adalah nilai parameter tersebut. |
{ "name": "name" } |
|
| FlowToken |
string |
No |
Informasi token flow kustom. |
kde**** |
| Payload |
array |
No |
Daftar payload untuk tombol. |
|
|
string |
No |
Payload untuk sebuah tombol. |
payloadtext |
|
| To |
string |
Yes |
Nomor penerima.
|
861386666**** |
| ProductAction |
object |
No |
Informasi produk. Parameter ini hanya untuk channel WhatsApp dan merujuk pada informasi produk yang diunggah ke Meta. |
|
| ThumbnailProductRetailerId |
string |
No |
ID katalog produk. Dapatkan dengan memanggil API ListProductCatalog. |
skkks99**** |
| Sections |
array<object> |
No |
Daftar kategori produk. Anda dapat memiliki hingga 10 kategori dan 30 produk. |
|
|
array<object> |
No |
Kategori produk. |
||
| Title |
string |
No |
Nama kategori. Lihat pada halaman Channel Management > Manage > Catalog Management > Product Management atau dapatkan dengan memanggil API ListProduct. |
abcd |
| ProductItems |
array<object> |
No |
Daftar informasi produk. |
|
|
object |
No |
Informasi produk. |
||
| ProductRetailerId |
string |
No |
ID produk. Lihat pada halaman Channel Management > Manage > Catalog Management > Product Management atau dapatkan dengan memanggil API ListProduct. |
ksi3**** |
IsvCode
deprecated
|
string |
No |
Kode verifikasi ISV, digunakan untuk memverifikasi apakah pengguna telah diotorisasi oleh ISV. Parameter ini sudah tidak digunakan lagi (deprecated). |
skdi3kksloslikd**** |
| CustSpaceId |
string |
No |
ID Space pelanggan sub-ISV, atau ID instans untuk pelanggan langsung. Lihat pada halaman Channel Management. |
cams-8c8********* |
| Ttl |
integer |
No |
Periode timeout untuk mengirimkan pesan Viber. Parameter ini khusus untuk situs internasional (alibabacloud.com). Anda dapat mengabaikannya untuk situs Tiongkok (aliyun.com).Satuan: detik. Nilai yang valid: 30 hingga 1209600. |
46 |
| Label |
string |
No |
Jenis pesan Viber. Parameter ini khusus untuk situs internasional (alibabacloud.com). Anda dapat mengabaikannya untuk situs Tiongkok (aliyun.com). Nilai yang valid:
|
promotion |
| Tag |
string |
No |
Tag kustom untuk pesan Viber. |
Tag |
| FallBackDuration |
integer |
No |
Waktu untuk memicu fallback. Parameter ini khusus untuk situs internasional (alibabacloud.com). Anda dapat mengabaikannya untuk situs Tiongkok (aliyun.com).Jika tanda terima pengiriman tidak dikembalikan dalam waktu yang ditentukan, fallback akan dipicu. Jika Anda tidak mengisi parameter ini, fallback tidak ditentukan berdasarkan waktu. Fallback hanya dipicu ketika pesan gagal dikirim atau laporan status gagal diterima. Satuan: detik. Nilai minimum: 60. Nilai maksimum: 43200. |
120 |
| FallBackRule |
string |
No |
Aturan fallback. Parameter ini khusus untuk situs internasional (alibabacloud.com). Anda dapat mengabaikannya untuk situs Tiongkok (aliyun.com). Nilai yang valid:
|
undelivered |
| TemplateName |
string |
No |
Nama templat. Lihat nama templat pada halaman Channel Management > Manage > Template Design. |
test_name |
Elemen respons
|
Element |
Type |
Description |
Example |
|
object |
Data yang dikembalikan. |
||
| AccessDeniedDetail |
string |
Detail penolakan akses. |
None |
| RequestId |
string |
ID permintaan. |
90E63D28-E31D-1EB2-8939-A9486641**** |
| Message |
string |
Pesan kesalahan. |
User not authorized to operate on the specified resource. |
| GroupMessageId |
string |
ID pesan massal. |
890000010002**** |
| Code |
string |
Kode status permintaan.
|
OK |
Contoh
Respons sukses
JSONformat
{
"AccessDeniedDetail": "None",
"RequestId": "90E63D28-E31D-1EB2-8939-A9486641****",
"Message": "User not authorized to operate on the specified resource.",
"GroupMessageId": "890000010002****",
"Code": "OK"
}
Kode kesalahan
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 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.