📘 Documentação Neppo Chat API | 🏠 Visão Geral (índice) · 🔎 Guia de Busca · 📦 Modelos de Dados
- O que você pode fazer com este módulo
- Exemplo de chamada
- Referência técnica completa
- V1 — pause-reason-controller (4 endpoints)
- V2 — pause-reason-controller-v-2 (2 endpoints)
O que é este módulo?
Gerencia os motivos de pausa dos atendentes — razões pré-definidas que o atendente seleciona ao sair da fila.
| Quem usa | Gestores de operação, RH, analytics. |
|---|---|
| Problema que resolve | Sem controle de motivos de pausa, não é possível distinguir pausas legítimas (almoço, reunião) de ausências não justificadas. |
| Impacto na experiência do cliente | Com atendentes melhor gerenciados, os clientes encontram mais atendentes disponíveis quando precisam. |
O que você pode fazer com este módulo
| Operação | O que faz (em linguagem simples) |
|---|---|
| Listar motivos | Retorna todos os motivos de pausa configurados. |
| Criar motivo | Adiciona um novo motivo ao catálogo. |
| Atualizar motivo | Modifica a descrição ou ativa/desativa um motivo. |
Exemplo de chamada
Substitua SEU_TOKEN_AQUI pelo Bearer token obtido via OAuth2.
curl -X POST "https://hml-chat-api.neppo.com.br/api/v1/pause-reasons/unique" \
-H "Authorization: Bearer SEU_TOKEN_AQUI" \
-H "Content-Type: application/json" \
-d '{
"conditions": [
{
"key": "id",
"value": "42",
"operator": "EQNUM"
}
]
}'Exemplo de resposta (200 OK):
{
"active": true,
"controlPauseTime": true,
"createdAt": "2024-01-01T00:00:00Z",
"createdBy": "string",
"id": 0,
"notifySupervisor": true,
"pauseChat": true,
"pauseChatByVoice": true,
"pauseTime": 0,
"pauseVoice": true,
"updatedAt": "2024-01-01T00:00:00Z",
"updatedBy": "string",
"value": "string"
}Valores ilustrativos (esqueleto do schema). Os campos retornados seguem o modelo de dados do recurso.
Endpoints de listagem (findAll) e busca (findOne) deste módulo recebem um corpo com filtros (conditions) e paginação. Veja como montar o corpo de busca no guia: .
Referência técnica completa
V1 — pause-reason-controller (4 endpoints)
/api/pause-reasons
findAll · operationId: findAllUsingPOST_85
Auth: Application & Application User | Escopos: read
Parâmetros
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| Authorization | header | string | Não | Bearer token |
Request body (obrigatório): CustomPageRequest
Exemplo de corpo:
{
"conditions": [
{
"key": "status",
"value": "OFFLINE",
"operator": "EQ",
"logic": "AND"
}
],
"page": 0,
"size": 10
}Respostas
| Código | Descrição | Schema |
|---|---|---|
| 200 | OK | PageResponse«PauseReason» |
| 201 | Created | — |
| 401 | Unauthorized | — |
| 403 | Forbidden | — |
| 404 | Not Found | — |
Exemplo de resposta (200 OK):
{
"page": 0,
"size": 10,
"results": [
{
"active": true,
"controlPauseTime": true,
"createdAt": "2024-01-01T00:00:00Z",
"createdBy": "string",
"id": 0,
"notifySupervisor": true,
"pauseChat": true,
"pauseChatByVoice": true,
"pauseTime": 0,
"pauseVoice": true,
"updatedAt": "2024-01-01T00:00:00Z",
"updatedBy": "string",
"value": "string"
}
]
} /api/pause-reasons/unique
findOne · operationId: findOneUsingPOST_81
Auth: Application & Application User | Escopos: read
Parâmetros
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| Authorization | header | string | Não | Bearer token |
Request body (obrigatório): CustomRequest
Exemplo de corpo:
{
"conditions": [
{
"key": "id",
"value": "42",
"operator": "EQNUM"
}
]
}Respostas
| Código | Descrição | Schema |
|---|---|---|
| 200 | OK | PauseReason |
| 201 | Created | — |
| 401 | Unauthorized | — |
| 403 | Forbidden | — |
| 404 | Not Found | — |
Exemplo de resposta (200 OK):
{
"active": true,
"controlPauseTime": true,
"createdAt": "2024-01-01T00:00:00Z",
"createdBy": "string",
"id": 0,
"notifySupervisor": true,
"pauseChat": true,
"pauseChatByVoice": true,
"pauseTime": 0,
"pauseVoice": true,
"updatedAt": "2024-01-01T00:00:00Z",
"updatedBy": "string",
"value": "string"
} /api/v1/pause-reasons
findAll · operationId: findAllUsingPOST_86
Auth: Application & Application User | Escopos: read
Parâmetros
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| Authorization | header | string | Não | Bearer token |
Request body (obrigatório): CustomPageRequest
Exemplo de corpo:
{
"conditions": [
{
"key": "status",
"value": "OFFLINE",
"operator": "EQ",
"logic": "AND"
}
],
"page": 0,
"size": 10
}Respostas
| Código | Descrição | Schema |
|---|---|---|
| 200 | OK | PageResponse«PauseReason» |
| 201 | Created | — |
| 401 | Unauthorized | — |
| 403 | Forbidden | — |
| 404 | Not Found | — |
Exemplo de resposta (200 OK):
{
"page": 0,
"size": 10,
"results": [
{
"active": true,
"controlPauseTime": true,
"createdAt": "2024-01-01T00:00:00Z",
"createdBy": "string",
"id": 0,
"notifySupervisor": true,
"pauseChat": true,
"pauseChatByVoice": true,
"pauseTime": 0,
"pauseVoice": true,
"updatedAt": "2024-01-01T00:00:00Z",
"updatedBy": "string",
"value": "string"
}
]
} /api/v1/pause-reasons/unique
findOne · operationId: findOneUsingPOST_82
Auth: Application & Application User | Escopos: read
Parâmetros
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| Authorization | header | string | Não | Bearer token |
Request body (obrigatório): CustomRequest
Exemplo de corpo:
{
"conditions": [
{
"key": "id",
"value": "42",
"operator": "EQNUM"
}
]
}Respostas
| Código | Descrição | Schema |
|---|---|---|
| 200 | OK | PauseReason |
| 201 | Created | — |
| 401 | Unauthorized | — |
| 403 | Forbidden | — |
| 404 | Not Found | — |
Exemplo de resposta (200 OK):
{
"active": true,
"controlPauseTime": true,
"createdAt": "2024-01-01T00:00:00Z",
"createdBy": "string",
"id": 0,
"notifySupervisor": true,
"pauseChat": true,
"pauseChatByVoice": true,
"pauseTime": 0,
"pauseVoice": true,
"updatedAt": "2024-01-01T00:00:00Z",
"updatedBy": "string",
"value": "string"
}V2 — pause-reason-controller-v-2 (2 endpoints)
/api/v2/pause-reasons
findAll · operationId: findAllUsingPOST_87
Auth: Application & Application User | Escopos: read
Parâmetros
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| Authorization | header | string | Não | Bearer token |
Request body (obrigatório): CustomPageRequest
Exemplo de corpo:
{
"conditions": [
{
"key": "status",
"value": "OFFLINE",
"operator": "EQ",
"logic": "AND"
}
],
"page": 0,
"size": 10
}Respostas
| Código | Descrição | Schema |
|---|---|---|
| 200 | OK | PageResponse«PauseReason» |
| 201 | Created | — |
| 401 | Unauthorized | — |
| 403 | Forbidden | — |
| 404 | Not Found | — |
Exemplo de resposta (200 OK):
{
"page": 0,
"size": 10,
"results": [
{
"active": true,
"controlPauseTime": true,
"createdAt": "2024-01-01T00:00:00Z",
"createdBy": "string",
"id": 0,
"notifySupervisor": true,
"pauseChat": true,
"pauseChatByVoice": true,
"pauseTime": 0,
"pauseVoice": true,
"updatedAt": "2024-01-01T00:00:00Z",
"updatedBy": "string",
"value": "string"
}
]
} /api/v2/pause-reasons/unique
findOne · operationId: findOneUsingPOST_83
Auth: Application & Application User | Escopos: read
Parâmetros
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| Authorization | header | string | Não | Bearer token |
Request body (obrigatório): CustomRequest
Exemplo de corpo:
{
"conditions": [
{
"key": "id",
"value": "42",
"operator": "EQNUM"
}
]
}Respostas
| Código | Descrição | Schema |
|---|---|---|
| 200 | OK | PauseReason |
| 201 | Created | — |
| 401 | Unauthorized | — |
| 403 | Forbidden | — |
| 404 | Not Found | — |
Exemplo de resposta (200 OK):
{
"active": true,
"controlPauseTime": true,
"createdAt": "2024-01-01T00:00:00Z",
"createdBy": "string",
"id": 0,
"notifySupervisor": true,
"pauseChat": true,
"pauseChatByVoice": true,
"pauseTime": 0,
"pauseVoice": true,
"updatedAt": "2024-01-01T00:00:00Z",
"updatedBy": "string",
"value": "string"
}
Comentários
0 comentário
Escreva seu comentário aqui
Por favor, entre para comentar.