Informações obrigatórias que você deve fornecer
URL do seu chat Freshchat (API Endpoint)
Informe a URL do seu chat Freshchat, disponível em Configurações de API.
Exemplo: seuempresa-1234567890.freshchat.com
API Key do Freshchat
Informe a chave de API gerada no seu painel do Freshchat.
Caminho para geração: Configurações > Configurações Pessoais > API Settings
Exemplo: eyJrewrtgrsgjdXN0b223rasdasfdL....
ID do Agente Clicksmart no Freshchat
Crie um agente específico no seu Freshchat para que nossa IA envie o resumo da conversa no momento do transbordo.
Para obter o ID do agente, execute:
curl --location 'https://{seu_domínio}.freshchat.com/v2/agents' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {API_KEY}'
ID do Tópico no Freshchat
Informe o ID do tópico que será utilizado para entrada dos chats no momento do transbordo.
Para obter o ID do tópico, execute:
curl --location 'https://{seu_domínio}.freshchat.com/v2/channels' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {API_KEY}'
Configuração do Webhook no Freshchat
Você precisará configurar um webhook no Freshchat apontando para nossa API.
Formato do webhook:
https://smartbase.openclick.com.br/api/v1/asyncwebhook/freshchat/{collection_id}/{api_key}/user/p1/p2
Onde:
-
{collection_id}→ ID do seu assistente na Clicksmart -
{api_key}→ API Key gerada na Clicksmart para este assistente
⚠️ Atenção: O Freshchat permite apenas um webhook ativo por ambiente.
Formulário para Transferência (Grupos)
Se desejar que, antes do transbordo, o usuário selecione uma categoria ou motivo, envie a estrutura do formulário no formato JSON.
Exemplo:
[
{
"title": "Sobre qual assunto vamos conversar?",
"name": "group_id",
"type": "radio",
"required": true,
"options": [
{
"label": "Compras",
"value": "7281e873-051e-4651-9f51-14da2882210a"
},
{
"label": "Outros",
"value": "99999990-051e-4651-9f51-14da2882210a"
}
]
}
]
Onde:
-
title→ O nome da categoria que será mostrado ao usuário -
value→ ID da fila (grupo) dentro do Freshchat
Para obter o ID dos grupos, execute:
curl --location 'https://{seu_domínio}.freshchat.com/v2/groups' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {API_KEY}'
Textos Personalizados (Opcional)
Você pode enviar textos personalizados para os seguintes momentos:
-
Mensagem exibida ao usuário quando ocorre a transferência:
Exemplo padrão: “Transferência concluída. Um agente estará com você em breve.” -
Mensagem quando o atendimento retorna do humano para a IA:
Exemplo: “Retornando o atendimento para o assistente virtual.” -
Mensagem de retorno por inatividade:
Exemplo: “Devido à inatividade, retornamos para o assistente virtual.”
Tempo de Inatividade (Opcional)
Defina após quanto tempo (em segundos) de inatividade o chat será devolvido para a IA.
Padrão sugerido: 600 segundos (10 minutos).
Resumo das Informações que você precisa enviar
