Recaudo Docs

Conversas

Conversas

Envie e receba mensagens pelo WhatsApp, Facebook Messenger e Instagram. A API detecta automaticamente o canal de cada conversa e encaminha as mensagens para o serviço correto.

Listar conversas

GET /v1/conversations

Parâmetros opcionais: channel (whatsapp, messenger, instagram), status (open, waiting, resolved, closed), customer (UUID), assigned_to (UUID), has_referral (true = só as que vieram de um anúncio), ad_id (filtrar por ID do anúncio), limit, page

Cada conversa inclui o objeto referral (o null) com os dados do anúncio de origem quando a conversa vem de publicidade (Meta ads / click-to-WhatsApp): source_id (ID do anúncio), source_type, headline, source_url, body, ctwa_clid, media_url. Use ?has_referral=true para trazer só essas.

Obter conversa

GET /v1/conversations/{'{id}'}

Inclui o cliente e o agente atribuído.

Listar mensagens

GET /v1/conversations/{'{id}'}/messages

Parâmetros opcionais: type (text, image, video, audio, document, template), limit, page

Enviar mensagem

POST /v1/conversations/{'{id}'}/messages
Corpo — mensagem de texto
{
  "body": "Hola, tu pedido ha sido enviado. Número de guía: ABC123"
}
Corpo — mensagem com mídia
{
  "body": "Aquí está tu factura",
  "media_url": "https://ejemplo.com/factura.pdf",
  "media_type": "document"
}
Campo Tipo Obrigatório Descrição
bodystringNão*Texto da mensagem (máx. 4096 caracteres)
media_urlurlNão*URL do arquivo de mídia
media_typestringNãoimage, video, audio, document

* É necessário ao menos body o media_url.

Enviar modelo de WhatsApp

POST /v1/conversations/{'{id}'}/send-template
Corpo
{
  "template_id": "uuid-del-template",
  "variables": {
    "1": "Juan Pérez",
    "2": "$1,500.00",
    "3": "15 de marzo"
  }
}

Disponível só para conversas de WhatsApp. Os modelos precisam estar aprovados pela Meta.

Resolver / Encerrar conversa

POST /v1/conversations/{'{id}'}/resolve — Marcar como resolvida
POST /v1/conversations/{'{id}'}/close — Encerrar definitivamente
Esta página ajudou? Obrigado por avisar.
Esc