kirem.coDokumentasi API
Dokumentasi/Messages/Mengirim Pesan Kontak (Contacts)
Messages

Mengirim Pesan Kontak (Contacts)

Ringkasan Teknis (TL;DR)

Panduan membagikan data kontak vCard nama, telepon, dan alamat ke pelanggan.

#messages#send#contacts#vcard

Mengirim Pesan Kontak (Contacts)

Endpoint ini digunakan untuk membagikan informasi kontak (vCard) ke pelanggan Anda secara terstruktur. Pelanggan dapat langsung menyimpan nomor telepon, email, alamat, atau nama perusahaan yang dikirimkan ke dalam daftar kontak ponsel mereka dengan sekali ketuk.


🛜 1. HTTP Endpoint

  • Opsi A (Default): POST /v1/messages (Routing otomatis menggunakan saluran aktif pertama)
  • Opsi B (Spesifik): POST /v1/:phone_number_id/messages (Routing melalui nomor tertentu)
Info

Informasi mengenai perbedaan kedua opsi routing ini serta cara mendapatkan phone_number_id dapat dibaca selengkapnya pada Panduan Mengirim Pesan Teks.

Headers:

  • Authorization: Bearer <API_KEY>
  • Content-Type: application/json

📦 2. Payload Request (JSON)

Sertakan array contacts dengan data informasi kontak yang ingin dikirimkan.

{
  "messaging_product": "whatsapp",
  "recipient_type": "individual",
  "to": "62812345678",
  "type": "contacts",
  "contacts": [
    {
      "addresses": [
        {
          "street": "Gedung Cyber 2, Lt. 15",
          "city": "Jakarta Selatan",
          "state": "DKI Jakarta",
          "zip": "12950",
          "country": "Indonesia",
          "type": "WORK"
        }
      ],
      "emails": [
        {
          "email": "support@kirem.id",
          "type": "WORK"
        }
      ],
      "name": {
        "formatted_name": "Kirem Support",
        "first_name": "Kirem",
        "last_name": "Support"
      },
      "org": {
        "company": "Kirem Indonesia",
        "department": "Developer Support"
      },
      "phones": [
        {
          "phone": "+62812345678",
          "type": "WORK",
          "wa_id": "62812345678"
        }
      ],
      "urls": [
        {
          "url": "https://kirem.id",
          "type": "WORK"
        }
      ]
    }
  ]
}

Penjelasan Parameter:

  • type (String - Wajib): Set nilai ke "contacts".
  • contacts (Array - Wajib): Daftar objek kontak yang dikirim (bisa mengirim beberapa kontak sekaligus):
    • name (Object - Wajib): Nama kontak. Terdiri dari formatted_name (nama lengkap tampilan), first_name (nama depan), dan last_name (nama belakang).
    • phones (Array - Opsional): Daftar nomor telepon. Parameter phone harus diisi format lengkap internasional dan wa_id diisi ID WhatsApp terkait (nomor tanpa tanda +). type menentukan label telepon (misal: "WORK", "HOME", "CELL").
    • emails (Array - Opsional): Daftar email kontak beserta tipe labelnya.
    • addresses (Array - Opsional): Detail alamat lengkap kontak.
    • org (Object - Opsional): Informasi organisasi/perusahaan kontak. Terdiri dari company (nama perusahaan) dan department (divisi).
    • urls (Array - Opsional): Daftar tautan website terkait.

🚦 3. Format Respons API

Respons Sukses (201 Created)

{
  "status": 201,
  "message": "Message sent successfully",
  "data": {
    "messaging_product": "whatsapp",
    "contacts": [{"input": "62812345678", "wa_id": "62812345678"}],
    "messages": [{"id": "wamid.HBgLNjI4MTIzNDU2NzhGFgQ0NDMzMzc3RUQ1OEFG"}]
  }
}
  • messages[0].id: ID pesan untuk memantau status pengantaran via webhook.
  • WhatsApp akan otomatis menampilkan tombol "Tambah Kontak" (Add Contact) atau "Kirim Pesan" (Message) langsung di layar ponsel pelanggan ketika menerima pesan vCard ini.

Butuh bantuan integrasi lanjutan?

Hubungi tim developer Kirem melalui tiket bantuan.

Buka Tiket Bantuan