Pular para o conteúdo principal

Help Desk e SLA

Chamados do help desk, os comentários de cada chamado e as políticas de SLA (só leitura).

Chamados​

Recurso do plano: Help Desk / Chamados.

MétodoRotaO que faz
GET/external/v1/ticketsLista com paginação
GET/external/v1/tickets/:idBusca um registro pelo ID
POST/external/v1/ticketsCria um registro
PUT/external/v1/tickets/:idAtualiza um registro

Listar​

Aceita page, limit e relations, como descrito em Paginação e filtros.

curl -G "https://erp-api.ideros.api.br/external/v1/tickets" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "x-company-token: $COMPANY_TOKEN" \
--data-urlencode "page=1" \
--data-urlencode "limit=25"

Buscar por ID​

curl "https://erp-api.ideros.api.br/external/v1/tickets/ID_DO_REGISTRO" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "x-company-token: $COMPANY_TOKEN"

Devolve o registro. Se o ID não existir ou for de outra empresa, a resposta é 200 com corpo {} (objeto vazio).

Criar​

Responde 201 com o registro criado.

CampoTipoObrigatórioDescrição
requestedByTypeenumSimTipo do solicitante do ticket. Valores: CUSTOMER, INTERNAL.
customerIdstringNãoID de pessoa. Representa o cliente solicitante.
companyUserIdstringNãoID de usuário da empresa. Representa o usuário interno solicitante.
contactNamestringNãoNome de contato do solicitante.
contactEmailstringNãoE-mail de contato do solicitante.
contactPhonestringNãoTelefone de contato do solicitante.
titlestringSimTítulo do ticket.
descriptionstringSimDescrição detalhada do ticket.
categoryenumSimCategoria do ticket. Valores: INCIDENT, REQUEST, QUESTION, PROBLEM, CHANGE.
subcategorystringNãoSubcategoria do ticket.
priorityenumSimPrioridade do ticket. Valores: CRITICAL, HIGH, MEDIUM, LOW.
assignedToUserIdstringNãoID de usuário da empresa. Representa o atendente responsável.
teamIdstringNãoID de unidade de negócio. Representa a equipe responsável.
businessUnitIdstringNãoID de unidade de negócio. Representa a unidade de negócio.
dueDatestring (data ISO 8601)NãoData limite para resolução do ticket.
estimatedEffortMinutesnumberNãoEsforço estimado em minutos.
watcherUserIdsstring[]NãoLista de IDs de usuários da empresa que observam o ticket.
executorUserIdsstring[]NãoLista de IDs de usuários da empresa que atuam como executores (2º atendente) do ticket.
watcherContactsobjectNãoObservadores externos do ticket (contatos por e-mail). Cada item: { name?, email }.
contractIdstringNãoID de contrato.
projectIdstringNãoID de projeto.
dealIdstringNãoID de negócio.
parentTicketIdstringNãoID do ticket pai.
sourceenumNãoOrigem do ticket. Valores: MANUAL, EMAIL, API, PORTAL, CHAT, SYSTEM.
inboundEmailMessageIdstringNãoID de e-mail recebido.
tagsstring[]NãoEtiquetas livres do chamado (lista de textos). O back apara espaços, descarta vazias e repetidas (sem diferenciar maiúsculas). Guarda até ${TICKET_TAG_MAX_COUNT} etiquetas; a que passar de ${TICKET_TAG_MAX_LENGTH} caracteres é cortada. Na edição: a lista substitui o conjunto, [] limpa e ausente mantém.
metadataobjectNãoObjeto JSON livre.
curl -X POST "https://erp-api.ideros.api.br/external/v1/tickets" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "x-company-token: $COMPANY_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"requestedByType": "CUSTOMER",
"title": "Erro ao acessar relatório",
"description": "Ao abrir o relatório financeiro aparece uma mensagem de erro.",
"category": "INCIDENT",
"priority": "HIGH"
}'

Atualizar​

Envie no corpo só os campos que mudam, com os mesmos nomes da tabela de criação. Responde 200 com o registro atualizado. Registro de outra empresa responde 403; registro inexistente, 404.

Comentários do chamado​

Recurso do plano: Help Desk / Chamados.

MétodoRotaO que faz
GET/external/v1/ticket-commentsLista com paginação
GET/external/v1/ticket-comments/:idBusca um registro pelo ID
POST/external/v1/ticket-commentsCria um registro

Listar​

Aceita page, limit e relations, como descrito em Paginação e filtros.

Exemplo com filtro (o valor de relations vai codificado para URL; aqui ele aparece legível: {"where":{"ticketId":"ID_DO_CHAMADO"}}):

curl -G "https://erp-api.ideros.api.br/external/v1/ticket-comments" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "x-company-token: $COMPANY_TOKEN" \
--data-urlencode "page=1" \
--data-urlencode "limit=25" \
--data-urlencode 'relations={"where":{"ticketId":"ID_DO_CHAMADO"}}'

Buscar por ID​

curl "https://erp-api.ideros.api.br/external/v1/ticket-comments/ID_DO_REGISTRO" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "x-company-token: $COMPANY_TOKEN"

Devolve o registro. Se o ID não existir ou for de outra empresa, a resposta é 200 com corpo {} (objeto vazio).

Criar​

Responde 201 com o registro criado.

CampoTipoObrigatórioDescrição
ticketIdstringSimID de chamado.
authorUserIdstringNãoID de usuário da empresa. Representa o autor do comentário.
authorCustomerIdstringNãoID de pessoa. Representa o cliente autor do comentário.
contentstringSimConteúdo do comentário (aceita HTML do editor rich text).
isInternalbooleanNãoIndica se o comentário é interno (visível apenas para atendentes).
visibleToCustomerbooleanNãoInteração pública visível para o cliente (portal e notificações). Padrão true; false esconde do cliente. Em nota interna é sempre false.
notifyTeambooleanNãoSe true, notifica o time interno (responsável + executores + observadores internos) in-app sobre esta interação. Se omitido/false, apenas registra.
mentionedUserIdsstring[]NãoIDs de usuários da empresa mencionados (@) na interação. Cada mencionado recebe notificação in-app dedicada.
metadataobjectNãoCampo genérico para guardar objetos estruturados como JSON (ex.: 'fileReferences' com os anexos da interação no formato 'id/nome/size').

Políticas de SLA​

Recurso do plano: Acordo de Nível de Serviço.

MétodoRotaO que faz
GET/external/v1/sla-policiesLista com paginação
GET/external/v1/sla-policies/:idBusca um registro pelo ID

Listar​

Aceita page, limit e relations, como descrito em Paginação e filtros.

curl -G "https://erp-api.ideros.api.br/external/v1/sla-policies" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "x-company-token: $COMPANY_TOKEN" \
--data-urlencode "page=1" \
--data-urlencode "limit=25"

Buscar por ID​

curl "https://erp-api.ideros.api.br/external/v1/sla-policies/ID_DO_REGISTRO" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "x-company-token: $COMPANY_TOKEN"

Devolve o registro. Se o ID não existir ou for de outra empresa, a resposta é 200 com corpo {} (objeto vazio).

Campos do registro​

Além de id, isActive, createdAt e updatedAt, o registro traz:

CampoTipoDescrição
namestringNome da política de SLA.
descriptionstringDescrição da política.
isDefaultbooleanDefine como política padrão da empresa.
workShiftIdstringID do turno de atendimento vinculado (WorkShift).
metadataobjectMetadados adicionais.
Ainda com dúvida?

A nossa equipe ajuda você a configurar e usar esse recurso.