Produktleitfaden
Der Service-Typ ws_avatar: Referenz zu Anfrage, Antwort und Feldern
Eine Feldreferenz zum Service-Typ ws_avatar von WA Lookup: der synchrone Anfragevertrag, die Antwortfelder und was avatar und avatar_url enthalten.
WA Lookup stellt seine WhatsApp-Prüfungen über einen einzigen synchronen Aufruf bereit, und der Wert von service_type entscheidet, welche Prüfung ausgeführt wird. Dies ist die Referenz auf Feldebene für die Variante ws_avatar.
Um mit WA Lookup eine WhatsApp-Avatar-Prüfung durchzuführen, senden Sie POST /api/v1/check mit dem Header X-API-Key und einem JSON-Body {"service_type": "ws_avatar", "identifier": "<E.164 number>"}. Die Antwort liefert die Standard-Prüffelder sowie einen booleschen Wert avatar und einen String avatar_url; avatar_url ist ein leerer String, wenn keine URL verfügbar ist.
Der Anfragevertrag
WA Lookup dokumentiert einen einzigen synchronen Aufruf, POST /api/v1/check, der mit dem Header X-API-Key und Content-Type: application/json gesendet wird. Der Body enthält genau zwei Werte: service_type, der die Prüfung auswählt, und identifier, der die Telefonnummer im E.164-Format sein muss. Die Übermittlung einer Nummer im lokalen Format ist die häufigste Ursache vermeidbarer Fehler; normalisieren Sie daher vor dem Senden.
Die Antwortfelder, die Sie immer erhalten
Bei einer abgeschlossenen WhatsApp-Prüfung enthält das zurückgegebene data die Felder service_type, identifier und registered; ws_avatar enthält zusätzlich avatar und avatar_url, während ws_business das Feld business enthält. Interne Datensatz-, Transaktions-, Status- und Abrechnungsfelder werden nicht zurückgegeben.
Die zwei Felder, die ws_avatar ergänzt
Mit service_type=ws_avatar kommen ein boolescher Wert avatar und ein String avatar_url hinzu. Der boolesche Wert avatar gibt an, ob ein Avatar erkannt wurde. Das Feld avatar_url ist in einer erfolgreichen ws_avatar-Antwort immer vorhanden und ein leerer String, wenn keine URL verfügbar ist. Halten Sie es vom booleschen Wert avatar getrennt, denn die beiden Felder beantworten unterschiedliche Fragen.
Alles kommt in einer Antwort
Da der Aufruf synchron ist, kommen die Registrierungs- und Avatar-Felder in derselben HTTP-Antwort wie die Anfrage zurück. Es gibt keine Job-ID zu speichern und keine Statusroute abzufragen, sodass die Integration auf einen einzigen Aufruf und einen einzigen Fehlerpfad beschränkt bleibt. Code, der für eine Polling-API geschrieben wurde, enthält meist Strukturen, die hier einfach entfernt werden können.
FAQ
Wie sollte ich mit avatar_url umgehen?
Das Feld avatar_url ist in einer erfolgreichen ws_avatar-Antwort immer vorhanden. Speichern Sie einen leeren String als „keine URL verfügbar“; verwenden Sie ihn nicht als Ersatz für den booleschen Wert avatar.
Welches Nummernformat verlangt identifier?
E.164. Eine Normalisierung vor der Übermittlung vermeidet die häufigste Kategorie fehlgeschlagener Prüfungen.
Benötige ich einen zweiten Aufruf, um den Registrierungsstatus zu erhalten?
Nein. ws_avatar liefert das Registrierungsfeld zusammen mit den Avatar-Feldern in derselben Antwort.