Buscar conversas no Front, por uma API

Busca as conversas que o token de API alcança, da atividade mais recente para a mais antiga, e retorna _total com as correspondências. Conversas na lixeira ficam de fora, a menos que a consulta peça is:trashed. A próxima página vem do page_token dentro de _pagination.next, que é null na última página.

Identificador
front_search_conversations

A chamada

POST https://connect.reportei.com/api/tools/front_search_conversations/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
querystringSimWords and filters separated by spaces, combined with AND. Words match subject and body; quote a phrase. Filters: is:open, is:archived, is:assigned, is:unassigned, is:snoozed, is:unreplied, is:waiting, is:resolved, is:trashed; inbox:ID (List inboxes); tag:ID (List tags); assignee:ID or participant:ID (List teammates); from:, to:, cc: or recipient: with an email or handle; before:, after: or during: with a Unix time in seconds. Up to 15 filters.
limitintegerNãoResults per page, up to 100. Defaults to 50.
page_tokenstringNãoThe page_token value in the _pagination.next URL of the previous response.

Conexões possíveis

O seu cliente conecta a conta do Front uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.

Chave de API

O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.

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

Outras tools do Front

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.