Pular para o conteúdo principal
GET
/
instances
/
{instanceId}
/
token
/
{token}
/
phone-exists
/
{phone}
Número com WhatsApp?
curl --request GET \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/phone-exists/{phone} \
  --header 'Client-Token: <api-key>'
{
  "exists": true,
  "phone": "<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

Este método retorna se o número tem ou não WhatsApp.
Utilize essa API sempre que quiser verificar se um número possui WhatsApp, geralmente para validação de formulários. Não utilize essa API caso queira fazer uma verificação 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.

​
Query Parameters

​
phone
string
obrigatório
Telefone do contato no formato DDI DDD NÚMERO. Ex: 551199999999

​
Response

​
200

​
exists
boolean
Indica se o número possui WhatsApp
​
phone
string
Número formatado conforme resposta do WhatsApp
​
lid
string
Identificador único privado do WhatsApp (null se exists = false)
[
  {
    "exists": true,
    "phone": "5544999999999",
    "lid": "999999999@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”.