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": [
{}
]
}
'import requests
url = "https://api.z-api.io/instances/{instanceId}/token/{token}/phone-exists-batch"
payload = { "phones": [{}] }
headers = {
"Client-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Client-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({phones: [{}]})
};
fetch('https://api.z-api.io/instances/{instanceId}/token/{token}/phone-exists-batch', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.z-api.io/instances/{instanceId}/token/{token}/phone-exists-batch",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'phones' => [
[
]
]
]),
CURLOPT_HTTPHEADER => [
"Client-Token: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.z-api.io/instances/{instanceId}/token/{token}/phone-exists-batch"
payload := strings.NewReader("{\n \"phones\": [\n {}\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Client-Token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.z-api.io/instances/{instanceId}/token/{token}/phone-exists-batch")
.header("Client-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"phones\": [\n {}\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.z-api.io/instances/{instanceId}/token/{token}/phone-exists-batch")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Client-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"phones\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_body{
"exists": true,
"inputPhone": "<string>",
"outputPhone": "<string>",
"lid": "<string>"
}Contacts
Verificação em lote
Verifica em lote se números possuem conta no WhatsApp
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": [
{}
]
}
'import requests
url = "https://api.z-api.io/instances/{instanceId}/token/{token}/phone-exists-batch"
payload = { "phones": [{}] }
headers = {
"Client-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Client-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({phones: [{}]})
};
fetch('https://api.z-api.io/instances/{instanceId}/token/{token}/phone-exists-batch', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.z-api.io/instances/{instanceId}/token/{token}/phone-exists-batch",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'phones' => [
[
]
]
]),
CURLOPT_HTTPHEADER => [
"Client-Token: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.z-api.io/instances/{instanceId}/token/{token}/phone-exists-batch"
payload := strings.NewReader("{\n \"phones\": [\n {}\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Client-Token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.z-api.io/instances/{instanceId}/token/{token}/phone-exists-batch")
.header("Client-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"phones\": [\n {}\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.z-api.io/instances/{instanceId}/token/{token}/phone-exists-batch")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Client-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"phones\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_body{
"exists": true,
"inputPhone": "<string>",
"outputPhone": "<string>",
"lid": "<string>"
}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
Header
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.
Body
array
obrigatório
Lista de números de telefone no formato DDI DDD NÚMERO. Ex: 551199999999
Request Body
{
"phones": ["554499999999", "554488888888"]
}
Response
200
boolean
Indica se o número possui WhatsApp
string
Número enviado na requisição
string
Número formatado conforme resposta do WhatsApp
string
Identificador único privado do WhatsApp (null se exists = false)
[
{
"exists": true,
"inputPhone": "554499999999",
"outputPhone": "554499999999",
"lid": "999999999999999@lid"
}
]