Conversas

Mensagens não lidas

Lista as mensagens RECEBIDAS não lidas do número vinculado (mais recentes primeiro). O “total” é a contagem REAL de não lidas — a soma de Conversation.unreadCount (o mesmo contador que o dashboard mostra), e não a contagem bruta de mensagens recebidas. Cada item traz conversationUnreadCount (total de não lidas da conversa). Paginação por page/pageSize (sem filtro de período). O modo de privacidade do número (PII) se aplica: RELAY_ONLY → [] + notice:“PII_RELAY_ONLY”; STORE_X_DAYS limita à janela de retenção. Requer key escopada a número.

Requer uma chave com escopo de número.

GET

messages

unread

Mensagens não lidas

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

{
  "messages": [
    {
      "id": "cm_01HZX...",
      "conversationId": "conv_01HZX...",
      "direction": "INBOUND",
      "from": "+5511988887777",
      "fromName": "Ana",
      "userId": "BR.13491208655302741918",
      "username": "ana",
      "text": "Olá, ainda está disponível?",
      "createdAt": "2026-06-27T10:00:00.000Z",
      "readAt": null,
      "conversationUnreadCount": 3
    }
  ],
  "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

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

Mensagens não lidas

Histórico de mensagens

Listar grupos

⌘I

Mensagens não lidas

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

{
  "messages": [
    {
      "id": "cm_01HZX...",
      "conversationId": "conv_01HZX...",
      "direction": "INBOUND",
      "from": "+5511988887777",
      "fromName": "Ana",
      "userId": "BR.13491208655302741918",
      "username": "ana",
      "text": "Olá, ainda está disponível?",
      "createdAt": "2026-06-27T10:00:00.000Z",
      "readAt": null,
      "conversationUnreadCount": 3
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 30,
  "totalPages": 1
}