Conversations

Message history

Lists the linked number’s full message history (direct and group), ordered by providerTimestamp (newest first). Works for all providers (Evolution Go, Evolution v2 and Meta). Paginated via page/pageSize. Filter by date with startDate/endDate (ISO 8601, over providerTimestamp). Returns up to ~1 month of stored history (from the connection date). The number’s privacy (PII) mode applies: RELAY_ONLY → [] + notice:“PII_RELAY_ONLY”; STORE_X_DAYS clamps to the window max(startDate, now − retentionDays). Requires a number-scoped key.

Requires a number-scoped key.

GET

messages

history

Message history

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

{
  "messages": [
    {
      "id": "cm_01HZX...",
      "conversationId": "conv_01HZX...",
      "direction": "INBOUND",
      "providerKind": "PILOT_STATUS",
      "externalMessageId": "wamid.HBg...",
      "status": "DELIVERED",
      "messageType": "text",
      "origin": null,
      "text": "Olá, ainda está disponível?",
      "participantName": "Ana",
      "participantPhone": "+5511988887777",
      "repliedToExternalId": null,
      "media": null,
      "sentAt": null,
      "deliveredAt": "2026-06-27T10:00:01.000Z",
      "readAt": null,
      "providerTimestamp": "2026-06-27T10:00:00.000Z",
      "createdAt": "2026-06-27T10:00:00.500Z"
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 30,
  "totalPages": 1
}

Authorizations

x-api-key

string

header

required

Your ps_ API key

Query Parameters

startDate

string

Start of the date range (filters by providerTimestamp). Must be ≤ endDate. (string (ISO 8601))

endDate

string

End of the date range (filters by providerTimestamp). (string (ISO 8601))

page

string

Page (default 1). (integer (≥1))

pageSize

string

Items per page (default 30, max 100). (integer (1–100))

Response

Message history

Group messages

Unread messages

⌘I

Message history

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

{
  "messages": [
    {
      "id": "cm_01HZX...",
      "conversationId": "conv_01HZX...",
      "direction": "INBOUND",
      "providerKind": "PILOT_STATUS",
      "externalMessageId": "wamid.HBg...",
      "status": "DELIVERED",
      "messageType": "text",
      "origin": null,
      "text": "Olá, ainda está disponível?",
      "participantName": "Ana",
      "participantPhone": "+5511988887777",
      "repliedToExternalId": null,
      "media": null,
      "sentAt": null,
      "deliveredAt": "2026-06-27T10:00:01.000Z",
      "readAt": null,
      "providerTimestamp": "2026-06-27T10:00:00.000Z",
      "createdAt": "2026-06-27T10:00:00.500Z"
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 30,
  "totalPages": 1
}