Cloud API

Komponen Percakapan

Komponen percakapan adalah fitur dalam obrolan yang dapat Anda aktifkan di nomor telepon bisnis. Komponen tersebut mempermudah pengguna WhatsApp untuk berinteraksi dengan bisnis Anda. Anda dapat mengonfigurasi perintah yang mudah digunakan, menyediakan pencair suasana yang telah ditulis sebelumnya yang dapat diketuk pengguna, dan menyapa pengguna pertama kali dengan pesan sambutan.

Batasan

Jika pengguna WhatsApp mengetuk tautan universal (yaitu, tautan wa.me) yang dikonfigurasi dengan teks yang telah diisi sebelumnya, antarmuka pengguna untuk pencair suasana secara otomatis ditutup.

Mengonfigurasi Melalui Pengelola WhatsApp (WAM)

Anda dapat mengonfigurasi semua fitur ini di Pengelola WhatsApp pada nomor spesifik yang Anda pilih:

  1. Buka dasbor Aplikasi Saya di situs Meta untuk Developer.
  2. Pilih aplikasi Anda, lalu pada panel kiri pilih Konfigurasi di bagian WhatsApp.
  3. Di bagian Nomor Telepon, pilih Kelola Nomor Telepon.
  4. Di ujung kanan nomor telepon yang ingin Anda konfigurasi, pilih Ikon Rodagigi di bagian Pengaturan.
  5. Pilih Otomatisasi.
  6. Akses dan konfigurasi Komponen Percakapan.

Mitra Solusi dapat mengonfigurasi fitur ini untuk pelanggan mereka juga jika mereka memiliki akses ke Akun WhatsApp Business pelanggan mereka di Pengelola WhatsApp.

Pesan Sambutan

Pesan sambutan saat ini tidak berfungsi sebagaimana mestinya.

Sayangnya, kami belum dapat memastikan kapan fitur ini diharapkan akan diimplementasikan di masa mendatang.

Semua jenis pesan bentuk bebas, interaktif, dan template dapat dikirim sebagai pesan sambutan. Harga pesan yang dikategorikan akan berlaku.

Anda bisa mendapat pemberitahuan dari webhook setiap kali pengguna WhatsApp membuka obrolan dengan Anda untuk pertama kalinya. Pemberitahuan ini berguna jika Anda ingin membalas pengguna ini dengan pesan sambutan khusus yang Anda desain sendiri.

Pesan Sambutan sangat bagus untuk interaksi layanan, seperti dukungan pelanggan atau layanan akun. Contoh, Anda dapat menyematkan tombol WhatsApp di aplikasi atau situs web Anda. Saat pengguna mengetuk tombol, mereka akan dialihkan ke WhatsApp di mana mereka akan menerima pesan sambutan yang memberikan konteks tentang bagaimana mereka dapat berinteraksi dengan Anda.

Jika Anda mengaktifkan fitur ini dan pengguna mengirimi Anda pesan, klien WhatsApp memeriksa utas pesan yang ada di antara nomor telepon pengguna dan bisnis Anda. Jika tidak ada, klien memicu webhook messages dengan mengatur type ke request_welcome. Anda kemudian dapat menanggapi pengguna dengan pesan sambutan Anda sendiri.

Webhook request_welcome memicu jendela layanan pelanggan yang memungkinkan bisnis Anda untuk mengirim pesan bentuk bebas saat menanggapi pelanggan.

Ash: My home office supervisor

Pesan template Carousel sebagai Pesan Sambutan

Payload Webhook

{
  "object": "whatsapp_business_account",
  "entry": [
    {
      "id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
      "changes": [
        {
          "value": {
            "messaging_product": "whatsapp",
            "metadata": {
              "display_phone_number": "<BUSINESS_DISPLAY_PHONE_NUMBER>",
              "phone_number_id": "<BUSINESS_PHONE_NUMBER_ID>"
            },
            "contacts": [
              {
                "profile": {
                  "name": "<WHATSAPP_USER_NAME>"
                },
                "wa_id": "<WHATSAPP_USER_ID>"
              }
            ],
            "messages": [
              {
                "from": "<WHATSAPP_USER_PHONE_NUMBER_ID>",
                "id": "<WHATSAPP_MESSAGE_ID>",
                "timestamp": "<TIMESTAMP>",
                "type": "request_welcome"  // Indicates first time message from WhatsApp user
              }
            ]
          },
          "field": "messages"
        }
      ]
    }
  ]
}

Pencair Suasana

Pencair Suasana adalah string teks yang dapat disesuaikan dan diketuk yang muncul di utas pesan saat pertama kali Anda mengobrol dengan pengguna. Contoh, "Rencanakan perjalanan" atau "Buat rencana olahraga".

Pencair suasana sangat bagus untuk interaksi layanan, seperti dukungan pelanggan atau pelayanan akun. Contoh, Anda dapat menyematkan tombol WhatsApp di aplikasi atau situs web Anda. Saat pengguna mengetuk tombol tersebut, mereka akan dialihkan ke WhatsApp di mana mereka dapat memilih dari serangkaian perintah yang dapat disesuaikan, yang menunjukkan kepada mereka cara berinteraksi dengan layanan Anda.

Anda dapat mengonfigurasi hingga 4 pencair suasana pada nomor telepon bisnis. Setiap pencair suasana dapat memiliki maksimal 80 karakter. Emoji tidak didukung.

Ketika pengguna mengetuk pencair suasana, hal ini akan memicu webhook pesan diterima standar dengan string pencair suasana yang ditetapkan ke properti body di payload. Jika pengguna mencoba untuk mengirim pesan kepada Anda alih-alih mengetuk pencair suasana, keyboard akan muncul sebagai overlay, tetapi dapat diabaikan untuk melihat menu pencair suasana lagi.

Jika pengguna WhatsApp mengetuk tautan universal (tautan wa.me atau api.whatsapp.com) yang dikonfigurasi dengan teks yang telah diisi sebelumnya, antarmuka pengguna untuk pencair suasana secara otomatis ditutup.

Payload Webhook

{
  "object": "whatsapp_business_account",
  "entry": [
    {
      "id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
      "changes": [
        {
          "value": {
            "messaging_product": "whatsapp",
            "metadata": {
              "display_phone_number": "<BUSINESS_DISPLAY_PHONE_NUMBER>",
              "phone_number_id": "<BUSINESS_PHONE_NUMBER_ID>"
            },
            "contacts": [
              {
                "profile": {
                  "name": "<WHATSAPP_USER_NAME>"
                },
                "wa_id": "<WHATSAPP_USER_ID>"
              }
            ],
            "messages": [
              {
                "from": "<WHATSAPP_USER_PHONE_NUMBER_ID>",
                "id": "<WHATSAPP_MESSAGE_ID>",
                "timestamp": "<TIMESTAMP>",
                "text": {
                  "body": "Plan a trip"
                },
                "type": "text"
              }
            ]
          },
          "field": "messages"
        }
      ]
    }
  ]
}

Perintah

Perintah adalah string teks yang dapat dilihat pengguna WhatsApp dengan mengetikkan garis miring di utas pesan dengan bisnis Anda.

Perintah terdiri dari perintah itu sendiri dan petunjuk, yang memberikan gagasan kepada pengguna tentang apa yang bisa terjadi saat mereka menggunakan perintah tersebut. Contoh: Anda dapat mendefinisikan perintah:

/imagine - Create images using a text prompt

Saat pengguna WhatsApp mengetik, /bayangkan mobil berpacu di Mars, itu akan memicu webhook pesan yang diterima dengan string teks yang sama yang ditetapkan ke properti body. Anda kemudian bisa membuat dan menampilkan gambar mobil berpacu di planet Mars.

Anda dapat mendefinisikan hingga 30 perintah. Setiap perintah memiliki maksimal 32 karakter, dan setiap petunjuk memiliki maksimal 256 karakter. Emoji tidak didukung.

Payload Webhook

{
  "object": "whatsapp_business_account",
  "entry": [
    {
      "id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
      "changes": [
        {
          "value": {
            "messaging_product": "whatsapp",
            "metadata": {
              "display_phone_number": "<BUSINESS_DISPLAY_PHONE_NUMBER>",
              "phone_number_id": "<BUSINESS_PHONE_NUMBER_ID>"
            },
            "contacts": [
              {
                "profile": {
                  "name": "<WHATSAPP_USER_NAME>"
                },
                "wa_id": "<WHATSAPP_USER_ID>"
              }
            ],
            "messages": [
              {
                "from": "<WHATSAPP_USER_PHONE_NUMBER_ID>",
                "id": "<WHATSAPP_MESSAGE_ID>",
                "timestamp": "<TIMESTAMP>",
                "text": {
                  "body": "/imagine cars racing on Mars"
                },
                "type": "text"
              }
            ]
          },
          "field": "messages"
        }
      ]
    }
  ]
}

Mengonfigurasi Melalui API

Dengan menggunakan API ini, Anda juga dapat mengonfigurasi komponen percakapan dan melihat nilai yang telah dikonfigurasi.

API Komponen Percakapan memiliki dua endpoint:

POST </PHONE_NUMBER_ID>/conversational_automation yang digunakan untuk mengonfigurasi komponen percakapan pada nomor telepon tertentu.

GET /<PHONE_NUMBER_ID>/conversational_automation yang mengembalikan nilai saat ini untuk kolom enable_welcome_message, perintah, dan topik pada nomor telepon tertentu.

Mengonfigurasi Komponen Percakapan Melalui API

Anda dapat mengonfigurasi Komponen Percakapan pada nomor telepon tertentu dengan menghubungi endpoint POSTINGAN.

Sintaksis Permintaan

// Enable or disable the Welcome Message for the given phone number ID
POST /<PHONE_NUMBER_ID>/conversational_automation?enable_welcome_message=<ENABLE_DISABLE>

// Configure Commands with names and descriptions
POST /<PHONE_NUMBER_ID>/conversational_automation?commands=<COMMAND_LIST>

// Configure Prompts
POST /<PHONE_NUMBER_ID>/conversational_automation?prompts=<PROMPT>

Properti Body


PlaceholderDeskripsiContoh Nilai

<PHONE_NUMBER_ID>

Bilangan bulat

Wajib.


ID nomor telepon di akun WhatsApp Business.

+12784358810

<ENABLE_DISABLE>

Boolean

Opsional.


Boolean untuk mengaktifkan atau menonaktifkan pesan sambutan di nomor telepon.


true

<COMMAND_LIST>

JSON

Opsional.


Daftar perintah yang akan dikonfigurasi.


"commands": {
     "command_name": "generate"
     "command_description": "Create a new image",
     “command_name”: “rethink”
     “command_description”: “Generate new images from existing images”,
}

<PROMPTS>

Daftar String

Opsional.


Topik yang akan dikonfigurasi.


"prompts": ["Book a flight","plan a vacation"]

Contoh Permintaan

   curl -X POST \
 'https://graph.facebook.com/v19.0/PHONE_NUMBER_ID/conversational_automation' \
 -H 'Authorization: Bearer ACCESS_TOKEN' \
 -H 'Content-Type: application/json' \
 -d '{
   "enable_welcome_message": true/false,
   "commands": [
     {
       "command_name": "tickets",
       "command_description": "Book flight tickets",
     },
     {
       "command_name": "hotel",
       "command_description": "Book hotel",
     }
   ],
 "prompts": ["Book a flight","plan a vacation"]
}'

Contoh Tanggapan

{
  "success": true
}

Melihat Konfigurasi Saat Ini Melalui API

Anda dapat melihat konfigurasi Komponen Percakapan saat ini pada nomor telepon tertentu dengan menghubungi endpoint GET.

Sintaksis Permintaan

GET  /<PHONE_NUMBER_ID>?fields=conversational_automation

Contoh Tanggapan

{
  "conversational_automation": {
    "enable_welcome_message": true
    "prompts": [
      "Find the best hotels in the area",
      "Find deals on rental cars"
    ],
    "commands": [
      {
        "command_name": "tickets",
        "command_description": "Book flight tickets",
      },
      {
        "command_name": "hotel",
        "command_description": "Book hotel",
      }
    ],
  }
  "id": "123456"
}

Pengujian

Untuk menguji komponen percakapan setelah dikonfigurasi, buka klien WhatsApp dan buka obrolan dengan nomor telepon bisnis Anda.

Untuk pesan sambutan dan pencair suasana, jika Anda sudah memiliki utas obrolan dengan nomor telepon bisnis, Anda harus menghapus utas obrolan terlebih dahulu:

  1. Buka utas di klien WhatsApp.
  2. Ketuk profil nomor telepon bisnis
  3. Ketuk Hapus Obrolan > Hapus Semua Pesan.
  4. Hapus Obrolan.
  5. Mulai utas obrolan baru dengan bisnis ini.

Anda kemudian dapat mengirim pesan ke nomor telepon bisnis, yang seharusnya memicu webhook request_welcome.