Políticas de SLA

As políticas de SLA definem o alvo de tempo por prioridade: quantos minutos a equipe tem para a primeira resposta e para a resolução. Elas são a fonte dos campos firstResponseDueAt e resolutionDueAt do ticket, que por sua vez alimentam os indicadores de SLA estourado nas métricas.

O vínculo com o ticket é feito pela prioridade: ao criar um ticket ou mudar sua prioridade, a instância busca a política ativa daquela prioridade e calcula os alvos. Se não houver política ativa para a prioridade, os alvos ficam null.

Políticas padrão

Toda instância nasce com 4 políticas (uma por prioridade), criadas no setup inicial: Baixa (24h/72h), Normal (8h/24h), Alta (2h/8h) e Urgente (15min/4h) — todas em tempo corrido. Você pode editá-las ou substituí-las.

Headers obrigatórios

Todas as requisições devem incluir o header X-Helpdesk-Id (UUID) e Authorization: Bearer {token} com o token do agente (guard helpdeskAgent).

---

Estrutura de Dados Principal

Campo	Tipo	Descrição
id	Number	Identificador da política.
priority	String	Prioridade atendida: low, normal, high ou urgent.
name	String	Nome da política (máx. 150 caracteres).
firstResponseMinutes	Number	Minutos até a primeira resposta (mín. 1).
resolutionMinutes	Number	Minutos até a resolução (mín. 1).
isBusinessHoursOnly	Boolean	Conta apenas dentro do horário comercial (padrão: false).
isActive	Boolean	Política ativa — inativas não geram alvos.

Horário Comercial

Quando isBusinessHoursOnly é true, os minutos do SLA contam apenas dentro da janela configurada em settings.businessHours da instância, no timezone dela:

{
  "settings": {
    "businessHours": { "weekDays": [1, 2, 3, 4, 5], "start": "09:00", "end": "18:00" }
  }
}

• weekDays: dias da semana com expediente — 0 = domingo até 6 = sábado.
• start / end: janela diária no formato HH:mm (start deve ser menor que end).

Um SLA de 2h criado às 17:30 de sexta, com a configuração acima, vence às 10:30 de segunda. Se a configuração for inválida ou ausente, a política cai no cálculo em tempo corrido.

---

Endpoints

Listar Políticas de SLA

Lista as políticas da instância, com paginação, busca e filtros.

GET /v1/helpdesk/agent/sla-policies

Parâmetros de Query

Nome	Tipo	Obrigatório	Descrição
page	number	Não	O número da página (mínimo: 1).
perPage	number	Não	Itens por página (entre 1 e 100, padrão: 25).
search	string	Não	Busca por termo no nome (máx. 150 caracteres).
isActive	boolean	Não	Filtra por ativas/inativas.
orderBy	string	Não	Campo de ordenação: id, name ou createdAt.
orderDirection	string	Não	Direção: asc ou desc.

Respostas

200 OK

Retorna um objeto de paginação contendo a lista de políticas.

{
  "meta": {
    "currentPage": 1,
    "perPage": 25
  },
  "data": [
    {
      "id": 2,
      "priority": "normal",
      "name": "Normal",
      "firstResponseMinutes": 480,
      "resolutionMinutes": 1440,
      "isBusinessHoursOnly": false,
      "isActive": true,
      "createdAt": "2026-09-01T10:05:33.000+00:00",
      "updatedAt": "2026-09-01T10:05:33.000+00:00"
    }
  ]
}

Listar Políticas para Dropdown

Retorna as políticas em formato simplificado (value/label).

GET /v1/helpdesk/agent/sla-policies/list

Parâmetros de Query

Nome	Tipo	Obrigatório	Descrição
isActive	boolean	Não	Filtra por ativas/inativas.
limit	number	Não	Quantidade máxima de itens (entre 1 e 100).

Respostas

200 OK

Retorna um array com as políticas em formato value/label.

Obter Política por ID

GET /v1/helpdesk/agent/sla-policies/:id

Respostas

200 OK

Retorna os dados da política.

404 Not Found

Ocorre quando a política não existe na instância.

Criar Política de SLA

POST /v1/helpdesk/agent/sla-policies

Payload (Body)

Atributo	Tipo	Obrigatório	Descrição
priority	string	Sim	low, normal, high ou urgent.
name	string	Sim	Nome da política (máx. 150 caracteres).
firstResponseMinutes	number	Sim	Minutos até a primeira resposta (mín. 1).
resolutionMinutes	number	Sim	Minutos até a resolução (mín. 1).
isBusinessHoursOnly	boolean	Não	Conta apenas em horário comercial (padrão: false).
isActive	boolean	Não	Política ativa (padrão: true).

Exemplo de Requisição

curl -X POST "https://api.us.basis.tavares.in/v1/helpdesk/agent/sla-policies" \
  -H "X-Helpdesk-Id: 3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "priority": "urgent",
    "name": "Urgente (horário comercial)",
    "firstResponseMinutes": 30,
    "resolutionMinutes": 240,
    "isBusinessHoursOnly": true
  }'

Respostas

201 Created

Retorna o ID da política criada.

{
  "id": 5
}

Políticas com a mesma prioridade

Ao calcular os alvos de um ticket, a instância usa a política ativa encontrada para a prioridade vigente. Mantenha uma política ativa por prioridade para resultados previsíveis.

Atualizar Política de SLA

Todos os campos da criação são opcionais no update. Alterações não recalculam retroativamente os alvos de tickets já criados — valem para os próximos cálculos (criação e mudança de prioridade).

PUT /v1/helpdesk/agent/sla-policies/:id

Respostas

204 No Content

Atualização concluída com sucesso.

Remover Política de SLA

Remove uma política via soft delete. Tickets que já referenciam a política mantêm seus alvos gravados.

DELETE /v1/helpdesk/agent/sla-policies/:id

Respostas

204 No Content

Remoção concluída com sucesso.