Dokumentasi API WhatsApp Now

Pendahuluan

Selamat datang di dokumentasi WhatsApp Now API produk Message Central. Di sini Anda akan menemukan detail untuk mempelajari, mencoba, dan menerapkan setiap kasus penggunaan platform WhatsApp Business API. WhatsApp Now adalah solusi komprehensif untuk mengintegrasikan dengan API WhatsApp Business resmi. Produk kami memanfaatkan platform WhatsApp yang kuat dan banyak digunakan untuk memungkinkan bisnis berkomunikasi dengan lancar dengan pelanggan mereka, menyediakan layanan perpesanan yang andal dan efisien.

Prasyarat untuk menggunakan WhatsApp Now

Sebelum Anda mulai dengan integrasi API, pastikan Anda memiliki:

1. Manajer Bisnis Facebook Terverifikasi
2. Akun di Pusat Pesan
3. Tautan akun bisnis Facebook Anda dengan Message Central
4. Nomor telepon yang perlu diverifikasi dan digunakan dengan Pusat Pesan

Help and SupportURL Dasar API Rest

Semua titik akhir API Platform di bawah ini harus diawali dengan URL berikut:operations@messagecentral.com

Memahami Pesan WhatsApp

Pesan Solusi WhatsApp Business hanya dapat dikirim oleh bisnis yang telah disetujui oleh Meta. Profil bisnis ini juga akan memiliki label terverifikasi hijau untuk menunjukkan bahwa itu adalah bisnis yang sah.

Keuntungan dari WhatsApp adalah bahwa pengenal pengguna di platform adalah nomor ponsel mereka.

Aturan untuk Pesan Pelanggan

WhatsApp memiliki konsep jendela layanan pelanggan 24 jam, di mana bisnis dapat dengan bebas mengirim pesan kepada pengguna akhir. Jendela 24 jam dapat dimulai dengan dua cara:

1. Pengguna akhir mengirim pesan ke bisnis
2. Bisnis mengirimkan pesan templat ke pengguna akhir. Jendela 24 jam dimulai segera setelah pengguna akhir membalas.

Template harus disetujui oleh Meta sebelum dapat digunakan untuk mengirim pesan ke pengguna akhir. Ketika jendela 24 jam berakhir, jendela layanan pelanggan 24 jam baru harus dimulai lagi. Penting untuk diketahui bahwa jendela layanan pelanggan 24 jam tidak sama dengan jendela percakapan 24 jam yang dapat ditagih.

Harga Berbasis Percakapan WhatsApp

Message Central menawarkan model Harga Berbasis Percakapan untuk pesan WhatsApp. Ini sejalan dengan model penetapan harga yang diperkenalkan oleh WhatsApp pada awal Februari 2022.

Apa itu percakapan?

Percakapan adalah sejumlah pesan yang dikirim dalam 'sesi', yang didefinisikan sebagai periode 24 jam mulai dari saat pesan pertama dikirim oleh bisnis.

Siapa yang memulai percakapan?

Percakapan bisa dimulai baik oleh pelanggan (diprakarsai pengguna) atau bisnis (diprakarsai bisnis), tetapi dalam kedua kasus 'sesi' dimulai dengan pesan pertama yang dikirim oleh bisnis.

Bagaimana cara kerja harga per percakapan?

Harga untuk pesan WhatsApp dihargai per percakapan. Mulai 1 Juni, ini dihargai per percakapan dan jenis percakapan. Sekarang ada empat kategori percakapan, yang masing-masing adalah dibebankan pada tarif yang berbeda:

1. Percakapan Utilitas - Memungkinkan penyelesaian permintaan atau transaksi tertentu yang disepakati atau memberikan pembaruan kepada pelanggan tentang transaksi yang sedang berlangsung, termasuk pemberitahuan pasca-pembelian dan laporan penagihan reguler.
2. Percakapan Otentikasi - Memungkinkan bisnis menggunakan kode sandi satu kali untuk memverifikasi pengguna di berbagai tahap login, jika perlu (misalnya verifikasi akun, pemulihan akun, tantangan integritas)
3. Percakapan Pemasaran - Percakapan yang diprakarsai bisnis untuk memasarkan barang atau layanan kepada pelanggan, seperti mengirimkan penawaran yang relevan kepada pelanggan yang telah memilih ikut. Ini juga akan mencakup interaksi terkait bisnis yang bukan otentikasi atau percakapan utilitas.
4. Percakapan Layanan - Diskusi yang diprakarsai pengguna yang membantu konsumen mendapatkan jawaban atas pertanyaan mereka.

API WhatsAppNow

Pusat Pesan memfasilitasi pengiriman pesan melalui berbagai saluran komunikasi, termasuk SMS, WhatsApp, RCS (Rich Communication Services). API ini menyediakan fitur yang kuat dan opsi fleksibel untuk memenuhi kebutuhan pesan yang beragam. WhatsApp Now adalah produk dari Message Central yang didasarkan pada API WhatsApp Business resmi.

Skenario Kasus Gunakan

• Kampanye Promosi: Gunakan WhatsApp Now untuk mengirim pesan promosi serta utilitas kepada pelanggan melalui WhatsApp. Kirim multimedia dan dokumen langsung melalui WhatsApp. Kirimkan pesan, pemberitahuan, dan pembaruan yang dipersonalisasi untuk meningkatkan kepuasan dan loyalitas pelanggan untuk meningkatkan pengalaman pelanggan Anda.
  
• Pesan Obrolan Langsung: Mengirim dan menerima pesan, multimedia, dan dokumen secara langsung melalui WhatsApp, memastikan komunikasi tepat waktu dan efektif dengan audiens Anda.
  
• Verifikasi OTP: Menerapkan sistem pengiriman OTP yang aman untuk otentikasi pengguna, memilih antara SMS, WhatsApp, atau email berdasarkan preferensi pengguna dan persyaratan keamanan.

Juga, parameter berikut perlu dikirim saat menggunakan API WhatsAppNow;

URL Dasar API Rest:

Semua titik akhir API Platform di bawah ini harus diawali dengan URL berikut:

https://cpaas.messagecentral.com

Menghasilkan Token

Saat menggunakan WhatsApp Now API untuk membuat template, mengirim pesan teks, dan menyiarkan pesan, panggilan awal harus ke API pembuatan token. API ini mengembalikan token yang harus disertakan dalam semua panggilan berikutnya. Token otentikasi diperlukan untuk memvalidasi pengguna dan harus disertakan dalam bagian header dari setiap permintaan.

Parameter Permintaan:

Meminta Jalur URL:

/auth/v1/authentication/token 

cURL

1curl --location 'https://cpaas.messagecentral.com/auth/v1/authentication/token?customerId=<CustomerId>&key=<Base64 Encrypted password>&scope=NEW&country=91&email=test@messagecentral.com' \
2--header 'accept: */*'

‍

CATATAN: Untuk mengonversi perintah cURL menjadi kode menggunakan Postman, buka Postman, impor perintah cURL melalui tombol “Impor”, lalu buat kode dalam bahasa pilihan Anda dengan mengklik tombol “Kode” di sisi kanan permintaan.

Tanggapan JSON

Respons yang berhasil akan mengembalikan kode status 200.

1{
2      "status": Integer,
3      "token": "String"
4} 

Buat Template

Anda dapat membuat template dari berbagai jenis dan kategori, serta membuat beberapa variasi bahasa dari template. Saat membuat template dengan beberapa versi bahasa, pastikan konsisten dengan terjemahan di seluruh versi.

Pastikan template Anda mengikuti Panduan Templat Pesan WhatsApp. Tidak mengikuti pedoman dengan benar dapat berdampak pada template yang disetujui.

‍

Proses Persetujuan

Template harus disetujui oleh Meta sebelum dapat digunakan dalam pesan WhatsApp. Saat dibuat, template awalnya memiliki status TERTUNDA. Setelah disetujui, mereka akan memiliki status DISETUJUI, dan kemudian dapat digunakan.

Template Kategori

• UTILITAS: Memungkinkan penyelesaian permintaan atau transaksi tertentu yang disepakati atau memberikan pembaruan kepada pelanggan tentang transaksi yang sedang berlangsung, termasuk pemberitahuan pasca-pembelian dan laporan penagihan reguler.
• OTENTIKASI: Memungkinkan bisnis menggunakan kode sandi satu kali untuk memverifikasi pengguna di berbagai tahap login, jika perlu (misalnya verifikasi akun, pemulihan akun, tantangan integritas).
• PEMASARAN: Percakapan yang diprakarsai bisnis untuk memasarkan barang atau layanan kepada pelanggan, seperti mengirimkan penawaran yang relevan kepada pelanggan yang telah memilih. Ini juga akan mencakup interaksi terkait bisnis yang bukan otentikasi atau percakapan utilitas.

Untuk Buat Template di bawah ini adalah parameter permintaan. Token otentikasi diperlukan untuk membuat template yang dihasilkan oleh token API yang dihasilkan (yang dapat Anda temukan di atas di bagian Pendahuluan)

Meminta Jalur URL:

POST: /verification/v3/template

Parameter Permintaan:

cURL

1curl --location 'https://cpaas.messagecentral.com/verification/v3/template' \
2--header 'authToken: eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJDLTM4MERBQzg1RDlGRjREMSIsImlhdCI6MTcyMDc2OTI2OCwiZXhwIjoxODc4NDQ5MjY4fQ.O8xl7vMUoOU4dCn61dqFTjBMxTVvnEpRCkzjMo4JW9YQrEdL0PK3sQW4PgZBWRUCvKDkoSRoDAdXhXy9rx' \
3--form 'phoneNumber="919457888189"' \
4--form 'name="template_without_media"' \
5--form 'language="en_US"' \
6--form 'category="MARKETING"' \
7--form 'headerFormat="TEXT"' \
8--form 'header="Congratulations"' \
9--form 'body="Hello Your account recharge of ₹100 is successful. Please use our services and enjoy!"' \
10--form 'footer="Type \"STOP\" to unsubscribe"'

‍

cURL

1curl --location 'https://cpaas.messagecentral.com/verification/v3/template' \
2--header 'authToken: eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJDLTM4MERBQzg1RDlGRjREMSIsImlhdCI6MTcyMDc2OTI2OCwiZXhwIjoxODc4NDQ5MjY4fQ.O8xl7vMUoOU4dCn61dqFTjBMxTVvnEpRCkzjMo4JW9YQrEdL0PK3sQW4PgZBWRUCvKDkoSRoDAdXYh9rxa' \
3--form 'phoneNumber="919457888189"' \
4--form 'name="template_without_media"' \
5--form 'language="en_US"' \
6--form 'category="MARKETING"' \
7--form 'headerFormat="TEXT"' \
8--form 'body="Hello Your account recharge of ₹100 is successful. Please use our services and enjoy!"' \
9--form 'footer="Type \"STOP\" to unsubscribe"' \
10--form 'file=@"/C:/Users/Kunal Suryawanshi/Downloads/Media (9).png"'

‍

Respon JSON (tanpa & dengan Template Media):

Respons yang berhasil akan mengembalikan kode status 200.

1{
2    "responseCode": 200,
3    "data": {
4        "data": {
5            “name”: "example_template",
6            "id": "790937216444187",
7            "status": "PENDING",
8            "category": "MARKETING"
9        }
10    }
11}

Penasihat untuk membuat Template

1. Nama - Nama template harus selalu dalam huruf kecil. Juga, jika ada beberapa kata, tambahkan “_” di antara 2 kata (misalnya: tes_template_01)
2. Template variabel - Untuk membuat template variabel, Anda perlu menambahkan placeholder dan nilai tubuhnya secara wajib saat membuat permintaan untuk template tersebut.

Variabel - Mereka selalu ditambahkan dalam dua kurung kurung, dan dalam angka meningkat
pesan, jika tidak template Anda akan ditolak.
Nilai Tubuh - Ini adalah contoh dari apa yang akan masuk ke dalam nilai variabel. Sejak
ini adalah data formulir, oleh karena itu jika ada lebih dari 2 variabel, pisahkan dengan
spasi.

‍Contoh pesan - Halo {{1}}, dapatkan diskon 50% dengan menerapkan kode kupon {{2}} terbaru oleh {{3}}

BodyValue (untuk pesan di atas) - “Kunal MSGCTL50 20thJune”, di sini Kunal adalah contoh 1st BodyValue dan seterusnya.

3. Batas karakter - Pesan teks bisa maksimal 4096 karakter panjang.

Kode Kesalahan untuk Membuat Template

Periksa Status Template

Ini memungkinkan Anda memantau status templat pesan yang dikirimkan untuk disetujui di WhatsApp. API ini menyediakan pembaruan real-time tentang apakah template Anda disetujui, tertunda, atau ditolak, memastikan Anda tetap mendapat informasi tentang ketersediaannya untuk digunakan.

Parameter Permintaan:

cURL

1curl --location --request GET 
2'https://cpaas.messagecentral.com/verification/v3/template' \
3--header 'authToken: 
4eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJDLTM4MERBQzg1RDlGRjREMSIsImlhdCI6MTcyMDc2OT
5 I2OCwiZXhwIjoxODc4NDQ5MjY4fQ.O8xl7vMUoOU4dCn61dqFTjBMxTVvnEpRCkzjMo4JW9YQrE
6 dL0PK3sQW4PgZBWRUCvKDkoSRoDAdYXh9rxa' \
7 --form 'phoneNumber="919547888189"' \
8 --form 'templateId="205681076471259"' \
9 --form 'templateName="test_template"' 

‍

Tanggapan JSON

Respons yang berhasil akan mengembalikan kode status 200.

1{
2    "name": "prod_test_temp_wmedia_1",
3    "components": [
4        {
5            "type": "HEADER",
6            "format": "TEXT",
7            "text": "Congratulations!"
8        },
9        {
10            "type": "BODY",
11            "text": "Your account recharge of $100 is successful. Please use our services and enjoy!"
12        },
13        {
14            "type": "FOOTER",
15            "text": "Type \"STOP\" to unsubscribe"
16        }
17    ],
18    "language": "en_US",
19    "status": "APPROVED",
20    "category": "UTILITY",
21    "id": "205681076471259"
22}

Kode Kesalahan untuk Dapatkan Status Template

Kirim Siaran

Untuk mengirim siaran WhatsApp ke nomor ponsel, parameter permintaan berikut diperlukan. Token otentikasi, yang dihasilkan oleh API pembuatan token, diperlukan untuk mengirim pesan template melalui siaran.

Meminta Jalur URL:

POST: /verification/v3/send

Kirim Siaran Tunggal

Untuk mengirim pesan siaran WhatsApp ke satu penerima untuk penjangkauan yang dipersonalisasi, tanggapan dukungan pelanggan, atau pemberitahuan mendesak di mana komunikasi yang ditargetkan diperlukan.

Parameter Permintaan:

CATATAN: Template yang digunakan harus DISETUJUI dari Meta. Maksimal 2 CTA dinamis hanya dapat dikirim.

cURL

CATATAN: Template yang digunakan harus semuanya template DISETUJUI dari Meta.

Silakan temukan format file sampel dalam format XLXS di bawah ini:

Deskripsi Bidang:

CATATAN: Empat kolom pertama (Negara, Seluler, CTAvar1, CTAvar2) harus selalu disertakan dalam header, bahkan jika tidak ada CTA dinamis dalam template. Dalam kasus seperti itu, nama kolom harus tetap, tetapi nilainya harus dibiarkan kosong.

Jumlah variabel kolom dalam file Excel harus sesuai dengan jumlah placeholder variabel di template Anda dengan tepat. Misalnya, jika template Anda berisi dua placeholder, file Anda harus menyertakan var1 dan var2—tidak lebih, tidak kurang.

Silakan lihat contoh berikut untuk memahami pemformatan file yang benar.

Contoh 1: Jika perusahaan ingin mengirim pesan yang disesuaikan menggunakan unggahan file tanpa CTA dinamis dan 2 variabel, bidang pesan harus diformat sebagai berikut:

Contoh pesan - Halo {{1}}, dapatkan diskon 50% dengan menerapkan kupon {{2}} Format XLxS harus sebagai berikut:

Contoh 2: Jika perusahaan ingin mengirim pesan khusus menggunakan unggahan file dengan CTA dinamis dan 3 variabel, bidang pesan harus diformat sebagai berikut:

Contoh pesan - Halo {{1}}, dapatkan diskon 50% dengan menerapkan kupon {{2}} terbaru oleh {{3}} CTA - www.messagecentral.com/ {{1}}

Format XLxS harus sebagai berikut:

cURL

1curl --location 
2'https://cpaas.messagecentral.com/verification/v3/send?flowType=WHATSAPP&se
3 nderId=919457848169&type=BROADCAST&templateName=template_without_media_1' \
4 --header 'authToken: 
5eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJDLTM4MERBQzg1RDlGRjREMSIsImlhdCI6MTcyMDc2OT
6 I2OCwiZXhwIjoxODc4NDQ5MjY4fQ.O8xl7vMUoOU4dCn61dqFTjBMxTVvnEpRCkzjMo4JW9YQrE
7 dL0PK3sQW4PgZBWRUCvKDkoSRoDAdYXh9rxa' \
8 --form 'file=@"/C:/Users/Kunal Suryawanshi/Documents/Test_WA_API.xlsx"'

‍

Tanggapan JSON

Respons yang berhasil akan mengembalikan kode status 200.

1{
2    "responseCode": 200,
3    "message": "SUCCESS",
4    "data": null
5}
6

Kode Kesalahan untuk Kirim Siaran

Kirim Pesan Obrolan

Untuk mengirim pesan WhatsApp (pesan obrolan) ke nomor ponsel, parameter permintaan berikut diperlukan. Token otentikasi, yang dihasilkan oleh API pembuatan token, diperlukan untuk mengirim pesan apa pun melalui obrolan langsung.

Meminta Jalur URL:

/verification/v3/send

Parameter Permintaan:

cURL

1curl --location --request POST 'https://cpaas.messagecentral.com/verification/v3/send?countryCode=91&flowType=WHATSAPP&mobileNumber=7715836906&senderId=919457888189&type=CHAT&message=Welcome%20to%20Message%20Central' \
2--header 'authToken: eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJDLTM4MERBQzg1RDlGRjREMSIsImlhdCI6MTcyMDc2OTI2OCwiZXhwIjoxODc4NDQ5MjY4fQ.O8xl7vMUoOU4dCn61dqFTjBMxTVvnEpRCkzjMo4JW9YQrEdL0PK3sQW4PgZBWRUCvKDkoSRoDAdYXh9rxa'

‍

Tanggapan JSON

Respons yang berhasil akan mengembalikan kode status 200.

1{
2    "responseCode": 200,
3    "message": "SUCCESS",
4    "data": {
5        "verificationId": null,
6        "mobileNumber": "917715836906",
7        "responseCode": "200",
8        "errorMessage": null,
9        "timeout": null,
10        "smsCLI": null,
11        "transactionId": "wamid.HBgMOTE3NzE1ODM2OTA2FQIAERgSOEFFNUM5MTFDRUVBMDUzMDFGAA=="
12    }
13}

Kode Kesalahan untuk Pesan Obrolan

Siapkan Webhook untuk Pesan Masuk

Sebelum Anda dapat mulai menerima pemberitahuan, Anda harus membuat titik akhir di server Anda untuk menerima pemberitahuan.

Setiap kali peristiwa pemicu terjadi, Platform Bisnis WhatsApp Pusat Pesan melihat peristiwa tersebut dan mengirimkan pemberitahuan ke URL Webhook yang akan Anda tentukan. Anda bisa mendapatkan dua jenis notifikasi:

1. Pesan yang diterima: Peringatan ini memberi tahu Anda ketika Anda telah menerima pesan. Ini juga dapat disebut “pemberitahuan masuk” di seluruh dokumentasi.
2. Status pesan: Peringatan ini memberi tahu Anda ketika status pesan telah berubah — misalnya, pesan telah dibaca atau dikirim. Ini juga bisa disebut “pemberitahuan keluar.”

Untuk berlangganan Webhooks, Anda harus mengikuti langkah-langkah ini:

1. Informasi yang Diperlukan:beberapa teks
   1. ID Pelanggan
   2. Nama Merek
   3. ID Email Terdaftar
   4. URL Panggilan Balik
      
      
2. Instruksi Pengajuan: Silakan kirim informasi di atas ke operations@messagecentral.com dengan baris subjek “Konfigurasi Webhook WhatsApp dengan Pusat Pesan”.
   
   
3. Spesifikasi URL Panggilan Balik: Pastikan URL panggilan balik Anda dapat diakses dan mampu menerima permintaan HTTP POST yang berisi muatan JSON dengan pembaruan status. Setelah dipicu, titik akhir akan menerima muatan JSON berikut dan harus merespons dengan 200.

‍