Ir para o conteúdo
WhatsMarketingDeveloper Hub

Conversas

Referências às conversas da caixa de entrada: com quem, por qual canal, em qual status e quem a atende. O conteúdo das mensagens fica na caixa de entrada; ler e enviar mensagens por API chega na próxima versão.

Listar conversas

GET/conversations

Referências às conversas da caixa de entrada com filtros por aba (filter: all, unassigned, mine, resolved), status, canal, contato, pessoa atribuída e busca. Traz tabs e summary com os números da caixa de entrada.

Permissões: conversations:read

Parâmetros

NomeOndeTipoValores
pageconsultanumberpadrão: 1 · 1 – …
pageSizeconsultanumberpadrão: 20 · 1 – 100
filterconsultastringall · unassigned · mine · resolved
statusconsultastringOPEN · PENDING · RESOLVED
channelIdconsultauuid
channelTypeconsultastringWHATSAPP · INSTAGRAM · MESSENGER · FACEBOOK · TELEGRAM · TIKTOK · WEBCHAT · EMAIL · SMS · WECHAT · VOICE
contactIdconsultauuid
assignedToUserIdconsultauuid
qconsultastring0–100 caracteres
curl
curl "https://micuenta.whatsmarketing.es/api/v1/conversations?page=1&pageSize=20" \
  -H "Authorization: Bearer $WM_API_KEY"
Node.js
const res = await fetch('https://micuenta.whatsmarketing.es/api/v1/conversations?page=1&pageSize=20', {
  headers: {
    Authorization: `Bearer ${process.env.WM_API_KEY}`,
  },
});
const data = await res.json();
Python
import os, requests

r = requests.get(
    "https://micuenta.whatsmarketing.es/api/v1/conversations?page=1&pageSize=20",
    headers={"Authorization": f"Bearer {os.environ['WM_API_KEY']}"},
    timeout=30,
)
r.raise_for_status()
data = r.json()
PHP
<?php
$ch = curl_init('https://micuenta.whatsmarketing.es/api/v1/conversations?page=1&pageSize=20');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer ' . getenv('WM_API_KEY'),
  ],
]);
$data = json_decode(curl_exec($ch), true);
Resposta 200
{
  "data": [
    {
      "id": "d1e2f3a4-b5c6-4d7e-8f90-a1b2c3d4e5f6",
      "organizationId": "f0e1d2c3-b4a5-4968-8776-655443322110",
      "contactId": "0b1c2d3e-5f6a-4b7c-8d9e-0f1a2b3c4d5e",
      "contact": {
        "id": "0b1c2d3e-5f6a-4b7c-8d9e-0f1a2b3c4d5e",
        "fullName": "Laura Pérez",
        "primaryPhone": "+34612345678",
        "primaryEmail": "laura@ejemplo.com"
      },
      "channelId": "5f6a7b8c-9d0e-4f1a-8b2c-3d4e5f6a7b8c",
      "channel": {
        "id": "5f6a7b8c-9d0e-4f1a-8b2c-3d4e5f6a7b8c",
        "type": "WHATSAPP"
      },
      "externalConversationId": "1842",
      "status": "OPEN",
      "initiatedBy": "CONTACT",
      "assignedToUserId": null,
      "assignedTo": null,
      "createdAt": "2026-10-14T10:21:00.000Z",
      "updatedAt": "2026-10-14T10:21:00.000Z"
    }
  ],
  "meta": {
    "page": 1,
    "pageSize": 20,
    "total": 1,
    "totalPages": 1
  },
  "tabs": {
    "all": 1,
    "unassigned": 1,
    "mine": 0,
    "resolved": 0
  },
  "summary": {
    "open": 1,
    "newInPeriod": 1,
    "newInPreviousPeriod": 0,
    "unassigned": 1,
    "oldestWaitingMinutes": 12,
    "resolvedToday": 0,
    "resolvedYesterday": 3
  }
}

Ver uma conversa

GET/conversations/{id}

A referência da conversa: contato, canal, status, quem a abriu e quem a atende. As mensagens não são devolvidas: elas ficam na caixa de entrada.

Permissões: conversations:read

Parâmetros

NomeOndeTipoValores
id obrigatóriorotastring
curl
curl "https://micuenta.whatsmarketing.es/api/v1/conversations/{id}" \
  -H "Authorization: Bearer $WM_API_KEY"
Node.js
const res = await fetch('https://micuenta.whatsmarketing.es/api/v1/conversations/{id}', {
  headers: {
    Authorization: `Bearer ${process.env.WM_API_KEY}`,
  },
});
const data = await res.json();
Python
import os, requests

r = requests.get(
    "https://micuenta.whatsmarketing.es/api/v1/conversations/{id}",
    headers={"Authorization": f"Bearer {os.environ['WM_API_KEY']}"},
    timeout=30,
)
r.raise_for_status()
data = r.json()
PHP
<?php
$ch = curl_init('https://micuenta.whatsmarketing.es/api/v1/conversations/{id}');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer ' . getenv('WM_API_KEY'),
  ],
]);
$data = json_decode(curl_exec($ch), true);
Resposta 200
{
  "id": "d1e2f3a4-b5c6-4d7e-8f90-a1b2c3d4e5f6",
  "organizationId": "f0e1d2c3-b4a5-4968-8776-655443322110",
  "contactId": "0b1c2d3e-5f6a-4b7c-8d9e-0f1a2b3c4d5e",
  "contact": {
    "id": "0b1c2d3e-5f6a-4b7c-8d9e-0f1a2b3c4d5e",
    "fullName": "Laura Pérez",
    "primaryPhone": "+34612345678",
    "primaryEmail": "laura@ejemplo.com"
  },
  "channelId": "5f6a7b8c-9d0e-4f1a-8b2c-3d4e5f6a7b8c",
  "channel": {
    "id": "5f6a7b8c-9d0e-4f1a-8b2c-3d4e5f6a7b8c",
    "type": "WHATSAPP"
  },
  "externalConversationId": "1842",
  "status": "OPEN",
  "initiatedBy": "CONTACT",
  "assignedToUserId": "2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e",
  "assignedTo": {
    "id": "2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e",
    "fullName": "Ana Gómez",
    "email": "ana@ejemplo.com"
  },
  "createdAt": "2026-10-14T10:21:00.000Z",
  "updatedAt": "2026-10-14T10:25:00.000Z"
}