Este método permite adicionar opções em um campo personalizado. Endpoint Autenticação Este endpoint utiliza autenticação Bearer Token. Caso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso. Parâmetros da requisição JSON de saída Possíveis erros

Este método permite atualizar, via API, um artigo da base de conhecimento. Endpoint Autenticação Este endpoint utiliza autenticação Bearer Token. Caso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso. Parâmetros da requisição JSON de saída Possíveis erros

Este método permite atualizar uma organização. Endpoint Autenticação Este endpoint utiliza autenticação Bearer Token. Caso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso. Parâmetros da requisição JSON de saída Possíveis erros Qualquer propriedade enviada de forma vazia será...

  Este método permite atualizar os dados de um cliente. Endpoint Autenticação Este endpoint utiliza autenticação Bearer Token. Caso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso. Parâmetros da requisição JSON de saída Possíveis erros Qualquer propriedade enviada vazia será...

Este endpoint permite avaliar um chamado finalizado via API. Endpoint Autenticação Este endpoint utiliza autenticação Bearer Token. Caso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso. Parâmetros da requisição JSON de saída Possíveis erros Observações O chamado precisa estar...

2.0 Lançamento da nova API, totalmente remodelada. Novos métodos e novo modo de autenticação. Data de lançamento: 21/05/2024 1.7.2 Lista de modificações na API: A listagem de clientes agora exibe se o cliente está ativo, com e-mail validado e conta aprovada. Data de lançamento: 21/02/2024 1.7.1 Lista de...

Este método permite adicionar um comentário em um chamado. Endpoint Autenticação Este endpoint utiliza autenticação Bearer Token. Caso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso. Parâmetros da requisição JSON de saída Possíveis erros

Este método permite listar todos os atendentes de um departamento da sua conta.  Endpoint Autenticação Este endpoint utiliza autenticação Bearer Token. Caso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso. Parâmetros da requisição JSON de saída Possíveis erros

Este método permite listar todos os campos personalizados da conta usados para chamados. Endpoint Autenticação Este endpoint utiliza autenticação Bearer Token. Caso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso. JSON de saída Possíveis erros  

Este método permite listar todos os campos personalizados da sua conta usados para cadastro de cliente. Endpoint Autenticação Este endpoint utiliza autenticação Bearer Token. Caso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso. JSON de saída Possíveis erros  

Este método permite listar todos os campos personalizados da sua conta usados para chamados externos por departamento e categoria. Endpoint Autenticação Este endpoint utiliza autenticação Bearer Token. Caso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso. Parâmetros da...

Este método permite listar todos os campos personalizados da sua conta usados para cadastro de organizações. Endpoint Autenticação Este endpoint utiliza autenticação Bearer Token. Caso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso. JSON de saída Possíveis erros  

Este método permite listar todos os campos personalizados de sua conta. Endpoint Autenticação Este endpoint utiliza autenticação Bearer Token. Caso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso. JSON de saída Possíveis erros  

Este método permite listar todas as carteiras de clientes cadastradas em sua conta. Endpoint Autenticação Este endpoint utiliza autenticação Bearer Token. Caso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso. JSON de saída Possíveis erros

Este método permite listar todas as categorias de um departamento da sua conta. Endpoint Autenticação Este endpoint utiliza autenticação Bearer Token. Caso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso. Parâmetros da requisição JSON de saída Possíveis erros

   Este endpoint permite consultar os detalhes completos de um chamado. Endpoint Autenticação Este endpoint utiliza autenticação Bearer Token. Parâmetros da requisição JSON de saída Possíveis erros Observações Os parâmetros devem ser enviados via query string. Use para retornar os horários...

  Este endpoint permite consultar os chamados criados na conta. Os resultados são paginados, com até 50 chamados por página. Utilize o parâmetro para navegar entre as páginas disponíveis. Endpoint Autenticação Este endpoint utiliza autenticação Bearer Token. Para utilizá-lo, é necessário possuir um Token de...

Este método permite obter informações de um chat de forma individual. Endpoint Autenticação Este endpoint utiliza autenticação Bearer Token. Caso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso. Parâmetros da requisição JSON de saída Possíveis erros

Este método permite listar todos os atendimentos de chat que sua conta possui. A consulta de chats exibe 50 itens por página, sendo necessário navegar entre as páginas para consultar outros resultados. Endpoint Autenticação Este endpoint utiliza autenticação Bearer Token. Caso ainda não possua um Token de Acesso...

Este método permite consultar os detalhes de um cliente.  Endpoint Autenticação Este endpoint utiliza autenticação Bearer Token. Caso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso. Parâmetros da requisição JSON de saída Possíveis erros

  Este método permite listar todos os seus clientes. A consulta de clientes exibe 50 itens por página, sendo necessário navegar entre as páginas para consultar outros resultados. Endpoint Autenticação Este endpoint utiliza autenticação Bearer Token. Caso ainda não possua um Token de Acesso, consulte o artigo...

Este método permite listar todos os departamentos da sua conta. Endpoint Autenticação Este endpoint utiliza autenticação Bearer Token. Caso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso. Parâmetros da requisição JSON de saída Possíveis erros

Este método permite consultar se um endereço de email de cliente está na blacklist para criação de chamados por email. Endpoint Autenticação Este endpoint utiliza autenticação Bearer Token. Caso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso. Parâmetros da requisição JSON de...

Este método permite verificar a existência de um cliente pelo endereço de e-mail ou identificador interno do cliente. Endpoint Autenticação Este endpoint utiliza autenticação Bearer Token. Case ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso. Parâmetros da requisição JSON de...

  Este método permite consultar o contrato de horas usadas vs horas contratadas pelo cliente durante o mês corrente. Endpoint Autenticação Este endpoint utiliza autenticação Bearer Token. Caso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso. Parâmetros da requisição JSON de...

Este método permite listar todas as suas organizações. A consulta de organizações exibe 50 itens por página, sendo necessário navegar entre as páginas para consultar outros resultados.  Endpoint Autenticação Este endpoint utiliza autenticação Bearer Token. Caso ainda não possua um Token de Acesso, consulte o...

Este método permite consultar as permissões básicas de um cliente. Endpoint Autenticação Este endpoint utiliza autenticação Bearer Token. Caso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso. Parâmetros da requisição JSON de saída Possíveis erros  

Este método permite listar todos os status de um departamento da sua conta.   Endpoint Autenticação Este endpoint utiliza autenticação Bearer Token. Caso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso. Parâmetros da requisição JSON de saída Possíveis erros

Formatação Técnica em Artigos Este artigo demonstra como criar documentação técnica utilizando os recursos avançados da Base de Conhecimento da TomTicket. Além da formatação tradicional de textos, títulos, tabelas e listas, também é possível documentar APIs, exemplos de código e estruturas JSON de forma padronizada...

Este método permite a criação de artigos para a base de conhecimento. Endpoint Autenticação Este endpoint utiliza autenticação Bearer Token. Caso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso. Parâmetros da requisição JSON de saída Possíveis erros Código de Retorno

Este método permite criar um novo chamado.  Endpoint Autenticação Este endpoint utiliza autenticação Bearer Token. Caso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso. Parâmetros da requisição JSON de saída Possíveis erros Observações Este método não realiza o envio de...

  Este método permite criar um novo cliente. Endpoint Autenticação Este endpoint utiliza autenticação Bearer Token. Caso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso. Parâmetros da requisição JSON de saída Possíveis erros

Este método permite criar uma organização. Endpoint Autenticação Este endpoint utiliza autenticação Bearer Token. Caso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso. Parâmetros da requisição JSON de saída Possíveis erros

  O Token de Acesso é a credencial utilizada para autenticar todas as requisições realizadas à API da TomTicket. Nunca compartilhe o seu Token de Acesso. Qualquer pessoa que possuir este token poderá realizar chamadas à API utilizando as permissões configuradas para ele. A criação e o gerenciamento de Tokens de...

O recurso de Data Dinâmica possibilita o uso de uma data gerada automaticamente com base na data e hora atuais, para uma nova data que será calculada com base nos parâmetros enviados. Este recurso é útil quando a aplicação que chama a API não possui a possibilidade de gerar um timestamp no padrão . Exemplo: Caso...

  Este método permite desvincular um departamento de um cliente. Endpoint Autenticação Este endpoint utiliza autenticação Bearer Token. Caso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso. Parâmetros da requisição JSON de saída Possíveis erros

Este método permite finalizar um chamado.  Endpoint Autenticação Este endpoint utiliza autenticação Bearer Token. Caso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso. Parâmetros da requisição JSON de saída Possíveis erros Este método não realiza o envio de e-mail após a...

Este endpoint permite gerar um token temporário para acesso ao Painel do Cliente, sem que o cliente precise realizar a autenticação manualmente. O token gerado possui validade de 5 minutos. Após esse período, ele expira automaticamente e será necessário gerar um novo token. Endpoint Autenticação Este endpoint...

Este método é utilizado para a leitura individual de artigos da base de conhecimento. Endpoint Autenticação Este endpoint utiliza autenticação Bearer Token. Caso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso. Parâmetros da requisição JSON de saída Código de Retorno

O limite de consultas, ou Rate Limit, é uma restrição de consultas que um usuário pode realizar na API dentro de um período de tempo. O rate limit da API é de 3 requisições por segundo. Caso as requisições ultrapassem o limite de 3 requisições por segundo, as três primeiras requisições serão executadas normalmente...

Permite listar os artigos cadastrados na Base de Conhecimento por meio da API do TomTicket. Endpoint Autenticação Este endpoint utiliza autenticação Bearer Token. Caso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso. Parâmetros da requisição JSON de saída

Este método permite listar todas as categorias de artigos da sua conta. Endpoint Autenticação Este endpoint utiliza autenticação Bearer Token. Caso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso. Parâmetros da requisição JSON de saída Possíveis erros

Este endpoint permite ativar ou desativar o acesso de um cliente. Essa configuração controla se o cliente poderá acessar o Painel do Cliente e criar chamados por e-mail. Ao desativar o acesso, o cliente não poderá acessar o Painel do Cliente nem criar novos chamados por e-mail. Endpoint Autenticação Este endpoint...

  Este método permite definir se um cliente pode ou não criar chamados. Endpoint Autenticação Este endpoint utiliza autenticação Bearer Token. Caso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso. Parâmetros da requisição JSON de saída Possíveis erros

Este método permite pesquisar artigos existentes em sua base de conhecimento. Endpoint Autenticação Este endpoint utiliza autenticação Bearer Token. Caso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso. Parâmetros da requisição JSON de saída Possíveis erros

Este método permite remover opções em um campo personalizado. Endpoint Autenticação Este endpoint utiliza autenticação Bearer Token. Caso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso. Parâmetros da requisição JSON de saída Possíveis erros  

  Este método permite responder um chamado como o atendente responsável. Somente será possível realizar essa operação se houver um atendente vinculado. Endpoint Autenticação Este endpoint utiliza autenticação Bearer Token. Caso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de...

Este método permite responder um chamado como cliente. Endpoint Autenticação Este endpoint utiliza autenticação Bearer Token. Caso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso. Parâmetros da requisição JSON de saída Possíveis erros Este método não realiza o envio de email...

Este método permite realizar o encerramento de um status aberto em um chamado. Endpoint Autenticação Este endpoint utiliza autenticação Bearer Token. Caso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso. Parâmetros da requisição JSON de saída Possíveis erros  

Este método permite realizar a abertura de um status em um chamado. Endpoint Autenticação Este endpoint utiliza autenticação Bearer Token. Caso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso. Parâmetros da requisição JSON de saída Possíveis erros

Este método permite realizar a transferência de um chamado entre atendentes e/ou departamentos. Endpoint Autenticação Este endpoint utiliza autenticação Bearer Token. Caso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso. Parâmetros da requisição JSON de saída Possíveis erros

Para facilitar a compreensão de nossa API e gerar exemplos de código para diversas linguagens, fornecemos o download de uma Collection do Postman. Esta Collection contém os métodos da versão mais recente da API, permitindo que seja gerado de modo rápido um código de exemplo e possibilitando realizar testes em sua...

Este método permite vincular um atendente em um chamado.  Endpoint Autenticação Este endpoint utiliza autenticação Bearer Token. Caso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso. Parâmetros da requisição JSON de saída Possíveis erros

  Este método permite vincular um departamento a um cliente. Endpoint Autenticação Este endpoint utiliza autenticação Bearer Token. Caso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso. Parâmetros da requisição JSON de saída Possíveis erros