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

# Busca o histórico de mensagens de um lead

> Recupera o histórico de conversas e os dados associados a um lead, identificado pelo seu número de telefone. Pode retornar os dados em formato JSON ou como um texto único formatado para uso com Modelos de Linguagem (LLMs).



## OpenAPI

````yaml /api-reference/zattenapi.json get /messages/history
openapi: 3.1.0
info:
  title: API de Atendimento e Mensageria
  description: >-
    API para interagir com o sistema de atendimento, permitindo o envio de
    mensagens via template do WhatsApp e a gestão de informações de leads. A
    autenticação é realizada através de uma chave de API (`x-api-key`) enviada
    no cabeçalho de cada requisição. A API também possui um sistema de limite de
    requisições (rate limiting) para garantir a estabilidade.
  version: 1.0.0
servers:
  - url: https://api.zatten.com/api/v1
security:
  - ApiKeyAuth: []
tags:
  - name: Mensagens
    description: Endpoints para envio e consulta de mensagens.
  - name: Leads
    description: Endpoints para gerenciamento de dados de leads.
  - name: Kanban
    description: Endpoints para consulta de estruturas de organização do CRM.
  - name: Tags
    description: Endpoints para consulta de etiquetas (tags) de organização.
paths:
  /messages/history:
    get:
      tags:
        - Mensagens
      summary: Busca o histórico de mensagens de um lead
      description: >-
        Recupera o histórico de conversas e os dados associados a um lead,
        identificado pelo seu número de telefone. Pode retornar os dados em
        formato JSON ou como um texto único formatado para uso com Modelos de
        Linguagem (LLMs).
      parameters:
        - name: leadNumber
          in: query
          description: O número de telefone do lead.
          required: true
          schema:
            type: string
        - name: thread_id
          in: query
          description: >-
            ID da thread cujas mensagens devem ser retornadas. Se omitido, busca
            as mensagens da thread atual do lead. A thread informada precisa
            pertencer ao lead do `leadNumber`.
          required: false
          schema:
            type: string
        - name: llm_format
          in: query
          description: >-
            Se `true`, retorna um contexto formatado em texto para LLMs. Se
            `false`, retorna o histórico e os dados do lead em JSON.
          schema:
            type: boolean
            default: true
      responses:
        '200':
          description: Histórico de mensagens retornado com sucesso.
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ContextResponse'
                    description: Contexto formatado para LLMs
                    title: Com llm_format=true
                  - $ref: '#/components/schemas/MessageHistoryResponse'
                    description: Histórico de mensagens e dados do lead em JSON
                    title: Com llm_format=false
        '400':
          description: Erro de validação nos parâmetros da requisição.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Chave de API (`x-api-key`) ausente ou inválida.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: >-
            Lead com o telefone especificado não encontrado, ou `threadId`
            informado não pertence ao lead.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Limite de requisições excedido.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    ContextResponse:
      type: object
      properties:
        context:
          type: string
          description: >-
            Um texto consolidado com as informações do lead e o histórico da
            conversa, formatado para LLMs.
    MessageHistoryResponse:
      type: object
      properties:
        message_history:
          type: array
          items:
            $ref: '#/components/schemas/Message'
        lead:
          $ref: '#/components/schemas/LeadDetails'
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Descrição do erro ocorrido.
    Message:
      type: object
      properties:
        from:
          type: string
        type:
          type: string
        message:
          type: string
        status:
          type: string
        source:
          type: string
        created_at:
          type: string
          format: date-time
    LeadDetails:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        phone:
          type: string
        metadata:
          type: object
          additionalProperties:
            type: string
        annotation:
          type: string
        kanban_column:
          $ref: '#/components/schemas/KanbanColumnInfo'
        current_tags:
          type: array
          items:
            $ref: '#/components/schemas/TagInfo'
        created_at:
          type: string
          format: date-time
    KanbanColumnInfo:
      type: object
      properties:
        name:
          type: string
        id:
          type: string
    TagInfo:
      type: object
      properties:
        name:
          type: string
        id:
          type: string
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Chave de API necessária para autenticar todas as requisições.

````