Jenis Layanan ws_avatar: Referensi Permintaan, Respons, dan Field

WA Lookup menyediakan pemeriksaan WhatsApp melalui satu panggilan sinkron, dan nilai service_type menentukan pemeriksaan mana yang dijalankan. Ini adalah referensi tingkat field untuk varian ws_avatar.

Untuk menjalankan pemeriksaan avatar WhatsApp dengan WA Lookup, kirim POST /api/v1/check dengan header X-API-Key dan body JSON {"service_type": "ws_avatar", "identifier": "<E.164 number>"}. Respons mengembalikan field pemeriksaan standar ditambah boolean avatar dan string avatar_url; avatar_url berupa string kosong jika URL tidak tersedia.

Kontrak permintaan

WA Lookup mendokumentasikan satu panggilan sinkron, POST /api/v1/check, yang dikirim dengan header X-API-Key dan Content-Type: application/json. Body membawa tepat dua nilai: service_type, yang memilih pemeriksaan, dan identifier, yang harus berupa nomor telepon dalam format E.164. Mengirim nomor dalam format lokal adalah penyebab paling umum dari kegagalan yang sebenarnya dapat dihindari, jadi lakukan normalisasi sebelum mengirim.

Field respons yang selalu Anda dapatkan

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. Field internal untuk catatan, transaksi, status, dan penagihan tidak dikembalikan.

Dua field yang ditambahkan ws_avatar

Memilih service_type=ws_avatar menambahkan boolean avatar dan string avatar_url. Boolean avatar melaporkan apakah avatar terdeteksi. Field avatar_url selalu ada dalam respons ws_avatar yang berhasil dan berupa string kosong jika URL tidak tersedia. Pisahkan field ini dari boolean avatar karena kedua field tersebut menjawab pertanyaan yang berbeda.

Semuanya tiba dalam satu respons

Karena panggilannya sinkron, field registrasi dan avatar dikembalikan dalam respons HTTP yang sama dengan permintaan. Tidak ada identifier job yang perlu disimpan dan tidak ada rute status yang perlu di-polling, sehingga integrasi cukup dengan satu panggilan dan satu jalur error. Kode yang ditulis untuk API berbasis polling biasanya memiliki struktur yang di sini bisa langsung dihapus.

FAQ

Bagaimana cara menangani avatar_url?

Field avatar_url selalu ada dalam respons ws_avatar yang berhasil. Simpan string kosong sebagai “URL tidak tersedia”; jangan menggunakannya sebagai pengganti boolean avatar.

Format nomor apa yang diwajibkan untuk identifier?

E.164. Normalisasi sebelum pengiriman menghindari kategori pemeriksaan gagal yang paling umum.

Apakah saya memerlukan panggilan kedua untuk mendapatkan status registrasi?

Tidak. ws_avatar mengembalikan field registrasi bersama field avatar dalam respons yang sama.