Mengintegrasikan WA Lookup API untuk Pengayaan Profil WhatsApp

Panduan teknis bagi developer untuk menerapkan pencarian profil dan avatar WhatsApp secara sinkron menggunakan WA Lookup API.

WA Lookup API menyediakan antarmuka REST sinkron yang membantu developer mengotomatiskan pengayaan profil WhatsApp. Dengan mengirim permintaan POST ke endpoint /api/v1/check beserta jenis layanan tertentu—ws, ws_avatar, atau ws_business—dan nomor telepon berformat E.164, API langsung mengembalikan sinyal keberadaan akun di dalam respons HTTP. Sinyal ini mencakup status pendaftaran, ketersediaan avatar, URL avatar, dan indikator akun bisnis, yang dapat menjadi masukan untuk perutean CRM, segmentasi audiens, dan alur kerja pendukung keputusan internal.

Pengenalan WA Lookup API

Saat mengintegrasikan saluran komunikasi ke dalam alur kerja bisnis, tim teknis membutuhkan sinyal keberadaan akun yang akurat untuk menjadi dasar logika perutean dan segmentasi. WA Lookup menyediakan pemeriksaan tunggal dan batch kecil secara sinkron untuk status pendaftaran WhatsApp, ketersediaan avatar, dan status akun Business. Endpoint tunggal memeriksa satu identifier, sedangkan endpoint multi sinkron menerima hingga 100 identifier; keduanya mengembalikan data dalam respons HTTP yang sama. Arsitektur sinkron ini mendukung pengambilan keputusan seketika tanpa webhook asinkron, infrastruktur polling, atau antrean pemrosesan batch. Penting untuk memahami batasan sinyal keberadaan akun ini. Hasil terdaftar melaporkan kolom status WhatsApp yang tersedia tepat pada saat pemeriksaan. Hasil ini tidak melaporkan kehadiran langsung (online), riwayat pesan, persetujuan pengguna, atau apakah nomor tersebut saat ini dapat dihubungi. Sebaliknya, hasil ini berkontribusi pada alur kerja yang lebih luas, membantu tim meninjau data dan memprioritaskan penjangkauan berdasarkan keberadaan di platform.

Memahami Jenis Layanan

WA Lookup API menggabungkan kemampuannya ke dalam satu endpoint sinkron. Developer menentukan sinyal profil mana yang diambil—dan biaya saldo mana yang berlaku—dengan mengubah parameter service_type di payload permintaan. API mendukung tiga jenis layanan yang berbeda:

• WhatsApp Checker (ws): Ini adalah jenis layanan dasar. Cakupannya terbatas pada memastikan apakah nomor telepon yang dikirim terdaftar di WhatsApp. Layanan ini memberikan sinyal pendaftaran platform dasar.
• WhatsApp Avatar Checker (ws_avatar): Jenis layanan ini memperluas pemeriksaan dasar dengan pengayaan profil. Selain memeriksa pendaftaran WhatsApp, layanan ini memeriksa ketersediaan avatar dan mengembalikan kolom avatar_url. Kolom URL tersebut kosong jika tidak ada URL yang tersedia.
• WhatsApp Business Checker (ws_business): Jenis layanan ini dirancang untuk alur kerja B2B. Layanan ini memeriksa pendaftaran WhatsApp standar dan juga menentukan apakah akun tersebut menggunakan WhatsApp Business, sehingga memberikan sinyal profil bisnis yang spesifik.

Dengan memilih jenis layanan yang tepat, manajer produk teknis dapat menyesuaikan keluaran API dengan kebutuhan alur kerja mereka secara persis, sehingga mereka hanya meminta dan menggunakan data yang diperlukan untuk kasus penggunaan tertentu.

Implementasi Teknis

Integrasi WA Lookup API mengharuskan kepatuhan pada kontrak permintaan JSON dan aturan format yang ketat. Semua interaksi dilakukan melalui endpoint POST /api/v1/check. Untuk mengautentikasi dan memformat permintaan dengan benar, developer wajib menyertakan header tertentu: header X-API-Key yang berisi kunci API aktif, dan header Content-Type: application/json. Body JSON permintaan harus berisi tepat dua kolom:

1. service_type: Nilai string "ws", "ws_avatar", atau "ws_business".
2. identifier: Nomor telepon target yang dikirim secara ketat dalam format E.164.

Format E.164 adalah rencana penomoran telepon internasional yang memastikan nomor telepon tidak ambigu secara global. Nomor berformat E.164 harus diawali tanda plus (+), langsung diikuti kode negara dan nomor pelanggan, tanpa spasi, tanda hubung, atau tanda kurung (misalnya +17253100591). Jika format E.164 tidak digunakan, pemeriksaan tidak akan berhasil. Karena API sepenuhnya sinkron, koneksi HTTP tetap terbuka selama pemeriksaan berlangsung, dan hasilnya dikirim dalam respons HTTP seketika.

Menafsirkan Respons API

WA Lookup API mengembalikan sekumpulan kolom yang dapat diprediksi di setiap respons pemeriksaan, dengan kolom tambahan yang disertakan sesuai service_type yang dipilih. Untuk pemeriksaan WhatsApp yang selesai, data yang dikembalikan berisi service_type, identifier, dan registered. ws_avatar juga menyertakan avatar dan avatar_url, sedangkan ws_business menyertakan business; kolom internal terkait catatan, transaksi, status, dan penagihan tidak dikembalikan. Jika service_type diatur ke ws, hasil hanya menyertakan kolom registered bersama service_type dan identifier yang dikembalikan sesuai yang dikirim. Jika service_type diatur ke ws_avatar, skema respons diperluas dengan kolom avatar (boolean yang menunjukkan apakah avatar dipasang) dan kolom avatar_url. avatar_url berupa string kosong jika tidak ada URL yang tersedia. Jika service_type diatur ke ws_business, skema respons menambahkan kolom business, yaitu boolean yang menunjukkan apakah nomor terdaftar tersebut terkait dengan akun WhatsApp Business.

Dasbor dan Pengelolaan Penggunaan

Pengelolaan penggunaan API dan pemantauan masukan alur kerja dilakukan melalui dasbor platform. Dasbor menyediakan dukungan menyeluruh untuk pengelolaan kunci API, sehingga developer dapat membuat dan merotasi kunci yang diperlukan untuk header X-API-Key secara aman. Untuk pengawasan operasional, dasbor menyertakan fitur untuk melacak saldo, meninjau riwayat pemeriksaan, dan mengakses laporan tingkat produk. Tim teknis dapat memantau pemeriksaan terbaru, menganalisis pemakaian saldo, dan melihat aktivitas akun untuk memahami pola penggunaan serta mengoptimalkan integrasi mereka. Tinjau saldo dan riwayat pemeriksaan di dasbor; lihat halaman harga dan dokumentasi API untuk aturan penagihan yang berlaku saat ini.

FAQ

Apakah WA Lookup API bersifat sinkron?

Ya. Endpoint real-time bersifat sinkron: hasil dikembalikan dalam respons HTTP yang sama dengan permintaan awal. Endpoint nomor tunggal memeriksa satu identifier, dan endpoint multi sinkron menerima hingga 100 identifier tanpa job, callback, atau polling. Daftar yang lebih besar ditangani oleh produk massal asinkron terpisah, tempat Anda mengunggah file dan mengunduh hasilnya kemudian.

Apa perbedaan antara jenis layanan ws dan ws_avatar?

Jenis layanan ws hanya mengembalikan sinyal pendaftaran WhatsApp dasar. Jenis layanan ws_avatar mengembalikan sinyal pendaftaran dan juga memeriksa ketersediaan avatar, dengan mengembalikan string avatar_url yang kosong jika tidak ada URL yang tersedia.

Format apa yang harus diikuti nomor telepon?

Semua nomor telepon yang dikirim ke API harus diformat sesuai standar E.164. Artinya, nomor diawali tanda plus (+), diikuti kode negara dan nomor pelanggan, tanpa spasi atau karakter khusus.