Conversas

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.

GET

conversations

Listar conversas

curl --request GET \
  --url https://pilotstatus.com.br/v1/conversations \
  --header 'x-api-key: <api-key>'

{
  "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
}

Autorizações

x-api-key

string

header

obrigatório

Sua chave de API ps_

Parâmetros de consulta

startDate

string

Início do período (filtra por lastMessageAt). Deve ser ≤ endDate. (string (ISO 8601))

endDate

string

Fim do período (filtra por lastMessageAt). (string (ISO 8601))

page

string

Página (padrão 1). (integer (≥1))

pageSize

string

Itens por página (padrão 30, máx 100). (integer (1–100))

Resposta

Listar conversas

Cancelar mensagens agendadas

Mensagens de grupos

⌘I

Listar conversas

curl --request GET \
  --url https://pilotstatus.com.br/v1/conversations \
  --header 'x-api-key: <api-key>'

{
  "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
}