Pular para o conteúdo principal
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
phone-exists-batch
Verificação em lote
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/phone-exists-batch \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phones": [
    {}
  ]
}
'
{
  "exists": true,
  "inputPhone": "<string>",
  "outputPhone": "<string>",
  "lid": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://developer.z-api.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Conceituação

Diferente do método anterior que valida individualmente se um número possui WhatsApp através de uma requisição GET, essa API oferece uma verificação em lote.
Máximo de 50.000 validações por requisição.
Utilize essa API para validação de formulários. Não é recomendado utilizar esta API para verificar a existência do número antes de enviar uma mensagem, pois o Z-API já valida a existência do número a cada mensagem enviada.

​
Atributos

​
instanceId
string
obrigatório
ID da sua instância. Disponível no painel Z-API em Instâncias.
​
token
string
obrigatório
Token da sua instância Z-API.

​
Body

​
phones
array
obrigatório
Lista de números de telefone no formato DDI DDD NÚMERO. Ex: 551199999999

​
Request Body

{
  "phones": ["554499999999", "554488888888"]
}

​
Response

​
200

​
exists
boolean
Indica se o número possui WhatsApp
​
inputPhone
string
Número enviado na requisição
​
outputPhone
string
Número formatado conforme resposta do WhatsApp
​
lid
string
Identificador único privado do WhatsApp (null se exists = false)
[
  {
    "exists": true,
    "inputPhone": "554499999999",
    "outputPhone": "554499999999",
    "lid": "999999999999999@lid"
  }
]

​
405

Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no início deste tópico.

​
415

Caso você receba um erro 415, certifique de adicionar na headers da requisição o “Content-Type” do objeto que você está enviando, em sua grande maioria “application/json”.