README

Whatsapp API SDK hanya untuk penggunaan keperluan perusahaan

Core concept

Penting untuk diketahui penggunaan sdk ini dipakai di end aplikasi, tidak menghandle langsung hook pada whatsapp.

1. Facebook akan mengirim WebHook ke gateway contoh gateway.domain.id
2. Gateway melakukan handshake dengan facebook terkait webhook apakah sesuai key atau tidak
3. Gateway meneruskan hook facebook ke end aplikasi contoh end.domain.id
4. end aplikasi inilah yang akan menggunakan sdk ini

Information

Ada beberapa type webhook yang dikirim oleh facebook

Message
- text
- image
- sticker
- documents
- unknown (ex pesan tidak support)
- button
Status
- sent
- delivered
- read
- failed

Features

Send text message
Generate webhook message (bukan memvalidasi webhook facebook secara langsung)
Send image message
Send document message

Usage

$token : Token facebook
$wabaId : WhatsApp business account id

use Rumahweb\WhatsApp;

$whatsApp = WhatsApp::init($token);

Message

$message = $whatsApp->message($wabaId); 

# Text message
$message->sendText("6285747277xxx", "Hello World");

Message Template

to : nomor penerima
header : header template (optional)
body : body template (optional)

$params["to"] = "xxxx";
$params["header"] = [
  [
    "type" => "text",
    "text" => "pesan nya apa"
  ]
]
$params["body"] = [
  [
    "type" => "text",
    "text" => "pesan nya apa"
  ]
]

$template = $whatsApp->template($wabaId);
$template->send("nama_template", $params);

Pastikan index array di header dan body sama dengan template yang telah dibuat di facebook sesuai urutan variabel nya.

Ref: disini

Contoh Response Success

Array
(
    [messaging_product] => whatsapp
    [contacts] => Array
        (
            [0] => Array
                (
                    [input] => +6285747277xxx
                    [wa_id] => 6285747277xxx
                )

        )

    [messages] => Array
        (
            [0] => Array
                (
                    [id] => wamid.HBgNNjI4NTc0NzI3NzQ2NhU
                    [message_status] => accepted
                )

        )

)

Hook

hook contoh dibawah merupakah return dari method berikut:

$hook = ['array', 'data', 'from', 'facebook'];
$webhook = new Rumahweb\Webhook($hook);
print_r($hook);

Keterangan :

phone_display : Nomor hp whatsapp
phone_id : Phone number id device whatsapp
hook_type : saat ini hanya ada 2 (message & status)
wamid : WhatsApp message ID

Message type

Text message

{
  "phone_display": "1234567890",
  "phone_id": "987654321",
  "hook_type": "message",
  "from_name": "addin",
  "from_phone": "6285747277xxx",
  "wamid": "wamid.HBgNNjI4NTxxxxxx",
  "timestamp": "1746604743",
  "type": "text",
  "text": "Halo ini pesan dari addin"
}

Status Type

recipient_phone : penerima message

Status Delivered

{
  "phone_display": "1234567890",
  "phone_id": "987654321",
  "hook_type": "status",
  "wamid": "wamid.HBgNNxxxx",
  "status": "delivered",
  "timestamp": "1746595471",
  "recipient_phone": "6285747277xxx"
}

Status sent

{
  "phone_display": "1234567890",
  "phone_id": "987654321",
  "hook_type": "status",
  "wamid": "wamid.HBgNNjIxx",
  "status": "sent",
  "timestamp": "1752630521",
  "recipient_phone": "6285747277xxx"
}

Status Failed

{
  "phone_display": "1234567890",
  "phone_id": "987654321",
  "hook_type": "status",
  "wamid": "wamid.HBgNxx",
  "status": "failed",
  "timestamp": "1752629020",
  "recipient_phone": "6285747277xxx"
}

Status Read

{
  "phone_display": "1234567890",
  "phone_id": "987654321",
  "hook_type": "status",
  "wamid": "wamid.HBgNNjxx",
  "status": "read",
  "timestamp": "1752630698",
  "recipient_phone": "6285747277xxx"
}

Example error

Array
(
    [error] => Array
        (
            [message] => Invalid OAuth access token - Cannot parse access token
            [type] => OAuthException
            [code] => 190
            [fbtrace_id] => AtYQl3mJPwLPhH-m_buoHAI
        )

)

Array
(
    [error] => Array
        (
            [message] => (#132001) Template name does not exist in the translation
            [type] => OAuthException
            [code] => 132001
            [error_data] => Array
                (
                    [messaging_product] => whatsapp
                    [details] => template name (event_reminder3) does not exist in id_ID
                )

            [fbtrace_id] => AGSJexhOhNweWMeFsVy4y05
        )

)

rumahweb / whatsapp-sdk

Maintainers

Details