Webhook Incoming Message
#
Apa itu Webhook Incoming Message?Webhook digunakan untuk memforward pesan yang masuk dari sistem kami ke sistem anda, sehingga anda bisa memanfaatkan atau memanipulasi data pesan yang masuk dari sisi backend anda.
#
Penting- Jika anda mengaktifkan webhook incoming message, maka Bot Auto Reply yang anda setting pada panel dashboard kami tidak akan bekerja. Ini agar tidak ada bentrok antara sistem kami dan sistem backend anda.
- Data yang kami kirimkan berupa JSON Object
#
Data Webhook- Index Data
Parameter | Type | Description |
---|---|---|
uuid | id | Unique Message UUID |
user_id | id | Unique User UUID |
device_id | id | Unique Device UUID |
wa_group_id | string | Whatsapp Group ID |
phone | number | Whatsapp Phone Number or Group ID |
message | string | Message From Whatsapp or Group Whatsapp |
attachment_id | id | Unique Attachment UUID |
type | string | Message Type: text, image or document |
category | string | Message Category: Inbox |
status | string | Message Status: Received |
read | boolean | 0 (false) or 1 (true) |
reply | boolean | 0 (false) or 1 (true) |
reply_by_user_id | id | Unique Sub User UUID |
deleted_at | datetime | Time Deleted |
created_at | datetime | Time Created |
updated_at | datetime | Time Updated |
- Attachment Data
Parameter | Type | Description |
---|---|---|
uuid | id | Unique Attachment UUID |
message_id | id | Unique Message UUID |
file_name | string | Attachment File Name |
file_url | string | Attachment File URL |
file_size | number | Attachment File Size in bytes |
created_at | datetime | Time Created |
updated_at | datetime | Time Updated |
#
Example Data Webhook (JSON)- Berikut contoh data yang kami kirimkan dalam bentuk JSON Object
{ "uuid": "1eb056eb-8533-4d51-abc1-0ef15a9a7899", "user_id": "607a6e33-585e-4f8f-bf5d-d45fe222ad51", "device_id": "792f656e-4cd7-434b-bab0-bacee3976b4f", "wa_group_id": "1586343326", "phone": "6283140103048", "message": "Pesan ini memiliki attachment/file/lampiran. Silahkan cek link dibawah ini untuk membukanya.", "attachment_id": "16e4e671-5808-4330-a095-0665903582bf", "type": "Image", "category": "Inbox", "status": "Received", "read": 0, "reply": 0, "reply_by_user_id": null, "deleted_at": null, "created_at": "2020-04-14 21:18:39", "updated_at": "2020-04-14 21:18:39", "attachment": { "uuid": "16e4e671-5808-4330-a095-0665903582bf", "file_name": "85f4cc5d-0d41-47e8-8df2-4a0d7a990f9e.jpeg", "file_url": "https://assets.krmpesan.com/uploads/0459c30e-893b-4086-9de2-88095c80129b.jpeg", "file_size": 124226, "created_at": "2020-04-14 21:18:39", "updated_at": "2020-04-14 21:18:39" }}
#
Implementasi WebhookPada contoh ini kami membuat file php sederhana untuk menerima webhook pesan masuk. Buat file dengan nama hook.php
dan simpan pada website anda, kemudian paste skrip berikut.
- Anda juga bisa langsung membuat pesan balasan dari webhook ini.
- Kami membuat contoh dalam bahasa pemograman PHP
- Jika anda menggunakan bahasa lainnya, silahkan di sesuaikan dengan bahasa pemograman yang anda gunakan dengan memparse JSON Object yang kami kirimkan
#
Simpan Pesan ke File TXT dan Balas Pesan<?php
// terima setiap inputan yang masuk$getData = file_get_contents('php://input');
// simpan data ke file .txtfile_put_contents('hook.txt', $getData);
// decode json ke array$message = json_decode($getData, true);
// buat variable$phone = $message['phone'];
// balas pesan automatisecho "hi $phone, pesanmu telah kami terima, terimakasih\n\n*Hormat Kami*,\n_Tim CS_";
// jika anda tidak ingin membalas langsung, return data null// dan hapus echo pesan sebelumnyaecho null;
#
Balas Pesan dengan KEY tertentu<?php
// terima setiap inputan yang masuk$getData = file_get_contents('php://input');
// decode json ke array$message = json_decode($getData, true);
// buat variable$message = $message['message'];
// cek pesanif($message == 'hi') { echo "anda mengirim dengan keyword: hi";} else { echo "keyword data tidak ada, pesan anda: $message";}
#
Disable atau Webhook Error- Jika anda ingin mendisable webhook, hapus data webhook dari device anda, jika webhook kosong, maka trigger action ini tidak akan dikirimkan
- Jika webhook anda me-return error, maka akan kami notifkan via email