Obter ticket no Freshdesk, por uma API

Devolve um ticket com status, priority, requester_id, responder_id, group_id, tags, custom_fields e description.

Identificador
freshdesk_get_ticket

A chamada

POST https://connect.reportei.com/api/tools/freshdesk_get_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âmetroTipoObrigatórioDescrição
ticket_idintegerSimId of the ticket, from List tickets or Search tickets.
includestringNãoComma-separated extras: conversations (up to ten, oldest first), requester (email, id, mobile, name and phone), company (id and name) and stats (closed, resolved and first response times). Each one costs more API credits.

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_get_ticket. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do Freshdesk

Ver as 13 tools

Toolkits da mesma categoria

Ver os 100 toolkits

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.