Sending Broadcast
Gunakan api ini untuk mengirim Broadcast.
API_TOKEN Developers can authenticate their API calls with the API_TOKEN generated in App Dashboard > Phone Numbers > Detail > Api. Untuk mengirim broadcast, lakukan panggilan POST ke /broadcasts
Parameters
Ini adalah parameter utama yang digunakan untuk mengirim broadcast requests:
| Name | Description |
|---|---|
name | Required Nama Broadcast. |
type | Required Tipe dari penerima broadcast Berikut tipe yang didukung:
|
to | Required Jika tipenya adalah kontak, berikut beberapa contoh format nomor telepon yang didukung:
Jika tipe adalah label, hanya label id yang tersedia yang didukung. Berikut beberapa contoh formatnya:
|
template | Required Object template. |
template.name | Required Nama message template. |
template.language | Required Bahasa message template. |
template.param | Required Object param template. |
template.param.header | Optional Array template param header Required ketika ada komponen header di message template |
template.param.body | Optional Array template param body Required ketika ada variable {{number}} di body message template |
template.param.button | Optional Array template param button Required ketika ada komponen button di message template |
template.param.button.*.type | Optional Menunjukkan jenis parameter untuk tombol. Value yang didukung:
Required ketika ada komponen button di message template |
template.param.button.*.value | Optional QUICK_REPLY: payload yang didefiniskan oleh developer untuk dikembalikan saat tombol diklik selain teks tampilan pada tombol. URL: suffix yang disediakan developer untuk ditambahkan ke prefix URL yang telah ditentukan sebelumnya di template. COPY_CODE: Kode yang ditentukan pengembang untuk disalin ke papan klip perangkat saat diketuk oleh pengguna aplikasi. Required ketika ada komponen button di message template |
template.param.limited_time_offer | Optional Object limited time offer Required ketika limited time offer expiration time disetel true |
template.param.limited_time_offer.expiration_time | Optional Waktu kadaluwarsa kode penawaran dalam bentuk UNIX timestamp dalam milliseconds. Required ketika limited time offer expiration time disetel true |
Contoh
Sampel request
curl -X POST 'https://waofficial.botika.online/api/whatsapp/v1/broadcasts' \ -H 'Authorization: Bearer {{ API_TOKEN }}' \ -H 'Content-Type: application/json' \ -d '{ "name: "BROADCAST_NAME", "type": "RECIPIENT_TYPE", "to": [ # if type is contact "+62821xxxxxx", "+62821xxxxxx", # if type is label "1", "2", "3", ], "template": { "name": "MESSAGE_TEMPLATE_NAME", "language": "MESSAGE_TEMPLATE_LANGUAGE_CODE", "param": { "header": [ "param for header" || <media_link> ], "body": [ "Param for body", "Param for body", "Param for body", ...... ], "button": [ { "type": "QUICK_REPLY" | "URL" | "COPY_CODE", "value": "PAYLOAD" }, { "type": "QUICK_REPLY" | "URL" | "COPY_CODE", "value": "PAYLOAD" } .... ], # if limited time offer expiration time is set true "limited_time_offer": { "expiration_time_ms": "<unix_timestamp_in_miliseconds>" } } } }'
Response yang berhasil menyertakan objek dengan pengidentifikasi untuk pesan:
[
'success' => true
]