O criador de integrações pode ser usado para criar um ticket do Zendesk a partir de uma conversa usando um agente de IA. Este artigo mostrará como fazer isso.
Para referência, você pode encontrar a documentação relevante para desenvolvedores da Zendesk aqui.
Este artigo contém os seguintes tópicos:
- Pré-requisitos
- Criar integração
- Ambiente e ponto de extremidade
- Autenticação
- Parâmetros da solicitação
- Corpo
- Formatação de transcrição de chat: corpo padrão versus HTML
- Campos padrão versus valores de campos personalizados
- Criação no criador de diálogos
Pré-requisitos
Para a configuração, você precisa do seguinte:
- Seu subdomínio do Zendesk
- Seu token de autorização (veja a seção a seguir para obter mais informações)
Criar integração
- Crie uma nova integração em integrações de API.
- Forneça um nome, como Criar ticket do Zendesk, e uma descrição.
Ambiente e ponto de extremidade
Para acessar a API de tickets do Zendesk, você precisa fazer uma solicitação POST para o seguinte ponto de extremidade: http://[seu-subdominio-do-zendesk].zendesk.com/api/v2/tickets
Com seu subdomínio do Zendesk, você pode criar a URL do ponto de extremidade para sua instância do Zendesk. Essa URL é usada na seção Ambientes do criador de integrações para fazer a solicitação POST.
- Navegue até a seção Ambientes do criador de integrações.
- Para tipo de método, selecione POST.
- Adicione o ponto de extremidade da URL criada para a API de ticket.
Autenticação
Para acessar a API do Zendesk, você precisa criar um token na Central de administração.
- Na Central de administração, acesse Aplicativos e integrações e selecione APIs > API do Zendesk.
A tela a seguir é exibida, e nela você pode adicionar um novo token.
- Clique em Adicionar token da API.
- Dê um nome a ele, como Criar Ticket.
- Copie o token em algum lugar seguro, pois você precisará dele para configurar a integração no criador de integrações.
Feito isso, você pode adicionar o token à sua integração no criador de integrações.
- Na seção Ambiente, clique em Autorização.
- No tipo de autorização, selecione Autenticação básica.
- Informe um endereço de e-mail de administrador com /token incluído no final.
- Cole o token criado como senha.
- Certifique-se de adicionar o token de autorização à sua solicitação, criando o cabeçalho apropriado.
Parâmetros da solicitação
É aqui que você passará os dados da conversa do agente de IA para a integração para criar o ticket.
Para fazer a integração em tempo real, você precisa definir os parâmetros no seu diálogo e, em seguida, vinculá-los aos parâmetros da sua solicitação no criador de integrações. Para fins de teste, você pode criar os parâmetros de solicitação com valores de teste, pois não estamos usando dados em tempo real de uma conversa.
Certifique-se de que os nomes dos parâmetros da sua solicitação correspondam aos que você definiu no seu diálogo (por meio de ações). Consulte Criação no criador de diálogos para obter mais informações.
Corpo
O corpo é para onde você envia todos os dados da conversa para criar o ticket por meio da API de ticket. A estrutura desse corpo deve corresponder ao esquema da API de ticket.
Para ver o esquema e quais campos podem ser criados com seu ticket, consulte a documentação para desenvolvedores da Zendesk aqui.
A seguir está um exemplo de corpo da solicitação com os parâmetros de solicitação que criamos anteriormente.
Teste a integração clicando em Testar produção.
Você deve conseguir ver o ticket recém-criado no painel do Zendesk.
Formatação de transcrição de chat: corpo padrão versus HTML
A API de ticket é compatível com body ou html_body para comentários. Ao usar body, vários espaços consecutivos são recolhidos em um único espaço e vários caracteres de nova linha (“/n”) são recolhidos em uma única nova linha. Já ao usar html_body, você pode utilizar a sintaxe HTML padrão para a formatação do seu comentário.
Para obter mais informações, consulte a documentação para desenvolvedores da Zendesk aqui.
Para usar qualquer um desses parâmetros no ticket criado, você deve estruturar o que deseja usar em “comment” no corpo da solicitação.
Observação: use apenas uma das opções, não ambas, como na demonstração a seguir.
Se você está enviando a transcrição do chat, é recomendável usar a ferramenta de reformatação de valores para tornar a transcrição mais legível. Em vez de apenas um grande bloco de texto, você pode adicionar quebras de linha no início de cada mensagem.
Se desejar enviar um corpo HTML, você pode usar a ferramenta de reformatação de valores para adicionar o HTML.
Para obter instruções sobre como usar a ferramenta de reformatação de valores, consulte Reformatação de valores em parâmetros de solicitação para agentes de IA avançados.
Na captura de tela a seguir, reformatamos a transcrição do chat para criar URLs clicáveis e adicionamos quebras de linha com <br>.
Campos padrão versus valores de campos personalizados
Além dos campos padrão que podem ser criados e enviados no corpo da solicitação, você também pode criar valores de campo personalizados. Para obter instruções sobre como configurar campos personalizados no corpo, consulte a documentação para desenvolvedores da Zendesk aqui.
Criação no criador de diálogos
- Adicione o Nó da API e selecione a integração Criar ticket do Zendesk que você criou anteriormente.
- Crie uma ação no nó da API para definir os parâmetros da conversa.
A ação deve ter a seguinte aparência:
- Adicione uma mensagem para os cenários de êxito e fallback.
