Listar conversas
Lista as conversas do número vinculado, ordenadas pela última atividade (lastMessageAt desc). Paginação por page/pageSize. Filtre por período com startDate/endDate (ISO 8601, sobre lastMessageAt). O modo de privacidade do número (PII) afeta a resposta: RELAY_ONLY retorna [] + notice:“PII_RELAY_ONLY”; STORE_X_DAYS limita à janela max(startDate, agora − retentionDays). Requer key escopada a número. Identidade do contato: from é o telefone E.164 (com +) quando conhecido — pode ser null para contatos que usam username do WhatsApp; userId é o BSUID durável (id estável do contato) e username o handle público quando visível.
Requer uma chave com escopo de número.
curl --request GET \
--url https://pilotstatus.com.br/v1/conversations \
--header 'x-api-key: <api-key>'import requests
url = "https://pilotstatus.com.br/v1/conversations"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://pilotstatus.com.br/v1/conversations', 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://pilotstatus.com.br/v1/conversations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://pilotstatus.com.br/v1/conversations"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://pilotstatus.com.br/v1/conversations")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/v1/conversations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"conversations": [
{
"id": "conv_01HZX...",
"from": "+5511988887777",
"fromName": "Ana",
"userId": "BR.13491208655302741918",
"username": "ana",
"type": "DIRECT",
"unreadCount": 2,
"lastMessageAt": "2026-06-27T10:00:00.000Z",
"lastMessagePreview": "Olá! Sua entrega chegou."
}
],
"total": 1,
"page": 1,
"pageSize": 30,
"totalPages": 1
}{
"error": "startDate must be before or equal to endDate",
"code": "INVALID_DATE_RANGE"
}{
"error": "Unauthorized"
}{
"error": "Tenant-scoped keys cannot call number endpoints",
"code": "TENANT_SCOPE_NOT_ALLOWED"
}{
"error": "Too many requests"
}Autorizações
Sua chave de API ps_
Parâmetros de consulta
Início do período (filtra por lastMessageAt). Deve ser ≤ endDate. (string (ISO 8601))
Fim do período (filtra por lastMessageAt). (string (ISO 8601))
Página (padrão 1). (integer (≥1))
Itens por página (padrão 30, máx 100). (integer (1–100))
Resposta
Listar conversas
Esta página foi útil?
curl --request GET \
--url https://pilotstatus.com.br/v1/conversations \
--header 'x-api-key: <api-key>'import requests
url = "https://pilotstatus.com.br/v1/conversations"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://pilotstatus.com.br/v1/conversations', 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://pilotstatus.com.br/v1/conversations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://pilotstatus.com.br/v1/conversations"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://pilotstatus.com.br/v1/conversations")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/v1/conversations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"conversations": [
{
"id": "conv_01HZX...",
"from": "+5511988887777",
"fromName": "Ana",
"userId": "BR.13491208655302741918",
"username": "ana",
"type": "DIRECT",
"unreadCount": 2,
"lastMessageAt": "2026-06-27T10:00:00.000Z",
"lastMessagePreview": "Olá! Sua entrega chegou."
}
],
"total": 1,
"page": 1,
"pageSize": 30,
"totalPages": 1
}{
"error": "startDate must be before or equal to endDate",
"code": "INVALID_DATE_RANGE"
}{
"error": "Unauthorized"
}{
"error": "Tenant-scoped keys cannot call number endpoints",
"code": "TENANT_SCOPE_NOT_ALLOWED"
}{
"error": "Too many requests"
}