Skip to main content
GET
Uma mensagem — e se o envio saiu

Authorizations

Authorization
string
header
required

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.

Path Parameters

id
string<uuid>
required

Response

OK

id
string<uuid>
direction
enum<string>
Available options:
in,
out
source
enum<string>
  • 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.
Available options:
lead,
api,
inbox,
celular,
automacao
type
string

text, image, audio, video, document, sticker…

text
string | null

null quando apagada, ou mídia sem legenda.

transcript
string | null

Transcrição do áudio

media
object | null
status
string

Recebida: received. Enviada: pending → sent, ou failed.

deleted
boolean
created_at
string<date-time>

O momento da mensagem — o do provedor, quando ele informa; senão, o de quando ela chegou aqui. É o que ordena o histórico.

conversation_id
string<uuid>
error
string | null

Por que o envio falhou, quando status é failed.