StartAPI

API

 É possível criar um token de acesso rápido ao sistema, sem que o cliente necessite realizar login na plataforma.Para isso é necessário utilizar a API para gerar esse endereço, que terá validade de 5 minutos.Endpointhttps://api.tomticket.com/criar_acesso_cliente/{token}ColunaDescriçãotokenToken de acesso único e secreto…

Este método permite adicionar opções em um campo personalizado.Endpointhttps://api.tomticket.com/v2.0/custom_field/option/addMétodo HTTPPOSTContent Typeform-dataAutenticaçãoAuthorization: Bearer {SEU-TOKEN-AQUI}Parâmetros de RequisiçãoChaveDescriçãoObrigatórioValor PadrãoTipoTamanho Máximocustom_field_idIdentificador do campo personalizado.Sim-String250valueValor a ser adicionado no campo personalizado.Sim-String-sortBoolean para ordernar a exibição dos valores do campo.Opções Disponíveis:0 - Não Ordenar1 - OrdenarNão-String1RetornoDescrição…

É possível ativar/desativar um cliente para que ele não possua mais acesso ao sistema.Endpointhttps://api.tomticket.com/customer/status/{token}/{identificador}/{tipo_identificador}ColunaDescriçãotokenToken de acesso único e secreto para sua empresa. Clique aqui para ver como criar.identificadorIdentificador do clientetipo_identificadorTipo de identificador para localizar o cliente. I-Identificador Interno (Padrão) /…

Para realizar a alteração das informações de um cliente via API no TomTicket.Endpointhttps://api.tomticket.com/update_cliente/{token}/{identificador}/{tipo_identificador}ColunaDescriçãotokenToken de acesso único e secreto para sua empresa. Clique aqui para ver como criar.identificadorIdentificador do cliente. Pode ser o email do cliente ou o identificador interno no…

Este método permite atualizar uma organização. Endpointhttps://api.tomticket.com/v2.0/organization/updateMétodo HTTPPOSTContent Typeform-dataAutenticaçãoAuthorization: Bearer {SEU-TOKEN-AQUI}Parâmetros de RequisiçãoChaveDescriçãoObrigatórioValor PadrãoTipoTamanho Máximoorganization_idIdentificador da organização.Não-String250nameNome da organização.Não-String250emailEndereço de email da organização.Não-String250manager_see_all_ticketsPermissão para os gerentes da organização poderem visualizar chamados de seus membros.Opções Disponíveis:0 - Não Permite1 - PermiteNão1Int-team_see_all_ticketsPermissão para…

Este método permite atualizar os dados de um cliente. Endpointhttps://api.tomticket.com/v2.0/customer/updateMétodo HTTPPOSTContent Typeform-dataAutenticaçãoAuthorization: Bearer {SEU-TOKEN-AQUI}Parâmetros de RequisiçãoChaveDescriçãoObrigatórioValor PadrãoTipoTamanho Máximocustomer_idIdentificador interno do cliente para realizar a busca e atualização das informações. Pode ser o endereço de email do cadastro ou identificador interno utilizado.Sim-String250customer_type_idTipo…

Para modificar as permissões de criação de chamado para um cliente via API no TomTicket.Endpointhttps://api.tomticket.com/bloqueio_criacao_chamado/{token}/{idcliente}ColunaDescriçãotokenToken de acesso único e secreto para sua empresa. Clique aqui para ver como criar.idclienteIdentificador do cliente, deverá ser o identificador interno usado no cadastro do…

Para verificar se um endereço de email está na blacklist via API no TomTicket.Endpointhttps://api.tomticket.com/kb/busca/{token}/{termo_pesquisa}ColunaDescriçãotokenToken de acesso único e secreto para sua empresa. Clique aqui para ver como criar.termo_pesquisaTermo de pesquisa a ser usado na busca. Deve possuir mais de três…

2.0Lançamento da nova API, totalmente remodelada.Novos métodos e novo modo de autenticação.Data de Lançamento: 21/05/20241.7.2Lista de modificações na API:A listagem de clientes agora exibe se o mesmo está ativo, com email validado e conta aprovada.Data de Lançamento: 21/02/20241.7.1Lista de modificações…

Este método permite adicionar um comentário em um chamado.Endpointhttps://api.tomticket.com/v2.0/ticket/commentMétodo HTTPPOSTContent Typeform-dataAutenticaçãoAuthorization: Bearer {SEU-TOKEN-AQUI}Parâmetros de RequisiçãoChaveDescriçãoObrigatórioValor PadrãoTipoTamanho Máximoticket_idIdentificador do chamado.Sim-String250commentMensagem do comentário.Sim-String512attachmentLista com todos os anexos do tipo FILES. O tamanho máximo da requisição (com anexos) tem um limite de 25…

Este método permite listar todos os campos personalizados de sua conta usados para chamados.Endpointhttps://api.tomticket.com/v2.0/custom_field/ticket/listMétodo HTTPGETContent Typeform-dataAutenticaçãoAuthorization: Bearer {SEU-TOKEN-AQUI}RetornoDescrição do retorno em JSON.ColunaDescrição da ColunaTipoerrorInforma se ocorreu um erro na operação. Se o retorno for false, então significa que a operação…

Este método permite listar todos os campos personalizados de sua conta usados para cadastro de cliente.Endpointhttps://api.tomticket.com/v2.0/custom_field/customer/listMétodo HTTPGETContent Typeform-dataAutenticaçãoAuthorization: Bearer {SEU-TOKEN-AQUI}RetornoDescrição do retorno em JSON.ColunaDescrição da ColunaTipoerrorInforma se ocorreu um erro na operação. Se o retorno for false, então significa que…

Este método permite listar todos os campos personalizados de sua conta usados para cadastro de organizações.Endpointhttps://api.tomticket.com/v2.0/custom_field/organization/listMétodo HTTPGETContent Typeform-dataAutenticaçãoAuthorization: Bearer {SEU-TOKEN-AQUI}RetornoDescrição do retorno em JSON.ColunaDescrição da ColunaTipoerrorInforma se ocorreu um erro na operação. Se o retorno for false, então significa que…

Este método permite listar todos os campos personalizados de sua conta.Endpointhttps://api.tomticket.com/v2.0/custom_field/general/listMétodo HTTPGETContent Typeform-dataAutenticaçãoAuthorization: Bearer {SEU-TOKEN-AQUI}RetornoDescrição do retorno em JSON.ColunaDescrição da ColunaTipoerrorInforma se ocorreu um erro na operação. Se o retorno for false, então significa que a operação ocorreu com sucesso…

Este método permite listar todas as carteiras de clientes cadastradas em sua conta.Endpointhttps://api.tomticket.com/v2.0/portfolio/listMétodo HTTPGETContent Typeform-dataAutenticaçãoAuthorization: Bearer {SEU-TOKEN-AQUI}RetornoDescrição do retorno em JSON.ColunaDescrição da ColunaTipoerrorInforma se ocorreu um erro na operação. Se o retorno for false, então significa que a operação ocorreu…

Este método permite consultar os detalhes de um chamado.Endpointhttps://api.tomticket.com/v2.0/ticket/detailMétodo HTTPGETContent Typeform-dataAutenticaçãoAuthorization: Bearer {SEU-TOKEN-AQUI}Parâmetros Query StringOs parâmetros Query String são enviadas diretamente na URL após o símbolo de "?" ao final do endpoint. Cada parâmetro e valor deve ser enviado com…

Este método permite consultar todos os chamados criados em sua conta.A consulta de chamados exibe 50 itens por página, sendo necessário navegar entre as páginas para consultar outros resultados.Endpointhttps://api.tomticket.com/v2.0/ticket/listMétodo HTTPGETContent Typeform-dataAutenticaçãoAuthorization: Bearer {SEU-TOKEN-AQUI}Parâmetros Query StringOs parâmetros Query String são enviadas…

Este método permite obter informações de um chat de forma individual.Endpointhttps://api.tomticket.com/v2.0/chat/detailMétodo HTTPGETContent Typeform-dataAutenticaçãoAuthorization: Bearer {SEU-TOKEN-AQUI}Parâmetros Query StringOs parâmetros Query String são enviadas diretamente na URL após o símbolo de "?" ao final do endpoint. Cada parâmetro e valor deve ser…

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.Endpointhttps://api.tomticket.com/v2.0/chat/listMétodo HTTPGETContent Typeform-dataAutenticaçãoAuthorization: Bearer {SEU-TOKEN-AQUI}Parâmetros Query StringOs parâmetros Query String…

Este método permite consultar os detalhes de um cliente.Endpointhttps://api.tomticket.com/v2.0/customer/detailsMétodo HTTPGETContent Typeform-dataAutenticaçãoAuthorization: Bearer {SEU-TOKEN-AQUI}Parâmetros Query StringOs parâmetros Query String são enviadas diretamente na URL após o símbolo de "?" ao final do endpoint. Cada parâmetro e valor deve ser enviado com…

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.Endpointhttps://api.tomticket.com/v2.0/customer/listMétodo HTTPGETContent Typeform-dataAutenticaçãoAuthorization: Bearer {SEU-TOKEN-AQUI}Parâmetros Query StringOs parâmetros Query String são enviadas diretamente na URL…

Este método permite listar todos os departamentos de sua conta usados.Endpointhttps://api.tomticket.com/v2.0/department/listMétodo HTTPGETContent Typeform-dataAutenticaçãoAuthorization: Bearer {SEU-TOKEN-AQUI}RetornoDescrição do retorno em JSON.ColunaDescrição da ColunaTipoerrorInforma se ocorreu um erro na operação. Se o retorno for false, então significa que a operação ocorreu com sucesso…

Este método permite consultar se um endereço de email de cliente está na blacklist para criação de chamados por emai.Endpointhttps://api.tomticket.com/v2.0/customer/blacklist/searchMétodo HTTPGETContent Typeform-dataAutenticaçãoAuthorization: Bearer {SEU-TOKEN-AQUI}Parâmetros Query StringOs parâmetros Query String são enviadas diretamente na URL após o símbolo de "?" ao…

Este método permite verificar a existência de um cliente pelo endereço de email ou identificador interno do cliente.Endpointhttps://api.tomticket.com/v2.0/customers/existsMétodo HTTPGETContent Typeform-dataAutenticaçãoAuthorization: Bearer {SEU-TOKEN-AQUI}Parâmetros Query StringOs parâmetros Query String são enviadas diretamente na URL após o símbolo de "?" ao final do…

Este método permite consultar o contrato de horas usadas vs horas contratadas pelo cliente durante o mês corrente.Endpointhttps://api.tomticket.com/v2.0/customer/hourcontractMétodo HTTPGETAutenticaçãoAuthorization: Bearer {SEU-TOKEN-AQUI}Parâmetros Query StringOs parâmetros Query String são enviadas diretamente na URL após o símbolo de "?" ao final do endpoint.…

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.Endpointhttps://api.tomticket.com/v2.0/organization/listMétodo HTTPGETContent Typeform-dataAutenticaçãoAuthorization: Bearer {SEU-TOKEN-AQUI}Parâmetros Query StringOs parâmetros Query String são enviadas diretamente na URL…

Este método permite consultar as permissões básicas de um cliente.Endpointhttps://api.tomticket.com/v2.0/customer/permissions/basicMétodo HTTPGETContent Typeform-dataAutenticaçãoAuthorization: Bearer {SEU-TOKEN-AQUI}Parâmetros Query StringOs parâmetros Query String são enviadas diretamente na URL após o símbolo de "?" ao final do endpoint. Cada parâmetro e valor deve ser enviado…

Este método permite criar um novo chamado.Endpointhttps://api.tomticket.com/v2.0/ticket/newMétodo HTTPPOSTContent Typeform-dataAutenticaçãoAuthorization: Bearer {SEU-TOKEN-AQUI}Parâmetros de RequisiçãoChaveDescriçãoObrigatórioValor PadrãoTipoTamanho Máximocustomer_idIdentificador interno ou e-mail do clienteSim-String250customer_id_typeTipo de identificador utilizado, sendo:I - Identificador internoE - EmailNãoIString1department_idIdentificador do departamento.Sim-String250subjectTítulo do chamado.Sim-String250messageConteúdo da mensagem de abertura do chamado. Esta…

Este método permite criar um novo cliente.Endpointhttps://api.tomticket.com/v2.0/customer/newMétodo HTTPPOSTContent Typeform-dataAutenticaçãoAuthorization: Bearer {SEU-TOKEN-AQUI}Parâmetros de RequisiçãoChaveDescriçãoObrigatórioValor PadrãoTipoTamanho Máximocustomer_idIdentificador interno do cliente. Recomendamos utilizar um identificador que seja fácil associar aos dados de sua empresa, como uma chave primária em sistema, CPF ou CNPJ…

Este método permite criar uma organização. Endpointhttps://api.tomticket.com/v2.0/organization/newMétodo HTTPPOSTContent Typeform-dataAutenticaçãoAuthorization: Bearer {SEU-TOKEN-AQUI}Parâmetros de RequisiçãoChaveDescriçãoObrigatórioValor PadrãoTipoTamanho MáximonameNome da organização.Sim-String250emailEndereço de email da organização.Não-String250manager_see_all_ticketsPermissão para os gerentes da organização poderem visualizar chamados de seus membros.Opções Disponíveis:0 - Não Permite1 - PermiteNão1Int-create_ticketsPermissão para criar chamados.Opções…

Para realizar a criação de um chamado via API no TomTicket.Endpointhttps://api.tomticket.com/criar_chamado/{token}/{identificador_cliente}ColunaDescriçãotokenToken de acesso único e secreto para sua empresa. Clique aqui para ver como criar.identificador_clienteIdentificador do cliente. Pode ser o email do cliente ou o identificador interno no cadastro do…

Para realizar a criação de um cliente via API no TomTicket.Endpointhttps://api.tomticket.com/criar_cliente/{token}ColunaDescriçãotokenToken de acesso único e secreto para sua empresa. Clique aqui para ver como criar.MétodoPOSTContent-Typeform-dataParâmetrosColunaDescriçãoTipoTamanho MáximoParâmetros ObrigatóriosidentificadorIdentificador do cliente dentro do seu sistema.String250nomeNome completo do cliente.String250Parâmetros OpcionaisemailEndereço de email do…

Para realizar a criação de uma organização via API no TomTicket.Endpointhttps://api.tomticket.com/criar_organizacao/{token}ColunaDescriçãotokenToken de acesso único e secreto para sua empresa. Clique aqui para ver como criar.MétodoPOSTContent-Typeform-dataParâmetrosColunaDescriçãoTipoTamanho MáximoParâmetros ObrigatóriosnomeNome completo da organização.String250Parâmetros OpcionaisemailEndereço de email para contato da organização.String250telefoneNúmero de telefone de…

 O Token de Acesso é uma chave necessária para realizar a comunicação com a API.Esse token não pode ser divulgado em hipótese alguma, pois ele permite o acesso completo a API.A criação e edição do token requer que o usuário…

Este método permite desvincular um departamento de um cliente.Endpointhttps://api.tomticket.com/v2.0/customer/department/unlinkMétodo HTTPPOSTContent Typeform-dataAutenticaçãoAuthorization: Bearer {SEU-TOKEN-AQUI}Parâmetros de RequisiçãoChaveDescriçãoObrigatórioValor PadrãoTipoTamanho Máximocustomer_idIdentificador interno do cliente para realizar a busca e atualização das informações. Pode ser o endereço de email do cadastro ou identificador interno utilizado.Sim-String250configurationIdentificador…

Retornar informações de um cliente via API no TomTicket.Endpointhttps://api.tomticket.com/cliente/detalhes/{token}/{identificador}/{tipo_identificador}ColunaDescriçãotokenToken de acesso único e secreto para sua empresa. Clique aqui para ver como criar.identificadorIdentificador do cliente. Pode ser o email do cliente ou o identificador interno no cadastro do clientetipo_identificadorI -…

Para encerrar um status aberto num chamado via API no TomTicket.Endpointhttps://api.tomticket.com/ticket/status/close/{token}ColunaDescriçãotokenToken de acesso único e secreto para sua empresa. Clique aqui para ver como criar.MétodoPOSTContent-TypeForm-dataParâmetrosColunaDescriçãoTipoTamanho MáximoParâmetros Obrigatóriosticket_idIdentificador do chamado.String250RetornoO retorno é feito no formato JSON.ColunaDescriçãoTipoerroInforma se ocorreu um erro na…

Este método permite finalizar um chamado.Endpointhttps://api.tomticket.com/v2.0/ticket/finishMétodo HTTPPOSTContent Typeform-dataAutenticaçãoAuthorization: Bearer {SEU-TOKEN-AQUI}Parâmetros de RequisiçãoChaveDescriçãoObrigatórioValor PadrãoTipoTamanho Máximoticket_idIdentificador do chamado.Sim-String250messageConteúdo da mensagem de finalização do chamado. Esta mensagem é enviada no formato text/plain (texto puro).Sim-String-attachmentLista com todos os anexos do tipo FILES. O tamanho…

Este método permite criar um token para acesso ao Painel do Cliente, sem necessidade de autenticação do cliente no Painel do Cliente.O token gerado possui uma vida útil de cinco minutos a partir do momento que foi criado. Após esse…

A API do TomTicket está disponível para todos os usuários de planos Premium e possui os seguintes recursos. (Versão 1.0)Criar ClientesListar Departamentos e suas CategoriasListar ChamadosVerificar ChamadoCriar ChamadoResponder ChamadoTodos os dados são retornados no formato JSON.Caso ocorra um erro, será…

Para iniciar um status num chamado via API no TomTicket.Endpointhttps://api.tomticket.com/ticket/status/open/{token}ColunaDescriçãotokenToken de acesso único e secreto para sua empresa. Clique aqui para ver como criar.MétodoPOSTContent-Typeform-dataParâmetrosColunaDescriçãoTipoTamanho MáximoParâmetros ObrigatórioscommentComentário sobre o status.String512ticket_idIdentificador do chamado.String250status_idIdentificador do status. Lista de status disponível na listagem de…

Para inserir um comentário com anexo no chamado via API no TomTicket.Endpointhttps://api.tomticket.com/ticket/comment/{token}ColunaDescriçãotokenToken de acesso único e secreto para sua empresa. Clique aqui para ver como criar.MétodoPOSTContent-Typeform-dataParâmetrosColunaDescriçãoTipoTamanho MáximoParâmetros ObrigatórioscommentComentário sobre o status.String512ticket_idIdentificador do chamado.String250Parâmetros OpcionaisattachmentLista com todos os anexos do tipo…

Retornar informações de um chamado via API no TomTicket.Endpointhttps://api.tomticket.com/chamado/{token}/{identificador_chamado}ColunaDescriçãotokenToken de acesso único e secreto para sua empresa. Clique aqui para ver como criar.identificador_chamadoIdentificador do chamado.MétodoGETParâmetrosColunaDescriçãoTipoTamanho MáximoParâmetros OpcionaisstopwatchPermite listar os horário cronometrados num chamado. O valor deve ser 1 para ativar…

O limite de consultas ou Rate Limit é um 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…

Retornar lista de campos personalizados via API no TomTicket.Endpointhttps://api.tomticket.com/custom_fields/{token}ColunaDescriçãotokenToken de acesso único e secreto para sua empresa. Clique aqui para ver como criar.MétodoGETRetornoO retorno é feito no formato JSON.ColunaDescriçãoTipoerroInforma se ocorreu um erro na operação. Se o retorno for false,…

Retornar a lista de carteira de clientes via API no TomTicket.Requer uma assinatura Enterprise.Endpointhttps://api.tomticket.com/customer_portfolio/{token}ColunaDescriçãotokenToken de acesso único e secreto para sua empresa. Clique aqui para ver como criar.MétodoGETRetornoO retorno é feito no formato JSON.ColunaDescriçãoTipoerroInforma se ocorreu um erro na operação.…

Lista todos os chamados via API no TomTicket.Endpointhttps://api.tomticket.com/chamados/{token}/{pagina}ColunaDescriçãotokenToken de acesso único e secreto para sua empresa. Clique aqui para ver como criar.paginaPágina de listagem, por padrão deve ser informado o número, são listados 50 chamados por página.MétodoGETParâmetrosColunaDescriçãoTipoTamanho MáximoParâmetros OpcionaisidclienteIdentificador do…

Retornar a lista de clientes externos via API no TomTicket.Endpointhttps://api.tomticket.com/clientes/{token}/{pagina}ColunaDescriçãotokenToken de acesso único e secreto para sua empresa. Clique aqui para ver como criar.paginaPágina de listagem, por padrão deve ser informado o número, são listados 50 clientes por página.MétodoGETParâmetrosColunaDescriçãoTipoTamanho MáximoParâmetros…

Retornar lista de departamentos via API no TomTicket.Endpointhttps://api.tomticket.com/departamentos/{token}ColunaDescriçãotokenToken de acesso único e secreto para sua empresa. Clique aqui para ver como criar.MétodoGETRetornoO retorno é feito no formato JSON.ColunaDescriçãoTipoerroInforma se ocorreu um erro na operação. Se o retorno for false, então…

Retornar a lista de organizações via API no TomTicket.Endpointhttps://api.tomticket.com/organizacoes/{token}/{pagina}ColunaDescriçãotokenToken de acesso único e secreto para sua empresa. Clique aqui para ver como criar.paginaPágina de listagem, por padrão deve ser informado o número, são listadas 50 organizações por página.colunaNome da coluna…

Este método permite definir se um cliente está ativo ou não. Esta configuração irá permitir ele criar chamados por email e acessar o Painel do Cliente.Endpointhttps://api.tomticket.com/v2.0/customer/permissions/accessMétodo HTTPPOSTContent Typeform-dataAutenticaçãoAuthorization: Bearer {SEU-TOKEN-AQUI}Parâmetros de RequisiçãoChaveDescriçãoObrigatórioValor PadrãoTipoTamanho Máximocustomer_idIdentificador interno do cliente para realizar a…

Este método permite definir se um cliente pode ou não criar chamados.Endpointhttps://api.tomticket.com/v2.0/customer/permissions/create_ticketMétodo HTTPPOSTContent Typeform-dataAutenticaçãoAuthorization: Bearer {SEU-TOKEN-AQUI}Parâmetros de RequisiçãoChaveDescriçãoObrigatórioValor PadrãoTipoTamanho Máximocustomer_idIdentificador interno do cliente para realizar a busca e atualização das informações. Pode ser o endereço de email do cadastro ou…

Este método permite pesquisar artigos existente em sua base de conhecimento.Endpointhttps://api.tomticket.com/v2.0/kb/searchMétodo HTTPGETContent Typeform-dataAutenticaçãoAuthorization: Bearer {SEU-TOKEN-AQUI}Parâmetros Query StringOs parâmetros Query String são enviadas diretamente na URL após o símbolo de "?" ao final do endpoint. Cada parâmetro e valor deve ser…

Este método permite remover opções em um campo personalizado.Endpointhttps://api.tomticket.com/v2.0/custom_field/option/addMétodo HTTPPOSTContent Typeform-dataAutenticaçãoAuthorization: Bearer {SEU-TOKEN-AQUI}Parâmetros de RequisiçãoChaveDescriçãoObrigatórioValor PadrãoTipoTamanho Máximocustom_field_idIdentificador do campo personalizado.Sim-String250valueValor a ser adicionado no campo personalizado.Sim-String-RetornoDescrição do retorno em JSON.ColunaDescrição da ColunaTipoerrorInforma se ocorreu um erro na operação. Se o…

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.Endpointhttps://api.tomticket.com/v2.0/ticket/reply/operatorMétodo HTTPPOSTContent Typeform-dataAutenticaçãoAuthorization: Bearer {SEU-TOKEN-AQUI}Parâmetros de RequisiçãoChaveDescriçãoObrigatórioValor PadrãoTipoTamanho Máximoticket_idIdentificador do chamado.Sim-String250messageConteúdo da mensagem de resposta do chamado. Esta mensagem é enviada…

Este método permite responder um chamado como cliente.Endpointhttps://api.tomticket.com/v2.0/ticket/reply/customer/{ticket_id}Método HTTPPOSTContent Typeform-dataAutenticaçãoAuthorization: Bearer {SEU-TOKEN-AQUI}Parâmetros de RequisiçãoChaveDescriçãoObrigatórioValor PadrãoTipoTamanho Máximoticket_idIdentificador do chamado.Sim-String250messageConteúdo da mensagem de resposta do chamado. Esta mensagem é enviada no formato text/plain (texto puro).Sim-String512attachmentLista com todos os anexos do tipo FILES.…

Para inserir uma resposta do cliente num chamado via API no TomTicket.Endpointhttps://api.tomticket.com/chamado/{token}/{identificador_chamado}/responderColunaDescriçãotokenToken de acesso único e secreto para sua empresa. Clique aqui para ver como criar.identificador_chamadoIdentificador do chamado.MétodoPOSTContent-Typeform-dataParâmetrosColunaDescriçãoTipoTamanho MáximoParâmetros ObrigatóriosmensagemMensagem de resposta.String100Parâmetros OpcionaisanexosLista com todos os anexos do tipo FILES…

Este método permite realizar o encerramento de um status aberto em um chamado.Endpointhttps://api.tomticket.com/v2.0/ticket/status/closeMétodo HTTPPOSTContent Typeform-dataAutenticaçãoAuthorization: Bearer {SEU-TOKEN-AQUI}Parâmetros de RequisiçãoChaveDescriçãoObrigatórioValor PadrãoTipoTamanho Máximoticket_idIdentificador do chamado.Sim-String512RetornoDescrição do retorno em JSON.ColunaDescrição da ColunaTipoerrorInforma se ocorreu um erro na operação. Se o retorno for false,…

Este método permite realizar a abertura de um status em um chamado.Endpointhttps://api.tomticket.com/v2.0/ticket/status/openMétodo HTTPPOSTContent Typeform-dataAutenticaçãoAuthorization: Bearer {SEU-TOKEN-AQUI}Parâmetros de RequisiçãoChaveDescriçãoObrigatórioValor PadrãoTipoTamanho Máximoticket_idIdentificador do chamado.Sim-String512status_idIdentificador do status.Sim-String512commentObservação sobre a abertura do status.Não-String-RetornoDescrição do retorno em JSON.ColunaDescrição da ColunaTipoerrorInforma se ocorreu um erro na…

Este método permite realizar a transferência de um chamado entre atendentes e/ou departamentos.Endpointhttps://api.tomticket.com/v2.0/ticket/transferMétodo HTTPPOSTContent Typeform-dataAutenticaçãoAuthorization: Bearer {SEU-TOKEN-AQUI}Parâmetros de RequisiçãoChaveDescriçãoObrigatórioValor PadrãoTipoTamanho Máximoticket_idIdentificador do chamado.Sim-String512department_idIdentificador do departamento.Não-String512operator_idIdentificador do atendente.Não-String512RetornoDescrição do retorno em JSON.ColunaDescrição da ColunaTipoerrorInforma se ocorreu um erro na operação. Se…

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…

Verifica se um cliente possui cadastro na plataforma.Endpointhttps://api.tomticket.com/cliente/{token}/{identificador}ColunaDescriçãotokenToken de acesso único e secreto para sua empresa. Clique aqui para ver como criar.identificadorIdentificador do cliente para a busca.Pode ser informado o email do cliente ou o identificador interno.MétodoGETParâmetrosColunaDescriçãoTipoTamanho MáximoParâmetros Opcionaistipo_identificadorDefine qual…

Para verificar se um endereço de email está na blacklist via API no TomTicket.Endpointhttps://api.tomticket.com/blacklist/{token}/{endereco_email}ColunaDescriçãotokenToken de acesso único e secreto para sua empresa. Clique aqui para ver como criar.endereco_emailEndereço de email que será verificado.MétodoGETRetornoO retorno é feito no formato JSON.ColunaDescriçãoTipoerroInforma se…

Este método permite vincular um atendente em um chamado.Endpointhttps://api.tomticket.com/v2.0/ticket/linkMétodo HTTPPOSTContent Typeform-dataAutenticaçãoAuthorization: Bearer {SEU-TOKEN-AQUI}Parâmetros de RequisiçãoChaveDescriçãoObrigatórioValor PadrãoTipoTamanho Máximoticket_idIdentificador do chamado.Sim-String250operator_idIdentificador do atendente.Sim-String250RetornoDescrição do retorno em JSON.ColunaDescrição da ColunaTipoerrorInforma se ocorreu um erro na operação. Se o retorno for false, então significa…

Permite vincular ou remover um cliente de uma carteira de clientes.Requer uma assinatura Enterprise.Endpointhttps://api.tomticket.com/customer/portfolio/{token}/{identificador}/{tipo_identificador}ColunaDescriçãotokenToken de acesso único e secreto para sua empresa. Clique aqui para ver como criar.identificadorIdentificador do clientetipo_identificadorTipo de identificador para localizar o cliente. I-Identificador Interno (Padrão) /…

Este método permite vincular um departamento a um cliente.Endpointhttps://api.tomticket.com/v2.0/customer/department/linkMétodo HTTPPOSTContent Typeform-dataAutenticaçãoAuthorization: Bearer {SEU-TOKEN-AQUI}Parâmetros de RequisiçãoChaveDescriçãoObrigatórioValor PadrãoTipoTamanho Máximocustomer_idIdentificador interno do cliente para realizar a busca e atualização das informações. Pode ser o endereço de email do cadastro ou identificador interno utilizado.Sim-String250configurationIdentificador…