Listar conversas

Método

GET https://oapi.ogmma.com.br/v1/conversations

Conceituação

Este endpoint retorna uma lista paginada de conversas da sua instituição. Você pode filtrar por status, canal, atendente atribuído e departamento, além de controlar a ordenação e paginação dos resultados.

Cada conversa retornada inclui informações do contato associado, a última mensagem trocada e o contador de mensagens não lidas.

---

Atributos

Header

Atributo	Tipo	Obrigatório	Descrição
Authorization	string	Sim	Bearer {API_KEY} - Chave de autenticação

Query Parameters

Atributo	Tipo	Obrigatório	Descrição
status	string	Não	Filtrar por status: OPEN, CLOSED, PENDING
channelId	string	Não	Filtrar por ID do canal
assignedTo	string	Não	Filtrar por ID do atendente atribuído
departmentId	string	Não	Filtrar por ID do departamento
page	number	Não	Número da página. Padrão: 1
limit	number	Não	Quantidade de itens por página. Padrão: 20. Máximo: 100
sort	string	Não	Ordenação: updatedAt (padrão), createdAt, -updatedAt, -createdAt

---

Request Body

Nenhum. Este endpoint utiliza o método GET.

---

Response

200 - Success

Retorna a lista paginada de conversas.

{
  "data": [
    {
      "id": "6650f4c2e8b1a2d3f4567890",
      "channelId": "6650a1b2c3d4e5f6a7890123",
      "contact": {
        "id": "6650b2c3d4e5f6a7890124",
        "name": "Maria Silva",
        "phone": "5511999990001"
      },
      "assignedTo": {
        "id": "6650c3d4e5f6a7890125",
        "name": "João Atendente"
      },
      "departmentId": "6650d4e5f6a7890126",
      "status": "OPEN",
      "lastMessage": {
        "id": "6650e5f6a7890127",
        "content": "Boa tarde! Gostaria de saber sobre o produto X.",
        "direction": "INBOUND",
        "timestamp": "2025-06-10T14:30:00Z"
      },
      "unreadCount": 2,
      "createdAt": "2025-06-10T14:00:00Z",
      "updatedAt": "2025-06-10T14:30:00Z"
    },
    {
      "id": "6650f4c2e8b1a2d3f4567891",
      "channelId": "6650a1b2c3d4e5f6a7890123",
      "contact": {
        "id": "6650b2c3d4e5f6a7890128",
        "name": "Carlos Souza",
        "phone": "5511999990002"
      },
      "assignedTo": null,
      "departmentId": null,
      "status": "PENDING",
      "lastMessage": {
        "id": "6650e5f6a7890129",
        "content": "Olá, preciso de ajuda com meu pedido.",
        "direction": "INBOUND",
        "timestamp": "2025-06-10T14:25:00Z"
      },
      "unreadCount": 1,
      "createdAt": "2025-06-10T14:25:00Z",
      "updatedAt": "2025-06-10T14:25:00Z"
    }
  ],
  "meta": {
    "total": 2,
    "page": 1,
    "limit": 20
  }
}

401 - Unauthorized

Chave de API inválida ou ausente.

{
  "message": "Chave de API inválida ou expirada.",
  "code": "UNAUTHORIZED"
}

429 - Too Many Requests

Limite de requisições excedido.

{
  "message": "Limite de requisições excedido. Tente novamente em alguns segundos.",
  "code": "RATE_LIMIT_EXCEEDED"
}