Transferir conversa

Método

PATCH https://oapi.ogmma.com.br/v1/conversations/:id/transfer

Conceituação

Este endpoint permite transferir uma conversa para outro departamento ou para um atendente específico. A transferência mantém todo o histórico da conversa e apenas altera o responsável pelo atendimento.

Você pode transferir por departamento (a conversa entra na fila do departamento) ou diretamente para um atendente específico. Informe apenas um dos campos: departmentId ou attendantId.

---

Atributos

Header

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

Parâmetros de URL

Atributo	Tipo	Obrigatório	Descrição
id	string	Sim	ID da conversa a ser transferida

Body

Atributo	Tipo	Obrigatório	Descrição
departmentId	string	Condicional	ID do departamento de destino. Obrigatório se attendantId não for informado
attendantId	string	Condicional	ID do atendente de destino. Obrigatório se departmentId não for informado

Nota

Informe apenas um dos campos: departmentId ou attendantId. Caso ambos sejam informados, o attendantId terá prioridade.

---

Request Body

Transferir para departamento

{
  "departmentId": "6650d4e5f6a7890126"
}

Transferir para atendente

{
  "attendantId": "6650c3d4e5f6a7890130"
}

---

Response

200 - Success

A conversa foi transferida com sucesso.

Transferência para departamento

{
  "data": {
    "id": "6650f4c2e8b1a2d3f4567890",
    "channelId": "6650a1b2c3d4e5f6a7890123",
    "contact": {
      "id": "6650b2c3d4e5f6a7890124",
      "name": "Maria Silva",
      "phone": "5511999990001"
    },
    "assignedTo": null,
    "department": {
      "id": "6650d4e5f6a7890126",
      "name": "Suporte Técnico"
    },
    "status": "PENDING",
    "updatedAt": "2025-06-10T14:40:00Z"
  }
}

Transferência para atendente

{
  "data": {
    "id": "6650f4c2e8b1a2d3f4567890",
    "channelId": "6650a1b2c3d4e5f6a7890123",
    "contact": {
      "id": "6650b2c3d4e5f6a7890124",
      "name": "Maria Silva",
      "phone": "5511999990001"
    },
    "assignedTo": {
      "id": "6650c3d4e5f6a7890130",
      "name": "Ana Supervisora"
    },
    "department": {
      "id": "6650d4e5f6a7890126",
      "name": "Suporte Técnico"
    },
    "status": "OPEN",
    "updatedAt": "2025-06-10T14:40:00Z"
  }
}

400 - Bad Request

Parâmetros inválidos na requisição.

{
  "message": "Informe 'departmentId' ou 'attendantId' para realizar a transferência.",
  "code": "VALIDATION_ERROR"
}

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