Pular para o conteúdo principal

Atribuir conversa

Método

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

Conceituação

Este endpoint permite atribuir uma conversa a um atendente específico. Quando uma conversa é atribuída, o atendente passa a ser o responsável pelo atendimento daquele contato.

A atribuição altera automaticamente o status da conversa de PENDING para OPEN, caso ela esteja aguardando atendimento.

Caso a conversa já esteja atribuída a outro atendente, a atribuição é atualizada para o novo atendente informado.


Atributos

AtributoTipoObrigatórioDescrição
AuthorizationstringSimBearer {API_KEY} - Chave de autenticação
Content-TypestringSimapplication/json

Parâmetros de URL

AtributoTipoObrigatórioDescrição
idstringSimID da conversa

Body

AtributoTipoObrigatórioDescrição
attendantIdstringSimID do atendente que receberá a conversa

Request Body

{
"attendantId": "6650c3d4e5f6a7890125"
}

Response

200 - Success

A conversa foi atribuída com sucesso.

{
"data": {
"id": "6650f4c2e8b1a2d3f4567890",
"channelId": "6650a1b2c3d4e5f6a7890123",
"contact": {
"id": "6650b2c3d4e5f6a7890124",
"name": "Maria Silva",
"phone": "5511999990001"
},
"assignedTo": {
"id": "6650c3d4e5f6a7890125",
"name": "João Atendente"
},
"status": "OPEN",
"updatedAt": "2025-06-10T14:35:00Z"
}
}

400 - Bad Request

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

{
"message": "O campo 'attendantId' é obrigatório.",
"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"
}