Pular para o conteúdo principal

Buscar conversa

Método​

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

Conceituação​

Este endpoint retorna os dados completos de uma conversa específica, incluindo informações detalhadas do contato, canal, atendente atribuído, departamento, status e timestamps.

Utilize este endpoint para obter todos os detalhes de uma conversa antes de realizar operações como atribuição, transferência ou encerramento.

Atributos​

AtributoTipoObrigatórioDescrição
AuthorizationstringSimBearer {API_KEY} - Chave de autenticação

Parâmetros de URL​

AtributoTipoObrigatórioDescrição
idstringSimID da conversa

Request Body​

Nenhum. Este endpoint utiliza o método GET.

Response​

200 - Success​

Retorna os dados completos da conversa.

{
  "data": {
    "id": "6650f4c2e8b1a2d3f4567890",
    "channelId": "6650a1b2c3d4e5f6a7890123",
    "channel": {
      "id": "6650a1b2c3d4e5f6a7890123",
      "name": "WhatsApp Principal",
      "type": "WHATSAPP_BAILEYS",
      "phone": "5511999998888"
    },
    "contact": {
      "id": "6650b2c3d4e5f6a7890124",
      "name": "Maria Silva",
      "phone": "5511999990001",
      "email": "maria@email.com",
      "tags": ["vip", "recorrente"]
    },
    "assignedTo": {
      "id": "6650c3d4e5f6a7890125",
      "name": "João Atendente",
      "email": "joao@empresa.com"
    },
    "department": {
      "id": "6650d4e5f6a7890126",
      "name": "Suporte Técnico"
    },
    "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"
  }
}

400 - Bad Request​

ID da conversa inválido.

{
  "message": "O ID informado é inválido.",
  "code": "INVALID_OBJECT_ID"
}

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"
}