API di Tempat Platform WhatsApp Business

Mengirim Pesan Media

Gunakan node messages untuk mengirim pesan yang berisi audio, dokumen, gambar, stiker, atau video ke pelanggan Anda.

Pada intinya, saat mengirim pesan yang berisi media, Anda harus memberikan ID dari media unggahan atau tautan ke media itu dalam badan permintaan. Anda juga harus menentukan jenis media yang ingin Anda kirimkan: audio, image, document, sticker, atau video. Saat permintaan diterima, media diunggah ke server WhatsApp dan dikirim ke pengguna yang tertera dalam kolom to.

Saat ini, ada dua cara untuk mengirimkan pesan media dengan API WhatsApp Business:

  • ID — Untuk menggunakan ID, Anda harus mengunggah media menggunakan node media guna memperoleh ID yang diperlukan untuk panggilan API messages.
  • Tautan — Untuk menggunakan tautan, Anda harus memberikan tautan HTTP(S) yang akan digunakan aplikasi untuk mengunduh media, sehingga Anda tidak perlu mengunggah media sendiri.

Sebelum Memulai

Anda perlu:

Langkah 1: Buat Permintaan POST ke /messages

Setelah Anda mengunggah media, gunakan ID yang dikembalikan untuk kolom id di panggilan API yang mengirim pesan media. Atau, Anda dapat menyediakan parameter link yang menunjuk ke media yang ingin Anda kirim (saat ini hanya tautan HTTP / HTTPS yang didukung).

Diperlukan id atau link, tetapi tidak boleh digunakan secara bersamaan.

Contoh

Contoh di atas menunjukkan sejumlah objek yang berbeda, seperti audio, document, image, sticker, dan video sebagai ilustrasi saja. Isi permintaan yang valid hanya berisi salah satunya.

POST /v1/messages
{
  "recipient_type": "individual",
  "to": "whatsapp-id",
  "type": "audio" | "contact" | "document" | "image" | "location" | "sticker" | "text" | "video",
  
  "audio": {
    "id": "your-media-id"
  }
  
  "document": {
    "id": "your-media-id",
    "filename": "your-document-filename"
  }
  
  "document": {
    "link": "the-provider-name/protocol://the-url",
    "provider": {
        "name" : "provider-name"
    }
  }
  
  "document": {
    "link": "http(s)://the-url.pdf"
  }
  
  "video": {
    "id": "your-media-id"  
  }
  
  "image": {
    "link": "http(s)://the-url",
    "provider": {
        "name" : "provider-name"
    }
  }
  
  "image": {
    "id": "your-media-id"   
  }
  
  "sticker": {
    "id": "your-media-id"
  }
  
  "sticker": {
    "link": "http(s)://the-url",
    "provider": {
      "name" : "provider-name"
    }
  }
}

Untuk informasi selengkapnya tentang parameter, lihat:

Langkah 2: Periksa Tanggapan Anda

Tanggapan yang berhasil termasuk objek messages dengan ID pesan.

{
  "messages": [{
    "id": "gBEGkYiEB1VXAglK1ZEqA1YKPrU"
  }]
}

Apabila mendapatkan tanggapan tidak berhasil, panggilan balik dikirim ke URL Webhooks Anda meskipun tanggapannya akan menghasilkan ID pesan yang mirip dengan saat pengiriman pesan berhasil. Itulah alasan pentingnya penyiapan server Webhook.

Lihat Kode Kesalahan dan Status untuk informasi selengkapnya tentang kesalahan.

Pelajari selengkapnya