API Templat Kirim WhatsApp Interakt

Sebagai sebuah bisnis, Anda mungkin ingin mengirim pesan WhatsApp ke pelanggan Anda secara otomatis ketika suatu peristiwa yang berkaitan dengan pelanggan telah terjadi.

‍Salah satu cara untuk mencapai hal ini adalah dengan menggunakan Interakt Lacak API untuk mengirim acara ini ke Interakt & setting Kampanye yang Sedang Berlangsung di Interakt. Anda harus memilih metode ini jika:

• Anda ingin meminimalkan upaya coding Anda.

• Dalam metode ini, Anda hanya perlu melakukan panggilan API ketika suatu peristiwa terjadi di sistem Anda (situs web/aplikasi/CRM, dll.)

• Anda tidak perlu khawatir untuk mengubah pesan yang ingin Anda kirimkan ketika peristiwa itu terjadi.

• Jika Anda memiliki logika kompleks kapan Anda ingin pesan disampaikan, Anda tidak perlu membuat logika tersebut. Misalnya:

• Misalkan Anda ingin pesan keluar dengan penundaan tertentu setelah suatu peristiwa, atau, 

• Anda ingin pesan keluar setelah acara hanya jika pengguna memiliki atribut tertentu, atau,

• Anda ingin pesan keluar setelah acara hanya jika pengguna tidak melakukan acara lain dalam beberapa jam, dll.

• Anda ingin dengan mudah melihat hasil (statistik pengiriman/baca) kampanye ini tanpa harus membuat panel sendiri untuk ini.

• Ringkasan kampanye Anda tersedia dengan mudah untuk Anda Dasbor kampanye Interakt.

• Situs web Anda dibuat menggunakan Shopify. Kami memiliki integrasi langsung dengan Shopify! Anda tidak perlu memanggil API apa pun untuk mengirimkan pesan WhatsApp ketika pelanggan Anda meninggalkan keranjang/memesan, dll.

‍

Cara kedua untuk mencapai hal ini adalah dengan menggunakan API Pengiriman Templat Interakt (diberikan di bawah) untuk mengirim pesan (templat/HSM) ke WhatsApp secara langsung & kemudian menggunakan webhook yang dikirim oleh Interakt yang berisi informasi apakah pesan terkirim, terkirim, dibaca, gagal. Anda harus memilih metode ini jika:

• Anda memiliki bandwidth & sumber daya pengkodean untuk:

• membangun sebuah proses untuk memungkinkan perubahan yang sering terjadi pada pesan-pesan yang harus dikirim

• membangun logika kompleks tentang kapan harus mengirim pesan.

• Anda sudah memiliki panel tempat Anda melacak kampanye Anda (dari saluran lain) dan karenanya ingin melacak kampanye WhatsApp Anda di panel yang sama.

(atau Anda mungkin menggunakan pemasaran whatsapp alat otomatisasi untuk keduanya)

• Cara kedua ini juga bisa Anda gunakan jika ingin memicu SMS/Email jika pesan WhatsApp gagal sampai ke pelanggan.

‍

Detail API Pengiriman Templat:

Memanggil /v1/publik/pesan/ untuk mengirimkan Template sesuai kebutuhan

1. Jika Anda ingin menyimpan atribut tingkat pesan apa pun, Anda dapat menggunakan panggilan balik_data parameter untuk mengirim data tambahan. Ini akan dikembalikan kepada Anda di webhook yang sesuai.

2. Kami akan mengirimkan id sebagai respons terhadap panggilan API Anda. Ini id dapat disimpan untuk referensi di masa mendatang. Id ini akan dirujuk ketika webhook dikembalikan nanti.

URL: https://api.interakt.ai/v1/public/message/

metode: POS

Header: 

• Autentikasi:

• Anda dapat mengautentikasi dengan mengirimkan Kunci API beserta data permintaan.

• Mekanisme otentikasi menggunakan Otentikasi Dasar HTTP yang mengharuskan Anda mengirim Kunci API dengan 'Dasar' String.

• Pasangan kunci header akan terlihat seperti 'Authorization: Basic'Kunci API>'.

• Kunci API akan tersedia di Dasbor Interakt Anda di Pengaturan Pengembang: https://app.interakt.ai/settings/developer-setting

‍

• Jenis konten:

• Anda harus mengatur header content-type ke 'application/json' agar dapat mengirim data ke endpoint API HTTP kami.

Badan Permintaan:

Contoh 1:

• Jika header template bertipe teks dan berisi variabel juga

• Tubuh berisi variabel

• Template memiliki 1 tombol CTA yang berisi URL dinamis

{
 "countryCode": "+xx", /* required */
 "phoneNumber": "xxxxxxxxxx", /* required */
 "type": "Template", /* required */
 "callbackData": "some_callback_data", /* optional string with max length 512 */
 "template": {
   "name": "delivered_alert_101", /* required */
   "languageCode": "en", /* required */
   "headerValues": [
     "Alert" /* value for variable {{1}} in header text*/
   ],
   "fileName": "dummy.pdf", /* optional, and only applicable with document header */
   "bodyValues": [
     "There", /* value for variable {{1}} in body text */
     "1234" /* value for variable {{2}} in body text */
   ],
   "buttonValues": {
     "0" /*button index */ :[
       "12344" /* value for {{1}} for dynamic url in button at index position 0*/
     ]
   }
 }
}Copy

‍

Contoh 2:

• Jika header template bertipe media (gambar/video/dokumen) - daftar headerValues ​​hanya akan memiliki elemen dengan nilai mediaUrl.

• Tubuh berisi variabel

• Template ini memiliki 2 tombol CTA - tombol pertama berisi nomor telepon & tombol kedua berisi URL dinamis.

{
 "countryCode": "+xx", /* required */
 "phoneNumber": "xxxxxxxxxx", /* required */
 "type": "Template", /* required */
 "callbackData": "some_callback_data", /* optional string with max length 512 */
 "template": {
   "name": "delivered_alert_101", /* required */
   "languageCode": "en", /* required */
   "headerValues": [
     "https://interaktstorage.blob.core.windows.net/mediastoragecontainer/91e5634a-33b0-44b4-a075-884778f02feb/message_template_sample/tcITOHfOz6vy.png?se=2026-08-13T11%3A53%3A58Z&sp=rt&sv=2019-12-12&sr=b&sig=PDn3cPLmV%2BYu3D7Wd10JYmPLQeyGyytl013wAtmbL6g%3D" /* media url for the header's media file */
   ],
   "bodyValues": [
     "There", /* value for variable {{1}} in body text */
     "1234" /* value for variable {{2}} in body text */
   ],
   "buttonValues": {
     "1" /*button index */ :[
       "12344" /* value for {{1}} for dynamic url in button at index position 0*/
     ]
   }
 }
}Copy

Badan Respons:

{
 "result": true,
 "message": "Message created successfully",
 "id": "6c2d7175-fddd-4fbf-b0eb-084f170dbe08"
}Copy

The id dikembalikan adalah id pesan. Ini dapat digunakan untuk merujuk ke webhook pesan.

‍

Bidang & Deskripsi

phoneNumberNomor telepon pengguna, pastikan tidak mengandung kode negara atau angka "0" (nol) di awal nomor.

Kode negaraKode negara ponsel pengguna

type: Jenis pesan yang akan dikirim

Nilai yang Didukung: Templat

Nama templat

Pastikan template dibuat di Interakt. Nama template yang akan digunakan adalah kode nama template tersebut. Bagaimana cara mendapatkan kode nama?

• Pergi ke https://app.interakt.ai/templates/list.

• Klik pada templat yang ingin Anda gunakan

• Halaman yang terbuka akan memiliki URL berikut: https://app.interakt.ai/template/nama kode/melihat

• Nama kode = bagian URL di antara 'template/' dan '/view'

OR, jika Anda ingin menggunakan template yang Anda buat di Facebook Business Manager, silakan klik Sinkronkan di https://app.interakt.ai/templates/list dan setelah Sinkronisasi selesai Anda akan melihat template muncul di daftar.

Kode Bahasa

Kode bahasa harus sesuai dengan bahasa yang Anda gunakan untuk membuat template. Anda dapat menemukan semua kode bahasa di sini: https://developers.facebook.com/docs/whatsapp/api/messages/message-templates/

headerValues ​​/ bodyValues ​​/ buttonValues 

Nilai variabel yang terdapat dalam templat

• Header (jika tipe header adalah teks & terdapat variabel di dalamnya ATAU jika tipe header adalah media)

• Body

• tombol (hanya jika ada URL dinamis di tombol)

Contoh 3: Cara mengirim payload di dalam Tombol Balas Cepat pada template

(Ini hanya relevan jika Anda menggunakan akun Interakt untuk mengirimkan kampanye WhatsApp dan Anda juga memiliki bot Haptik langsung. Muatan tombol akan dikembalikan oleh WhatsApp di webhook mereka, setiap kali pelanggan mengeklik tombol tersebut.)

Contoh di bawah ini menunjukkan payload yang akan digunakan untuk template yang memiliki:

• Header dokumen

• 1 Variabel dalam Tubuh

• 3 Tombol Balasan Cepat (dan muatan untuk setiap tombol)

{
 "countryCode": "+91",
 "phoneNumber": "9999999999",
 "callbackData": "some text here",
 "type": "Template",
 "template": {
   "name": "temp_with_quick_reply_buttons",
   "languageCode": "en",
   "headerValues": [
     "https://interaktstorage.blob.core.windows.net/mediastoragecontainer/07ed4524-9549-481b-ad51-400200cabe0b/message_template_media/UkJYYpHdmCBc.pdf?se=2027-01-14T09%3A53%3A35Z&sp=rt&sv=2019-12-12&sr=b&sig=iJvIT6trhzcb81xg92HytxN2SH8p4YPX8xg5IItCUgQ%3D"
   ],
   "fileName": "Sample Document for testing.pdf",
   "bodyValues": [
     "some text here if any variable in message body"
   ],
   "buttonPayload": {
     "0": ["payload0"],
     "1": ["payload1"],
     "2": ["payload2"]
   }
 }
}Copy

‍

Parameter yang akan digunakan

tombolPayload

Deskripsi

Tipe data yang didukung - Untuk payload, hanya tipe data string yang diperbolehkan. Karakter apa pun seperti @, %, * atau spasi beserta nilai alfanumerik diterima, tetapi hanya dalam tipe data string seperti

"12 345abc( ) ? ! . # % @ ^ = + - & * ` ~ ; : < > { }"

Batas karakter muatan - Batas karakter muatan adalah 128 karakter.

Note: Penomoran tombol dimulai dengan 0. Maksimal 3 tombol.

Untuk Melacak analitik Anda Kirim Kampanye API Templat, Anda dapat membuat Kampanye API dan melacak analitik di Dasbor Interakt itu sendiri. Klik di sini untuk mengetahui lebih banyak tentang Kampanye API.

Untuk memastikan analitik Kampanye API dicatat di Dasbor Interakt, gunakan “Id kampanye” nilai yang diterima dalam respons saat memanggil API “Buat Kampanye API”.

Example 

Badan Permintaan

curl --location 'https://api.interakt.ai/v1/public/message/' \
--header 'Authorization: Basic {{YOUR_API_KEY}}' \
--header 'Content-Type: application/json' \
--data '{
    "countryCode": "+91",
    "phoneNumber": "9999999999",
    "campaignId" : "YOUR_CAMPAIGN_ID",
    "callbackData": "some text here",
    "type": "Template",
    "template": {
        "name": "template_name_here",
        "languageCode": "en",
        "bodyValues": [
            "body_variable_value_1",
            "body_variable_value_n"
        ]
    }
}'Copy

Note: Jika Anda tidak menyebutkan “Id kampanye” Bidang di Badan, kampanye akan tetap didapat Terkirim tetapi analitiknya tidak akan direkam di Dasbor Interakt.