> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pilotstatus.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.**



## OpenAPI

````yaml openapi.pt.json GET /v1/messages/unread
openapi: 3.1.0
info:
  title: API Pilot Status
  version: 1.0.0
  license:
    name: Pilot Status Terms of Service
    url: https://pilotstatus.com.br/terms
  description: >-
    API REST pública do Pilot Status. Autentique com o header `x-api-key:
    ps_...` (ou `x-api-key-id`). Base URL: https://pilotstatus.com.br
servers:
  - url: https://pilotstatus.com.br
security:
  - apiKey: []
  - apiKeyId: []
paths:
  /v1/messages/unread:
    get:
      tags:
        - Conversations
      summary: Mensagens não lidas
      description: >-
        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.**
      operationId: get_messages_unread
      parameters:
        - name: page
          in: query
          required: false
          description: Página (padrão 1).
          schema:
            type: string
            description: (integer (≥1))
          example: '1'
        - name: pageSize
          in: query
          required: false
          description: Itens por página (padrão 30, máx 100).
          schema:
            type: string
            description: (integer (1–100))
          example: '30'
      responses:
        '200':
          description: Mensagens não lidas
          content:
            application/json:
              example:
                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
        '400':
          description: Payload ou parâmetros inválidos
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Validation error
        '401':
          description: Header `x-api-key` / `x-api-key-id` ausente ou inválido
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Unauthorized
        '403':
          description: Chave com escopo de tenant usada em endpoint com escopo de número
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Tenant-scoped keys cannot call number endpoints
                code: TENANT_SCOPE_NOT_ALLOWED
        '429':
          description: Limite de taxa excedido
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Too many requests
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Sua chave de API ps_
    apiKeyId:
      type: apiKey
      in: header
      name: x-api-key-id
      description: Id da chave de API (alternativa ao x-api-key)

````