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

# Inicia (ou continua) a conversa de WhatsApp com um lead

> Manda uma mensagem de WhatsApp para o lead do `phone` (ou do `lead_id`),
criando a conversa se ela não existe. É a recuperação de quem deixou o
telefone num formulário. Precisa de token de escrita com `inbox:operate` **e** `crm:operate`: o token de finalidade "Agente de atendimento" responde quem escreveu, mas não abre conversa nova.

**Começar conversa é o que faz o WhatsApp banir um número**, então as
travas são as da primeira mensagem dos fluxos, na mesma fila:

1. **Consentimento:** só lead que **pediu contato** (origem `form` —
   crie com `POST /v1/leads` e `origem: "form"`), ou que já escreveu
   nesta conversa. Senão: `409`.
2. **Pediu para parar:** lead com a tag **`nao-contatar`** recebe `409`,
   sempre. Aplique a tag quando a pessoa pedir para sair.
3. **Uma primeira mensagem por lead**, somando fluxos e API. Depois dela,
   enquanto o lead não responde, as próximas entram na mesma fila.
4. **Em gotas:** no mínimo 60 s entre duas mensagens a frio da empresa,
   100 por dia (de Brasília). A resposta traz `agendada_para`; se a
   próxima vaga passaria de 30 min, `429` com `Retry-After`.
5. **Só pela conexão UAZAPI.** Na API oficial do WhatsApp (Cloud API),
   começar conversa exige template aprovado, que este endpoint ainda não
   manda: `422`.

Se o lead já escreveu na conversa, a mensagem sai como a de
`POST /v1/conversas/{id}/mensagens` (com a mesma recusa da IA pausada e o
mesmo `forcar`).

**Idempotency-Key é obrigatório**, e os limites são os do envio da API:
30 por minuto por token, 1.000 por dia por empresa. Repetir a chave
devolve `200` com a mensagem que já foi.




## OpenAPI

````yaml /openapi.yaml post /conversas
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:
  /conversas:
    post:
      tags:
        - Atendimento
      summary: Inicia (ou continua) a conversa de WhatsApp com um lead
      description: >
        Manda uma mensagem de WhatsApp para o lead do `phone` (ou do `lead_id`),

        criando a conversa se ela não existe. É a recuperação de quem deixou o

        telefone num formulário. Precisa de token de escrita com `inbox:operate`
        **e** `crm:operate`: o token de finalidade "Agente de atendimento"
        responde quem escreveu, mas não abre conversa nova.


        **Começar conversa é o que faz o WhatsApp banir um número**, então as

        travas são as da primeira mensagem dos fluxos, na mesma fila:


        1. **Consentimento:** só lead que **pediu contato** (origem `form` —
           crie com `POST /v1/leads` e `origem: "form"`), ou que já escreveu
           nesta conversa. Senão: `409`.
        2. **Pediu para parar:** lead com a tag **`nao-contatar`** recebe `409`,
           sempre. Aplique a tag quando a pessoa pedir para sair.
        3. **Uma primeira mensagem por lead**, somando fluxos e API. Depois
        dela,
           enquanto o lead não responde, as próximas entram na mesma fila.
        4. **Em gotas:** no mínimo 60 s entre duas mensagens a frio da empresa,
           100 por dia (de Brasília). A resposta traz `agendada_para`; se a
           próxima vaga passaria de 30 min, `429` com `Retry-After`.
        5. **Só pela conexão UAZAPI.** Na API oficial do WhatsApp (Cloud API),
           começar conversa exige template aprovado, que este endpoint ainda não
           manda: `422`.

        Se o lead já escreveu na conversa, a mensagem sai como a de

        `POST /v1/conversas/{id}/mensagens` (com a mesma recusa da IA pausada e
        o

        mesmo `forcar`).


        **Idempotency-Key é obrigatório**, e os limites são os do envio da API:

        30 por minuto por token, 1.000 por dia por empresa. Repetir a chave

        devolve `200` com a mensagem que já foi.
      parameters:
        - name: Idempotency-Key
          in: header
          required: true
          schema:
            type: string
            maxLength: 200
            example: recuperacao-ana-2026-11-14
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - phone
              properties:
                phone:
                  type: string
                  example: '11987654321'
                  description: >-
                    O telefone do lead (com DDD). Com `lead_id`, tem que ser o
                    dele.
                channel:
                  type: string
                  enum:
                    - whatsapp
                  default: whatsapp
                text:
                  type: string
                  maxLength: 4096
                media_url:
                  type: string
                  description: >-
                    Só a URL devolvida por `POST /v1/midia`. Junto com
                    `media_type`.
                media_type:
                  type: string
                  enum:
                    - image
                    - audio
                    - ptt
                    - video
                    - document
                lead_id:
                  type: string
                  format: uuid
                forcar:
                  type: boolean
                  default: false
                  description: Envia mesmo com a IA pausada por uma pessoa.
            example:
              phone: '11987654321'
              text: >-
                Oi, Ana! Vi que você pediu o mapa do seu nome. Ainda quer? Te
                mando o link por aqui.
      responses:
        '200':
          description: 'Repetição da mesma `Idempotency-Key` (`duplicate: true`)'
        '202':
          description: Enfileirada
          content:
            application/json:
              schema:
                type: object
                properties:
                  conversation_id:
                    type: string
                    format: uuid
                  message_id:
                    type: string
                    format: uuid
                  status:
                    type: string
                    enum:
                      - pending
                  agendada_para:
                    type: string
                    format: date-time
                    description: Quando a mensagem pode sair (a fila em gotas).
                  fria:
                    type: boolean
                    description: '`true` = o lead ainda não escreveu nesta conversa.'
                  conversa_nova:
                    type: boolean
                  duplicate:
                    type: boolean
              example:
                conversation_id: 6a1f0c2e-1b2c-4d5e-8f90-1234567890ab
                message_id: 9b2e1d3f-1b2c-4d5e-8f90-1234567890ab
                status: pending
                agendada_para: '2026-11-14T13:02:10.000Z'
                fria: true
                conversa_nova: true
                duplicate: false
        '400':
          description: Falta o `Idempotency-Key`
        '404':
          $ref: '#/components/responses/NaoEncontrado'
        '409':
          description: >-
            Sem consentimento, tag `nao-contatar`, primeira mensagem já
            recusada, conversa de outro lead ou IA pausada
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problema'
        '422':
          $ref: '#/components/responses/Invalido'
        '429':
          $ref: '#/components/responses/LimiteAtingido'
components:
  responses:
    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'
    Invalido:
      description: Validação — veja `errors[]`
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problema'
    LimiteAtingido:
      description: |
        Passou de 30 envios por minuto neste token, ou de 1.000 por dia (de
        Brasília) nesta empresa. Espere os segundos do `Retry-After`.
      headers:
        Retry-After:
          schema:
            type: integer
            example: 42
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problema'
          example:
            type: about:blank
            title: Limite de envios
            status: 429
            detail: >-
              Limite de 30 envios por minuto para este token. Tente de novo em
              42 s.
  schemas:
    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
  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.