Pular para o conteúdo principal
GET
Número com conta no aplicativo?

Conceituação

Este método retorna se o número tem ou não conta no aplicativo.
Utilize essa API sempre que quiser verificar se um número possui conta no aplicativo, 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

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

Query Parameters

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

Response

200

boolean
Indica se o número possui conta no aplicativo
string
Número formatado conforme resposta do aplicativo
string
Identificador único privado do aplicativo (null se exists = false)

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