Lewati ke konten utama

Kirim Pesan Broadcast

POST 
/nusasms_api/1.0/wa_business/broadcast

Pesan Broadcast digunakan dengan menggunakan template pesan yang sudah di setujui (Approved). Template pesan ini terdiri dari beberap komponen yaitu:

  • header: untuk judul pesan atau pesan dengan berkas / media.
  • body: Teks utama dari pesan dalam bahasa yang sudah dipilih
  • footer: Catatan kaki
  • buttons: Tambahan tombol untuk pesan

Berkas media dapat dilampirkan di header. Tipe yang diijinkan yaitu dokumen (document), gambar (image) dan video. Per-template, hanya 1 berkas yang diperbolehkan.

Selain media, header juga bisa digunakan sebagai judul dari pesan, dengan maksimal 1 parameter.

» Media (image, video and document)​

Note

Parameter filename hanya dapat digunakan untuk tipe media document. Ekstensi dari filename-nya akan menentukan tipe dokumen yang akan ditampilkan di Whatsapp.

Contoh header dokumen
{
    "type": "document",
    "link": "https://url.to/your-document-file.pdf",
    "caption": "Opsional. teks dari media",
    "filename": "nama-berkas-dokumen.pdf"
}

» Teks​

Teks dapat digunakan di header dengan aturan sebagai berikut:

  • Max 60 karakter, termasuk dengan teks parameternya (jika digunakan)
  • Jumlah maksimal parameter teks dalam header adalah 1
  • Tidak boleh mengandung karakter baris baru, karakter pemformatan (misal untuk teks tebal, teks miring, dll)
Contoh header teks
{ "type": "text": "text": "Nilai dari parameter" }

Badan Pesan​

Contoh nilai parameter dari teks badan pesan
[
    { "type": "text": "text": "teks parameter 1" },
    { "type": "text": "text": "teks parameter 2" }
]

Aturannya:

  • Panjang karakter maksimal 1024 karakter (teks template dan nilai parameter-parameternya)

Tombol​

Tombol (buttons) sebagai komponen opsional, untuk penerima pesan dapat melakukan aksi sesuai tipe tombolnya.

Tipe Tombol​

Salin Kode (Copy Code)​

Dengan tombol Salin Kode (Copy Code), penerima pesan dapat segera menyalin teks dengan menekan/mengklik tombol.

Aturan:

  • Dalam sebuah template, hanya bisa menggunakan 1 tombol Salin Kode (Copy Code)
  • Panjang karakter dari teks kode (yang akan disalin) maksimal 16 karakter

Tombol Panggilan​

Merupakan tombol yang membantu untuk melakukan panggilan Whatsapp ketika ditekan/diklik.

Aturan:

  • Panjang maksimal karakter dari Komponen parameternya:
    • text: 20 karakter
    • phone_number: 20 karakter
Contoh nilai parameternya
{
  "type": "PHONE_NUMBER",
  "text": "Call",
  "phone_number": "YOUR PHONE NUMBER"
}

Jawab Cepat​

Tombol ini membantu mempermudah penerima pesan template ini untuk merespon, yaitu dengan menekan/mengklik tombol. Teks responnya (dari tombol) adalah sesuai yang anda lampirkan saat mengirim pesan.

Aturan:

  • Panjang teksnya maksimal 25 karakter
Contoh penggunaan tombol
[
    {
        "sub_type": "QUICK_REPLY",
        "index": 0,
        "parameters": {
            "type": "payload",
            "payload": "Teks Respon 1"
        }
    },
    {
        "sub_type": "QUICK_REPLY",
        "index": 1,
        "parameters": {
            "type": "payload",
            "payload": "Teks Respon 2"
        }
    }
]

URL​

Lampirkan URL (dengan teks labelnya), yang ketika ditekan/diklik akan mengarahkan pengguna aplikasi Whatsapp menuju ke URL ini.

Ada 2 tipe tombol URL yaitu statis dan dinamis.

  • statis: URL sudah tetap sesuai saat dibuatnya template
  • dinamis: URL dapat ditambahkan teks tambahan di akhir (prefix), saat mengirim pesan template

Aturan:

  • Sebuah template hanya dapat memiliki, maksimal 2 tombol
  • Panjangnya maksimal 25 karakter
  • Jika URL anda mengandung URL dengan karakter spesial, anda harus meng-encode (URL encode), terlebih dahulu. Hasil encode-nya biasanya ditandai dengan karakter persen (%)

Example:

Contoh penggunaan URL dinamis
[
    {
        "sub_type": "URL",
        "index": 0,
        "parameters": {
            "type": "payload",
            "payload": "tambahan-prefix-url"
        }
    }
]
peringatan

Sebuah template yang memiliki 4 tombol atau lebih kombinasi tombol jawab cepat (quick reply) dan tombol tipe lain tidak akan ditampilkan di aplikasi Whatsapp desktop dan web.

Mohon pastikan agar si penerima pesan membuka pesan seperti ini, membuka pesannya di aplikasi Whatsapp di handphone-nya.

Aturan Tambahan​

Kombinasi Tombol Jawab Cepat (Quick Button)​

Jika template pesan anda menggunakan lebih dari 1 tombol jawab cepat bersamaan dengan tombol tipe lain, maka tombol jawab cepat harus diurutkan/dikelompokkan bersamaan, dan tombol non-jawab cepat juga diurutkan/dikelompokkan bersama.

Jika pengelompokan / kombinasi tombolnya tidak sesuai, maka API akan merespon dengan error kombinasi yang tidak valid.

Grup/Kombinasi yang valid:

  • Jawab Cepat, Jawab Cepat
  • Jawab Cepat, Jawab Cepat, URL, Panggilan (Phone)
  • URL, Panggilan (Phone), Jawab Cepat, Jawab Cepat

Request​

Responses​

Successful Response