Orientações sobre o produto
O tipo de serviço ws_avatar: referência de requisição, resposta e campos
Uma referência campo a campo do tipo de serviço ws_avatar do WA Lookup: o contrato de requisição síncrona, os campos da resposta e o que avatar e avatar_url contêm.
O WA Lookup expõe suas verificações do WhatsApp por meio de uma única chamada síncrona, e o valor de service_type decide qual verificação é executada. Esta é a referência campo a campo da variante ws_avatar.
Para executar uma verificação de avatar do WhatsApp com o WA Lookup, envie POST /api/v1/check com o cabeçalho X-API-Key e um corpo JSON {"service_type": "ws_avatar", "identifier": "<E.164 number>"}. A resposta retorna os campos padrão da verificação, além de um booleano avatar e de uma string avatar_url; avatar_url é uma string vazia quando não há URL disponível.
O contrato de requisição
O WA Lookup documenta uma única chamada síncrona, POST /api/v1/check, enviada com o cabeçalho X-API-Key e Content-Type: application/json. O corpo leva exatamente dois valores: service_type, que seleciona a verificação, e identifier, que deve ser o número de telefone no formato E.164. Enviar um número em formato local é a causa mais comum de falhas evitáveis, então normalize antes de enviar.
Os campos da resposta que você sempre recebe
Para uma verificação do WhatsApp concluída, o data retornado contém service_type, identifier e registered; ws_avatar também inclui avatar e avatar_url, enquanto ws_business inclui business. Campos internos de registro, transação, status e cobrança não são retornados.
Os dois campos que ws_avatar acrescenta
Escolher service_type=ws_avatar acrescenta um booleano avatar e uma string avatar_url. O booleano avatar informa se um avatar foi detectado. O campo avatar_url está sempre presente em uma resposta ws_avatar bem-sucedida e é uma string vazia quando não há URL disponível. Mantenha-o separado do booleano avatar, porque os dois campos respondem a perguntas diferentes.
Tudo chega em uma única resposta
Como a chamada é síncrona, os campos de registro e de avatar voltam na mesma resposta HTTP da requisição. Não há identificador de job para armazenar nem rota de status para consultar periodicamente, o que mantém a integração em uma única chamada e um único caminho de erro. Código escrito para uma API baseada em consulta periódica geralmente tem uma estrutura que pode simplesmente ser removida aqui.
Perguntas frequentes
Como devo tratar avatar_url?
O campo avatar_url está sempre presente em uma resposta ws_avatar bem-sucedida. Armazene uma string vazia como “nenhuma URL disponível”; não a use como substituta do booleano avatar.
Qual formato de número identifier exige?
E.164. Normalizar antes do envio evita a categoria mais comum de verificações com falha.
Preciso de uma segunda chamada para obter o status de registro?
Não. ws_avatar retorna o campo de registro junto com os campos de avatar na mesma resposta.