Listar Departamentos

Retornar lista de departamentos via API no TomTicket.


Endpoint

https://api.tomticket.com/departamentos/{token}


ColunaDescrição
tokenToken de acesso único e secreto para sua empresa. Clique aqui para ver como criar.


Método

GET


Retorno

O retorno é feito no formato JSON.




ColunaDescriçãoTipo
erroInforma se ocorreu um erro na operação. Se o retorno for false, então significa que a operação ocorreu com sucesso e não ocorreram problemas.
Caso o retorno seja true, ocorreu um erro e será necessário verificar o campo mensagem para identificar o problema.
Boolean
mensagemDetalhes da operação, caso tenha ocorrido ou não um problema.String
idIdentificador do departamento.String
nomeNome do departamento.String
onlineRetorna um boolean, true para se houver atendentes online no chat e false para atendimento offline.

true - Há atendentes online no departamento
false - Não há atendentes online no departamento
Boolean
categoriasLista com as categorias disponíveis para aquele departamento.Array
categorias
id
Identificador da categoria.String
categorias
nome
Nome da categoria.String
camposLista com os campos personalizados para abetura de chamado disponíveis para aquele departamento.Array
campos
id
Identificador do campo personalizado.String
campos
label
Label do campo personalizado.String
campos
mascara
Máscara de formatação.String
campos
oculto
Boolean informando se o campo em questão deve ficar oculto para o cadastro de chamados para o cliente.

true - Não pode ser exibido para o cliente
false - Deve ser exibido para o cliente
Boolean
campos
oculto
Lista com os valores do campo personalizado.Array
campos
obrigatorio

Boolean que define se o campo tem preenchimento obrigatório.

true - Deve ser informado pelo cliente
false - Não possui preenchimento obrigatório
Boolean
statusLista com status vinculados ao departamento.Array
status
id
Identificador do status.String
status
descricao
Nome do status.String
status
ativo
Retorna um boolean informando se o status está ativo ou não.

true - Está ativo
false - Está inativo
Boolean
atendentesLista com atendentes vinculados ao departamento.Array
atendentes
id
Identificador do atendente.String
atendentes
nome
Nome do atendente.String



Was this article helpful?  
We appreciate your review.