Atualizar ticket no Freshdesk, por uma API
Atualiza um ticket: envie só os campos a mudar, e tags como a lista completa que o ticket deve manter. Status 4 resolve e 5 fecha o ticket.
- Identificador
- freshdesk_update_ticket
A chamada
POST https://connect.reportei.com/api/tools/freshdesk_update_ticket/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"ticket_id": 1
}
}Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.
Parâmetros
As descrições dos parâmetros seguem a documentação oficial do app, em inglês.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| ticket_id | integer | Sim | Id of the ticket, from List tickets or Search tickets. |
| requester_id | integer | Não | Id of an existing contact as the new requester, from List contacts. |
| string | Não | Email address of the new requester. A new address creates the contact. | |
| phone | string | Não | Phone number of the new requester. A new number creates the contact, and without email the name becomes mandatory. |
| unique_external_id | string | Não | External id of the new requester, the id in your own system. A new id creates the contact. |
| name | string | Não | Name of the requester. |
| subject | string | Não | Subject of the ticket. |
| description | string | Não | Content of the ticket, as HTML or plain text. |
| status | integer | Não | 2 Open, 3 Pending, 4 Resolved or 5 Closed. Custom statuses of the helpdesk are the choices of the status field in List ticket fields. |
| priority | integer | Não | 1 Low, 2 Medium, 3 High or 4 Urgent.Valores: 1, 2, 3, 4 |
| source | integer | Não | Channel of the ticket: 1 Email, 2 Portal, 3 Phone, 7 Chat, 9 Feedback widget or 10 Outbound email.Valores: 1, 2, 3, 7, 9, 10 |
| type | string | Não | Ticket type, one of the choices of the ticket_type field in List ticket fields, such as Question or Incident. |
| responder_id | integer | Não | Id of the agent to assign the ticket to, from the choices of the agent field in List ticket fields. |
| group_id | integer | Não | Id of the group to assign the ticket to, from the choices of the group field in List ticket fields. |
| product_id | integer | Não | Id of the product of the ticket, from the choices of the product field in List ticket fields. |
| company_id | integer | Não | Id of the company of the requester, from Search companies. Only with the Multiple Companies feature. |
| tags | array | Não | Full list of tags the ticket should have, current ones included. |
| due_by | string | Não | When the ticket is due to be resolved. |
| fr_due_by | string | Não | When the first response is due. |
| custom_fields | object | Não | Custom field values keyed by the name of each custom field in List ticket fields, for example cf_order_number. Dates go as YYYY-MM-DD. |
Conexões possíveis
O seu cliente conecta a conta do Freshdesk uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.
Usuário e senha
O cliente informa as credenciais do app numa tela do Connect, ou o seu sistema as envia por POST /api/customer-toolkits, sem tela.
Na conexão, o cliente informa também {domain}: o endereço da conta dele na API do app.
A resposta
Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.
Pronta para agentes de IA
O input desta tool é um JSON Schema, disponível em GET /api/tools/freshdesk_update_ticket. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Freshdesk
- Listar ticketsGETLista tickets, os mais recentes primeiro por padrão. Sem updated_since voltam só os tickets criados nos últimos 30 dias, e spam ou excluídos só vêm com filtro.
- Buscar ticketsGETBusca tickets com uma query de filtro, por exemplo por status, prioridade, agente, grupo, tag ou campo personalizado. Devolve total e results, 30 tickets por página.
- Obter ticketGETDevolve um ticket com status, priority, requester_id, responder_id, group_id, tags, custom_fields e description.
- Criar ticketPOSTCria um ticket. Identifique o solicitante com requester_id, email, phone ou unique_external_id; um email ou phone ainda não existente no Freshdesk cria o contato.
- Listar conversas do ticketGETLista as respostas e notas de um ticket, com body (HTML), body_text, private, incoming, user_id e source (0 resposta, 2 nota). As páginas são numeradas a partir de 1.
- Criar resposta no ticketPOSTResponde ao solicitante de um ticket. O Freshdesk envia a resposta por e-mail ao solicitante, então ela fica visível ao cliente.
- Criar nota no ticketPOSTAdiciona uma nota a um ticket. As notas são privadas por padrão, visíveis só aos agentes; com private false o solicitante também a vê.
- Listar campos de ticketGETLista os campos de ticket do helpdesk com suas opções: ids de agentes no campo de agente, ids de grupos no campo de grupo, ids de produtos e valores de status.
Toolkits da mesma categoria
Ver os 100 toolkitsVeja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
