Buscar tickets no Freshdesk, por uma API

Busca 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.

Identificador
freshdesk_search_tickets

A chamada

POST https://connect.reportei.com/api/tools/freshdesk_search_tickets/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "query": "<query>"
  }
}

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
querystringSimFilter in double quotes, up to 512 characters, such as "status:2 AND priority:4" or "(agent_id:12 OR group_id:3) AND tag:'vip'". Fields: agent_id, group_id, priority, status, tag, type, due_by, fr_due_by, created_at, updated_at, closed_at and custom fields by their name in List ticket fields. Text in single quotes, dates as 'YYYY-MM-DD', null for empty. On or after is a colon and a greater-than sign; on or before, a colon and a less-than sign.
pageintegerNãoPage number, from 1 to 10.

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

Veja o Connect aplicado ao seu produto.

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