Skip to main content
POST
/
wa
/
instances
/
{instance_id}
/
recipients
/
batch
Existência de Destinatário (Batch)
curl --request POST \
  --url https://api.zapsterapi.com/v1/wa/instances/{instance_id}/recipients/batch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "recipients": [
    "<string>"
  ]
}
'
[
  {
    "id": "<string>",
    "is_business": true,
    "exists": true,
    "error": {
      "code": "recipient_not_found",
      "message": "The specified recipient could not be found."
    },
    "name": "<string>",
    "profile_picture": "https://zapsterapi.s3.us-east-1.amazonaws.com/...",
    "original": "551112341234"
  }
]

​
Introdução

Este endpoint é similar ao Verificação de Número, mas permite a verificação de até 100 números em uma única requisição, o que é ideal para quando você precisa verificar a existência de múltiplos números de WhatsApp de forma eficiente. Para garantir o melhor uso dessa rota, por favor, consulte os Pontos de Atenção, onde explicamos algumas nuances importantes sobre o name e profile_picture.

​
Como funciona?

A resposta desse endpoint será sempre uma lista de objetos, onde cada objeto representará o status de um número enviado na requisição. Cada número consultado será avaliado quanto à sua existência no WhatsApp e se o número corresponde a uma conta de WhatsApp Business. Além disso, caso o número seja inválido ou não encontrado, a resposta fornecerá detalhes sobre o erro. Vamos supor que você informe dois números para a consulta. Se um dos números existir e o outro não, a resposta será algo parecido com o seguinte exemplo:
Exemplo de Resposta
[
  {
    "exists": true,
    "id": "551112341234",
    "is_business": false,
    "original": "551112341234",
    "profile_picture": "https://zapsterapi.s3.us-east-1.amazonaws.com/..."
  },
  {
    "error": {
      "code": "recipient_not_found",
      "message": "The specified recipient could not be found."
    },
    "exists": false,
    "original": "5511998765432"
  }
]

​
Diferença entre original e id

Em alguns casos, o número informado na lista de consulta pode ser ajustado pelo WhatsApp. Isso geralmente acontece devido a variações regionais, como a inclusão ou exclusão do nono dígito para números de celular no Brasil. O campo original serve para garantir que você veja exatamente o número que foi enviado na sua requisição, enquanto o campo id mostra o número que o WhatsApp conseguiu encontrar após eventuais ajustes.

​
Como Funciona?

  • original: É o número exatamente como você o enviou na requisição, sem nenhuma alteração.
  • id: É o número ajustado ou resolvido pelo WhatsApp, que pode ser diferente do original caso o WhatsApp tenha encontrado uma versão corrigida.
A seguir, mostramos três exemplos que ilustram diferentes cenários de consulta de números, usando os campos original e id. 
{
  "exists": true
  "id": "5511998765432",
  "original": "5511998765432",
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
instance_id
string
required

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

Body

application/json
​
recipients
string[]

Response

200 - application/json

Success

​
id
string
required

ID ou número do destinatário

​
is_business
boolean
required

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

​
exists
boolean

true se o número existir e false em caso de erro ou número inexistente.

​
error
object

Em caso de erro ou número não encontrado, este objeto estará presente com mais detalhes sobre o erro.

​
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.

Example:

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

​
original
string

Este campo sempre contém o número exatamente como foi enviado na lista de consulta, sem alterações. Em algumas situações, o número que você fornece pode ser ajustado pelo WhatsApp durante a verificação. Um exemplo comum é a questão do nono dígito em números antigos no Brasil: antes, muitos números de celular não possuíam esse dígito adicional. Ao consultar um número com o nono dígito, como XYZ, o WhatsApp pode retornar a versão ajustada, XY, que é a versão correta sem o dígito extra.

Portanto, o campo original reflete o número exato que você informou, enquanto o campo id na resposta mostrará o número que o WhatsApp reconheceu e encontrou, caso haja ajustes.

Example:

"551112341234"