O endpoint principal para acessar os dados do WhatsApp é:
/get-whatsapp
Todas as requisições devem ser feitas utilizando o método GET.
token
: Seu token de API exclusivo. Você
pode encontrar e gerenciar seus tokens no seu dashboard de
usuário. phone
: O número de telefone para o qual
você deseja buscar os dados. Formato internacional, sem espaços ou caracteres especiais (ex:
5511999999999
). A API é protegida por autenticação baseada em token. Você deve
incluir o parâmetro token
na query string de cada requisição.
Aqui está um exemplo de como fazer uma requisição utilizando curl
:
curl "http://166.0.197.75:3000/get-whatsapp?token=SEU_TOKEN&phone=5511999999999"
Ou diretamente no navegador:
http://166.0.197.75:3000/get-whatsapp?token=SEU_TOKEN&phone=5511999999999
Substitua SEU_TOKEN
pelo seu token de API real e 5511999999999
pelo número de telefone desejado.
JSON
)Em caso de sucesso, a API retornará uma resposta em formato JSON
com os seguintes campos:
{ "imagem": "URL_DA_IMAGEM_DE_PERFIL_DO_WHATSAPP", "status": "STATUS_DO_WHATSAPP_DO_USUARIO", "plan": "NOME_DO_SEU_PLANO", "requests_remaining": "REQUISIÇÕES_RESTANTES_NO_PLANO" }
imagem
: URL direta para a imagem de
perfil do WhatsApp do número de telefone fornecido. Se a imagem não estiver disponível (por
privacidade ou inexistência), pode retornar uma imagem padrão ou um erro.status
: O "About" ou "Status" do
WhatsApp do usuário, se disponível publicamente. Pode retornar um objeto de erro se não
disponível.plan
: O plano de API do seu token
atual.requests_remaining
: O número de
requisições que você ainda pode fazer dentro do seu plano atual.Os seguintes planos estão disponíveis com os respectivos limites de requisição:
Você pode restringir o uso do seu token a um IP específico configurando o "Allowed IP" no seu dashboard de usuário. Se configurado, apenas requisições originadas do IP permitido serão aceitas.
phone
ausente).