Kontak

/v1/contacts

Gunakan node contacts untuk mengelola pengguna WhatsApp di database Anda dengan memvalidasi mereka sebelum mengirim pesan dan memverifikasi identitas pengguna dengan hash identitas.

Dengan node contacts, Anda bisa:

• Memverifikasi apakah nomor telepon dalam database Anda merupakan milik akun WhatsApp yang valid. Anda harus memastikan status adalah valid sebelum Anda dapat mengirimkan pesan kepada pengguna.
• Mendapatkan ID WhatsApp untuk suatu nomor telepon. ID WhatsApp diperlukan untuk mengirim pesan dan notifikasi pengguna.

Sebelum Memulai

Anda harus memberikan opsi kepada pelanggan Anda untuk ikut serta dalam komunikasi WhatsApp dengan bisnis Anda. Alur keikutsertaan ini dikelola oleh bisnis Anda. Setelah pelanggan memutuskan untuk ikut serta, gunakan node contacts untuk memvalidasi nomor yang terdaftar. Lihat Memahami Cara Mendapatkan Langganan untuk WhatsApp untuk informasi selengkapnya.

Batasan

• Gunakan endpoint ini untuk memverifikasi bahwa nomor telepon dalam database bisnis milik akun WhatsApp yang valid
• Jumlah panggilan tidak boleh melebihi jumlah pesan yang dikirimkan oleh nomor telepon

Penegakan

Jika bisnis menyalahgunakan endpoint, tindakan berikut akan diambil:

• Semua admin yang terdaftar di Pengelola Bisnis akan menerima peringatan awal melalui email jika diduga ada penyalahgunaan
• Bisnis akan memiliki tujuh hari setelah menerima peringatan untuk menyesuaikan perilaku mereka
• Jika setelah tujuh hari panggilan tidak disesuaikan, nomor telepon akan dinonaktifkan secara permanen

Rekomendasi

Kami rekomendasikan untuk memeriksa kontak sebelum mengirim pesan. Akan tetapi, Anda tidak perlu memeriksa kontak untuk menanggapi pesan pelanggan yang masuk. Anda dapat segera menanggapinya menggunakan wa_id. Tidak ada biaya tambahan karena hasilnya disimpan dalam cache.

Membuat

Sebelum mengirim pesan ke pengguna yang telah menyetujui ikut serta, kirim permintaan POST ke endpoint /v1/contacts untuk membuat permintaan validasi pengguna akun WhatsApp. Dalam panggilan Anda, sertakan daftar nomor telepon yang ingin divalidasi.

Contoh

POST /v1/contacts
{
  "blocking": "wait" | "no_wait",
  "contacts": [
  	"16315551000",
  	"+1 631 555 1001",
  	"6315551002",
  	"+1 (631) 555-1004",
  	"1-631-555-1005"
  ],
  "force_check": false | true
}

Anda akan menerima tanggapan dengan status saat ini dari nomor yang diminta dan ID WhatsApp mereka (wa_id):

{
  "contacts": [ {
    "wa_id": "16315551000",
    "input": "16315551000",
    "status": "valid"
  },
  {
    "wa_id": "16315551001",
    "input": "+1 631 555 1001",
    "status": "processing" # Only applicable when request is non-blocking
  },
  {
    "input": "6315551002",
    "status": "invalid"
  },
  {
    "input": "+163155588",
    "status": "failed"
  }
}

Simpan ID WhatsApp untuk nomor-nomor yang mengembalikan statusvalid. Pengguna yang valid adalah yang memiliki akun WhatsApp. Gunakan ID WhatsApp untuk mengirim pesan dan notifikasi.

Ulangi langkah ini secara berkala untuk mengelola daftar pengguna valid Anda. Hasil disimpan dalam cache database klien API WhatsApp Business di Tempat selama 7 hari.

Parameter

Parameter berikut didukung untuk panggilan POST ke /v1/contacts:

Edge

Edge berikut terhubung ke node ini:

Pemblokiran

Terdapat dua opsi untuk parameter blocking: no_wait dan wait. Jika parameter blocking tidak ditentukan dalam sebuah panggilan, maka no_wait secara default.

Parameter blocking menentukan apakah permintaan harus menunggu pemrosesan selesai (sinkron) atau tidak (asinkron).

Format Nomor Telepon

Nomor telepon dalam permintaan contacts bisa dalam format yang dapat dihubungi.

Berikut beberapa contoh yang menunjukkan perilaku ini, dengan asumsi bahwa klien API WhatsApp Business di Tempat didaftarkan dengan nomor telepon India (kode negaranya +91):

Kolom yang Ditampilkan

Muatan tanggapan contacts berisi array nomor telepon yang sama, dikirim dalam permintaan dengan properti input, status, dan wa_id:

Bersama dengan status processing, Anda seharusnya akan melihat status HTTP 200 OK.

Jika pesan template dikirim ke nomor telepon tanpa akun WhatsApp, Anda akan menerima pesan kesalahan yang menandakan “Pengguna tidak valid" dengan kode kesalahan 1013.

Jika ada kesalahan lainnya dalam tanggapan, lihat Pesan Kesalahan dan Status.

Memblokir Kontak

Memblokir dapat dianggap sebagai fitur pertahanan untuk menghentikan pelaku kejahatan dari melanjutkan tindakan berbahaya. Untuk memblokir kontak, mereka harus mengirimi Anda pesan dalam 24 jam terakhir.

Contoh

Kirim panggilan API ke /v1/contacts/{phone_number}/block dengan alasan untuk memblokir akun WhatsApp lain.

POST /v1/contacts/+16315551000/block
{
   "reason": "Optional string(0;60). Freeform block reason. Will be used when another WhatsApp account is being blocked"
}

Tanggapan yang berhasil memiliki status 200 dan tidak ada objek "kesalahan".

Tanggapan kegagalan akan terlihat seperti ini:

{   
    "errors": [
        {
            "code": 2048,
            "title": "Not engaged contact",
            "details": "Invalid Request. This contact hasn't engaged with you in the last 24 hrs."
        }
    ]
}

Parameter

Parameter berikut didukung untuk panggilan POST ke /v1/contacts/{phone_number}/block:

Membuka Blokir Kontak

Lakukan panggilan ini untuk membuka blokir kontak

Contoh

Kirim panggilan API ke /v1/contacts/{phone_number}/unblock

POST /v1/contacts/+16315551000/unblock

Tanggapan yang berhasil memiliki status 200 dan tidak ada objek "kesalahan".

Tanggapan kegagalan akan terlihat seperti ini:

{   
    "errors": [
        {
            "code": 1009,
            "title": "Parameter value is not valid",
            "details": "Provided WhatsApp ID is not valid. Please provide a valid WhatsApp ID or a phone number with a country code"
        }
    ]
}

Parameter

Parameter berikut didukung untuk panggilan POST ke /v1/contacts/{phone_number}/unblock:

Daftar Blokir

Inilah cara Anda mendapatkan daftar kontak yang Anda blokir.

Contoh

Kirim panggilan API ke /v1/contacts/blocklist untuk menerima halaman daftar kontak yang Anda blokir

GET /v1/contacts/blocklist?limit=10&offset=0

Anda akan menerima jawaban dengan halaman daftar blokir Anda bersama dengan info paginasi

{
   "contacts": [
       {
           "wa_id": "16315551000@s.whatsapp.net"
       }
   ],
   "pagination": {
       "limit": 10,
       "offset": 0,
       "total": 1
   }
}

Parameter

Parameter berikut didukung untuk panggilan GET ke /v1/contacts/blocklist:

Pelaporan

Pelaporan memberikan sinyal penting untuk membangun solusi pencegahan terhadap pelaku kejahatan. Sebelum melaporkan kontak, mereka harus mengirimi Anda pesan dalam 24 jam terakhir.

Contoh

Kirim panggilan API ke /v1/contacts/{phone_number}/report berisi alasan jika Anda memblokir akun WhatsApp lain.

POST /v1/contacts/+16315551000/block
{
   "reason": "Optional string(0;60). Freeform block reason. Will be used when another WhatsApp account is being blocked",
   "block": "true | false optional boolean with default of false",
   "message_id": "message-id. Optional reported message id"
}

Tanggapan yang berhasil memiliki status 200 dan tidak ada objek "kesalahan".

Tanggapan kegagalan akan terlihat seperti ini:

{  
    "errors": [
        {
            "code": 2048,
            "title": "Not engaged contact",
            "details": "Invalid Request. This contact hasn't engaged with you in the last 24 hrs."
        }
    ]
}

Parameter

Parameter berikut didukung untuk panggilan POST ke /v1/contacts/{phone_number}/report: