Pular para o conteúdo principal
GET
/
wa
/
instances
/
{instance_id}
/
recipients
/
{recipient}
Existência de Destinatário
curl --request GET \
  --url https://api.zapsterapi.com/v1/wa/instances/{instance_id}/recipients/{recipient} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "is_business": true,
  "name": "<string>",
  "profile_picture": "https://zapsterapi.s3.us-east-1.amazonaws.com/..."
}

​
Introdução

Este endpoint permite verificar a existência de um destinatário em uma determinada instância do WhatsApp. A API retorna informações básicas sobre o destinatário, como o ID, se é uma conta comercial, o nome e a URL da foto de perfil. Esse endpoint é útil para garantir que o número fornecido está registrado e ativo na plataforma, antes de enviar mensagens ou realizar outras operações.

​
Casos de Uso

  • Validação antes de envio de mensagens: Antes de enviar uma mensagem a um destinatário, verifique se o número existe e está registrado no WhatsApp para evitar erros e falhas no envio.
  • Validação em formulários: Utilize este endpoint para validar números de telefone inseridos por usuários em formulários. Antes de permitir que o usuário prossiga, a aplicação pode verificar se o número inserido está registrado no WhatsApp, garantindo que os dados fornecidos são válidos e que o destinatário é alcançável via WhatsApp.

​
Pontos de Atenção

O campo name nem sempre estará presente na resposta da API. Isso ocorre devido a uma limitação técnica onde a Zapster só consegue armazenar em cache o nome do contato se ele tiver conversado pelo menos uma vez com a instância. Se o contato nunca conversou, este campo estará ausente.
O campo profile_picture retornará null em dois casos: se o contato tiver configurado a foto de perfil como privada ou se não houver nenhuma foto de perfil atribuída.

Autorizações

​
Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parâmetros de caminho

​
instance_id
string
obrigatório

Obrigatório se instance_id não estiver presente no body.

​
recipient
string
obrigatório

Número do destinatário para verificação de existência.

Resposta

200 - application/json

Success

​
id
string
obrigatório

ID ou número do destinatário

​
is_business
boolean
obrigatório

Define se o recipient informado é um perfil do tipo business ou normal.

​
name
string

Nome presente no perfil do destinatário.

​
profile_picture
string<uri> | null

Foto de perfil do destinatário. Se a recuperação da foto não for possível, então o valor desse campo será null.

Exemplo:

"https://zapsterapi.s3.us-east-1.amazonaws.com/..."