Verificar números

POST/v1/instances/{id}/check-numbersdesde M2token da instância ou admin

Quando usar

Diz quais números têm WhatsApp e devolve o jid que o WhatsApp usa (no Brasil, com ou sem o 9º dígito). De 1 a 10 números por chamada (10 a 15 dígitos com DDI). Resultados ficam em cache (30 dias para quem tem, 24h para quem não tem). Consultas não cacheadas: até 10 por minuto e 200 por dia (UTC) por instância; acima disso 429 rate_limited.

Autenticação

Aceita o token da instância (só a própria instância) ou o token admin. Um token de outra instância recebe 403 forbidden (ou 404 not_found em webhooks de outra instância).

Parâmetros

Caminho

Nome	Tipo	Descrição
`id`obrigatório	`string`	Id da instância (`inst_...`).

Corpo (JSON)

Nome	Tipo	Descrição
`phones`obrigatório	`string[]`	(até 10 itens)

Exemplo

curl -s -X POST "$LITEZAP_URL/v1/instances/$ID/check-numbers" \
  -H "Authorization: Bearer $LITEZAP_TOKEN" \
  -d '{"phones":["5511999999999","5511888888888"]}'

const res = await fetch("http://localhost:8787/v1/instances/inst_7f3a9c2e5b1d4086/check-numbers", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.LITEZAP_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({
    "phones": [
      "5511999999999",
      "5511888888888"
    ]
  }),
});
console.log(res.status, res.status === 204 ? "" : await res.json());

import os
import requests

r = requests.post(
    "http://localhost:8787/v1/instances/inst_7f3a9c2e5b1d4086/check-numbers",
    headers={"Authorization": f"Bearer {os.environ['LITEZAP_TOKEN']}"},
    json={
        "phones": ["5511999999999", "5511888888888"],
    },
    timeout=150,
)
print(r.status_code, r.json() if r.content else "")

package main

import (
  "fmt"
  "io"
  "net/http"
  "os"
  "strings"
)

func main() {
  req, _ := http.NewRequest("POST", "http://localhost:8787/v1/instances/inst_7f3a9c2e5b1d4086/check-numbers", strings.NewReader(`{"phones":["5511999999999","5511888888888"]}`))
  req.Header.Set("Authorization", "Bearer "+os.Getenv("LITEZAP_TOKEN"))
  req.Header.Set("Content-Type", "application/json")
  resp, err := http.DefaultClient.Do(req)
  if err != nil {
    panic(err)
  }
  defer resp.Body.Close()
  out, _ := io.ReadAll(resp.Body)
  fmt.Println(resp.Status, string(out))
}

<?php
require 'vendor/autoload.php'; // composer require guzzlehttp/guzzle

$client = new GuzzleHttp\Client(['base_uri' => 'http://localhost:8787']);
$res = $client->request('POST', '/v1/instances/inst_7f3a9c2e5b1d4086/check-numbers', [
    'headers' => ['Authorization' => 'Bearer ' . getenv('LITEZAP_TOKEN')],
    'json' => [
        'phones' => ['5511999999999', '5511888888888'],
    ],
    'http_errors' => false,
]);
echo $res->getStatusCode(), ' ', $res->getBody(), PHP_EOL;

Nos exemplos, LITEZAP_URL é a URL base (ex.: http://localhost:8787) e o token vem deLITEZAP_TOKEN (instância) ou LITEZAP_ADMIN_TOKEN.

Resposta

200 Resultado por número.

Campos de object

results NumberResult[]

{
  "results": [
    {
      "phone": "5511999999999",
      "exists": true,
      "jid": "[email protected]"
    },
    {
      "phone": "5511888888888",
      "exists": false
    }
  ]
}

Erros

Código	HTTP	Retentável	O que fazer
`validation_failed`	400	não	Corrija o corpo ou os parâmetros; a `message` diz o campo.
`unauthorized`	401	não	Envie `Authorization: Bearer <token>` válido.
`forbidden`	403	não	Use o token certo (admin, ou o da própria instância).
`instance_not_found`	404	não	Confira o id da instância.
`instance_not_connected`	409	depende	Confira o estado da instância; se `logged_out`, pareie de novo.
`instance_banned`	409	não	Número banido: apague a instância.
`rate_limited`	429	sim	Espere e tente de novo com backoff.
`worker_error`	502	sim	Tente de novo com backoff; se persistir, veja o log do servidor.
`worker_timeout`	504	sim	Tente de novo; a instância pode estar sobrecarregada ou reconectando.

Todo erro usa o envelope {"error":{"code","message","retryable"}}. Tabela completa em Erros.

Equivalente na Z-API: Número com WhatsApp / Validação em lote. Veja Migrar da Z-API.