Mensajes de una conversación

GEThttps://api.bydomu.com/v1/conversations/{contactId}/messages

Esta referência é gerada a partir do código da API, por isso as descrições estão em espanhol. Nomes, parâmetros e exemplos são iguais em qualquer idioma.

Mensajes con el contacto, del más reciente al más antiguo (pageSize por defecto 50, máximo 100).

Permissão
conversations:read
Chaves
Só secreta (de um servidor)

Cabeçalhos

X-API-Keystringobrigatório
Sua chave secreta.

Parâmetros de rota

contactIdstringobrigatório
ID del contacto

Parâmetros de consulta

pageinteger
Página, desde 1 · default=1 · ≥ 1
pageSizeinteger
Mensajes por página (máximo 100) · default=50 · 1–100

Respostas

200Página de mensajes
400Datos inválidos: el cuerpo o la query no cumplen el esquema, o `Idempotency-Key` está mal formada.
401UNAUTHORIZED · Clave faltante, inválida, desactivada o vencida.
403FORBIDDEN · La clave no puede usar esta operación: falta el scope, es una secreta en el navegador, el nivel de la cuenta no la permite, está suspendida o se alcanzó un tope del plan.
404NOT_FOUND · El recurso no existe en la organización.
429RATE_LIMITED · Límite de peticiones excedido: el de la clave (`RATE_LIMITED`), el de escrituras de la organización (`TENANT_RATE_LIMITED`) o bloqueo temporal de la IP por claves inválidas.
500INTERNAL_ERROR · Error interno del servidor.
cURL
curl "https://api.bydomu.com/v1/conversations/clx1con001/messages" \
  -H "X-API-Key: $BYDOMU_API_KEY"
JavaScript
const res = await fetch("https://api.bydomu.com/v1/conversations/clx1con001/messages", {
  headers: { "X-API-Key": process.env.BYDOMU_API_KEY },
});
const data = await res.json();
Python
import os, requests

r = requests.get(
    "https://api.bydomu.com/v1/conversations/clx1con001/messages",
    headers={"X-API-Key": os.environ["BYDOMU_API_KEY"]}
)
data = r.json()
Resposta · 200 · exemplo
{
  "data": [
    {
      "id": "clx1msg001",
      "body": "Hola, ¿sigue disponible el apartamento?",
      "direction": "INBOUND",
      "type": "TEXT",
      "timestamp": "2026-09-25T10:30:00.000Z",
      "mediaUrl": "https://cdn.bydomu.com/wa/media/abc.jpg",
      "channel": "WHATSAPP"
    }
  ],
  "meta": {
    "total": 150,
    "page": 1,
    "pageSize": 20,
    "totalPages": 8
  }
}

A chave vai na variável BYDOMU_API_KEY. Os dados do exemplo não são de nenhuma imobiliária.