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

# Uma mensagem — e se o envio saiu

> Exige `inbox:view`. O mesmo objeto do histórico, mais `error` (o motivo
quando o envio falhou) e `conversation_id`. É como conferir se a resposta
do agente chegou ao provedor sem depender do webhook.

A visibilidade é a da conversa: se ela não é desta empresa ou não está no
escopo do token, a mensagem é `404`.




## OpenAPI

````yaml /openapi.yaml get /mensagens/{id}
openapi: 3.1.0
info:
  title: Metricaas API
  version: 1.0.0
  description: >
    API do Metricaas para automatizar o CRM de fora dele — registrar vendas de
    uma

    plataforma de pagamento, ler leads e conferir a atribuição de origem.


    **Base:** `https://app.metricaas.com.br/v1`


    Todo endpoint é server-to-server. Não há CORS: um token de API nunca deve ir

    para o navegador.
servers:
  - url: https://app.metricaas.com.br/v1
security:
  - bearerAuth: []
tags:
  - name: Sessão
  - name: Leads
  - name: Vendas
  - name: Atendimento
  - name: Agente de IA
    description: |
      Ler a conversa, responder ao lead e pedir um humano — para um agente de IA
      (no n8n, por exemplo) atender pelo número da empresa sem sair do
      MetricaaS. A mensagem do agente aparece no inbox com selo próprio, não
      assume a conversa e não conta como primeira resposta do time.

      Gere o token em **Configurações → Tokens de API** com a finalidade
      **"Agente de atendimento"**: ele só conversa (`inbox:view` e
      `inbox:operate`). O texto do lead vai para um modelo de linguagem, e um
      modelo pode ser manipulado pela própria mensagem — o token não pode
      permitir nada além de conversar.

      **Este token é do seu servidor (o n8n), não do modelo.** Nunca o entregue
      ao modelo de IA como ferramenta: uma mensagem do lead poderia mandar o
      modelo ler outras conversas.
  - name: Comentários
    description: >
      Os comentários dos posts do Instagram e a resposta EM PÚBLICO, como a
      conta

      da empresa — a mesma fila da caixa de comentários. Uso típico: o webhook

      `comment.received` chega, um agente escreve a resposta, uma pessoa aprova,
      e

      o seu servidor publica por `POST
      /v1/comentarios/{comentario_id}/respostas`.
  - name: Fluxos
    description: >
      Criar um fluxo completo e ligar um post do Instagram a um fluxo de

      comentário — a ponte para quem publica o post fora do MetricaaS (o Estúdio

      do Horus, ou um motor de Reels) e quer que o fluxo certo responda a quem

      comentar nele.


      Gere o token em **Configurações → Tokens de API** com a finalidade

      **"Acesso completo do papel"** e o modo de **escrita**, herdando alguém
      que pode montar

      fluxos (`automations:manage`).
  - name: Configuração do CRM
    description: |
      Funis, etapas, tags e campos personalizados — para montar a operação por
      script (ex.: o funil "Infoproduto": Comentou → Abriu material → Lead →
      Clicou comprar → Comprou → Entregue → Cliente recorrente · Perdido).

      **Criar é idempotente pelo nome** (no campo, pela chave): repetir o
      script devolve `200` com `criado: false` e não duplica nada. O que já
      existe com **outro tipo** é `409`, e nada muda. Renomear, reordenar o que
      existe e remover ficam na tela. Ler pede a tela correspondente (Funil,
      Leads); criar pede `funnel:config`.
paths:
  /mensagens/{id}:
    get:
      tags:
        - Agente de IA
      summary: Uma mensagem — e se o envio saiu
      description: >
        Exige `inbox:view`. O mesmo objeto do histórico, mais `error` (o motivo

        quando o envio falhou) e `conversation_id`. É como conferir se a
        resposta

        do agente chegou ao provedor sem depender do webhook.


        A visibilidade é a da conversa: se ela não é desta empresa ou não está
        no

        escopo do token, a mensagem é `404`.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Mensagem'
                  - type: object
                    properties:
                      conversation_id:
                        type: string
                        format: uuid
                      error:
                        type: string
                        nullable: true
                        description: Por que o envio falhou, quando `status` é `failed`.
              example:
                id: 0d9e8f7a-6b5c-4d3e-8f21-a0b1c2d3e4f5
                conversation_id: 7b0c2e4a-1f3d-4c55-9a10-2d6f8e9b3c71
                direction: out
                source: api
                type: text
                text: Oi, Maria! Já te passo os valores.
                transcript: null
                media: null
                status: failed
                error: instância desconectada (401)
                deleted: false
                created_at: '2026-10-21T13:58:40.000Z'
        '401':
          $ref: '#/components/responses/NaoAutenticado'
        '403':
          $ref: '#/components/responses/SemPermissao'
        '404':
          $ref: '#/components/responses/NaoEncontrado'
components:
  schemas:
    Mensagem:
      type: object
      properties:
        id:
          type: string
          format: uuid
        direction:
          type: string
          enum:
            - in
            - out
        source:
          type: string
          enum:
            - lead
            - api
            - inbox
            - celular
            - automacao
          description: |
            - `lead` — mensagem recebida.
            - `api` — enviada por esta API (o agente).
            - `inbox` — alguém do time respondeu pelo MetricaaS.
            - `celular` — alguém respondeu pelo aparelho, fora do MetricaaS.
            - `automacao` — um fluxo do MetricaaS.
        type:
          type: string
          description: '`text`, `image`, `audio`, `video`, `document`, `sticker`…'
        text:
          type: string
          nullable: true
          description: '`null` quando apagada, ou mídia sem legenda.'
        transcript:
          type: string
          nullable: true
          description: Transcrição do áudio
          quando houver.: null
        media:
          type: object
          nullable: true
          properties:
            url:
              type: string
              description: >-
                Caminho desta API (`/v1/mensagens/{id}/midia`) — chame com o
                mesmo token.
            mime:
              type: string
              nullable: true
        status:
          type: string
          description: 'Recebida: `received`. Enviada: `pending` → `sent`, ou `failed`.'
        deleted:
          type: boolean
        created_at:
          type: string
          format: date-time
          description: |
            O momento da mensagem — o do provedor, quando ele informa; senão, o
            de quando ela chegou aqui. É o que ordena o histórico.
    Problema:
      type: object
      description: Erros seguem RFC 7807.
      properties:
        type:
          type: string
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
        errors:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
              message:
                type: string
  responses:
    NaoAutenticado:
      description: Token ausente, inválido, expirado ou revogado
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problema'
    SemPermissao:
      description: O token não tem a capacidade exigida, ou é de leitura
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problema'
    NaoEncontrado:
      description: >
        Não existe **ou** é de outra empresa. A API responde `404` nos dois
        casos

        de propósito: um `403` confirmaria que o id existe.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problema'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >
        `Authorization: Bearer mcp_…` — gere em **Configurações → Tokens de
        API**.


        O token de API tem modo `read` ou `write`. Um token `read` responde
        `403`

        a qualquer verbo que não seja `GET`. As capacidades do token são a

        **interseção** com as da pessoa de quem ele herda o papel: se ela perder

        acesso na grade de Equipe, o token perde junto, sem ninguém revogar
        nada.


        **Token de agência** (gerado no console da agência): vale para as

        empresas da agência, e a empresa de cada chamada vai no header

        **`X-Empresa: <slug da empresa>`**. Sem o header, `401`. Num token de

        empresa o header é opcional e, se vier, tem de ser a própria empresa. O

        modo `read` vale igual: um token de agência de leitura só faz `GET` —

        é o token para pôr numa função que só consulta.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.