> For the complete documentation index, see [llms.txt](https://docs.chatlayer.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.chatlayer.ai/chatlayer-documentation-pt-br/integrateandcode/human-offloading-live-chat/zendesk-chat.md).

# Zendesk Chat

{% hint style="danger" %}
O suporte à integração do Chatlayer com o Zendesk Chat está chegando ao fim, pois o Zendesk está fazendo a transição para [Zendesk Sunshine](/chatlayer-documentation-pt-br/integrateandcode/app-integrations/zendesk-sunshine-beta.md).
{% endhint %}

{% hint style="danger" %}
O Zendesk só permite que usuários do plano "Enterprise" usem plataformas de bots de terceiros, como o Chatlayer. Certifique-se de fazer upgrade para o nível "Enterprise" do Zendesk para usar esta integração.
{% endhint %}

O Zendesk é uma empresa de CRM orientada a serviços que desenvolve software projetado para melhorar o relacionamento com os clientes.

## Configurar o Zendesk

No Zendesk, seu bot do Chatlayer será um agente separado que cuidará das mensagens recebidas para o próprio departamento dele. O Chatlayer fornece os blocos de ação necessários para transferir a conversa para um departamento com agentes ao vivo de sua escolha.

{% hint style="warning" %}
A conta do Agente não deve ser acessada por agentes ao vivo, pois isso pode interromper o chatbot.
{% endhint %}

### Criar um novo agente para o chatbot

Primeiro, crie o agente do chatbot no Zendesk Chat indo em Configurações > Agentes > Adicionar agente.

![](/files/cf24f8b3ece84d58edfb8e43c1169e550c6e0932)

### Criar um departamento para o chatbot

Crie um novo departamento para o chatbot indo em Configurações > Departamentos > Adicionar departamento. Escolha um nome reconhecível e **adicione o agente do chatbot como Agente do Departamento.**

![](/files/112da56c0092a050d0f22e187c08cd6bb256274c)

### Configurar seu widget de chat do Zendesk

Agora você deve criar ou ajustar seu Widget de Chat do Zendesk para se conectar automaticamente ao departamento do Chatbot que você acabou de configurar. Para isso, no Zendesk Chat, vá em Configurações > Widget e copie o código abaixo em "Incorporar widget da Web".

![](/files/d6de8c2391a2cc7a5d9cbe7c955689b1d0d6f9c3)

Aqui está um exemplo de como você poderia ajustar o Widget para se conectar automaticamente ao **Chatbot** departamento criado anteriormente:

```markup
<!-- Início do script do Widget do Zendesk -->
<script
  id="ze-snippet"
  src="https://static.zdassets.com/ekr/snippet.js?key=abc123
></script>
<script>
  window.zESettings = {
    webWidget: {
      chat: {
        departments: {
          select: "Chatbot"
        }
      }
    }
  };
</script>
<!-- Fim do script do widget Zendesk do chatlayerai -->
```

Certifique-se de adicionar sua própria chave e o nome do departamento no código. Mais informações sobre este tópico podem ser encontradas na [documentação do Zendesk Chat](https://developer.zendesk.com/embeddables/docs/widget/settings#departments).

## Configurar seu canal do Zendesk Chat

No Chatlayer, vá até a visão geral dos Canais para começar a configurar sua integração com o Zendesk Chat. Vá ao menu "Canais", escolha Zendesk Chat e inicie a criação do canal clicando no ícone +.

#### Encontrando seu subdomínio

Você será solicitado a inserir seu subdomínio para **zendesk.com**.

![](/files/e5b97f17379dea4766c4836e4acd74af14195093)

Ao usar o Zendesk em um navegador, o subdomínio é a primeira parte das suas URLs do Zendesk. A imagem de exemplo abaixo mostra o subdomínio "chatlayerai".

![](/files/3922310ee44af77a289d400f7e9cc07bf49311f5)

#### Autorizar o Chatlayer

Quando solicitado a autorizar o Zendesk, faça login na conta de Agente do Zendesk que deve atuar como agente do bot. Este é o agente que você criou anteriormente.

### Comece a usar seu bot

Agora você pode conversar com seu bot através do widget de Chat do Zendesk. Cada mensagem recebida de um usuário será respondida pelo bot.

### Variáveis de sessão sincronizadas

Você pode manter facilmente as informações sobre seus usuários sincronizadas entre o bot e o Zendesk Chat. As seguintes variáveis de sessão serão sincronizadas automaticamente com as informações do visitante no Zendesk Chat:

* `zendeskChat.email`
* `zendeskChat.displayName`
* `zendeskChat.phone`
* `zendeskChat.notes`
* `zendeskChat.tags` (array)
* `zendeskChat.visitor_tags` (array, somente leitura)

![Solicite o endereço de e-mail de um usuário e sincronize-o automaticamente com o Zendesk Chat](/files/7b52dafa021e6805c7258e1c3b4591eb93652e04)

### Tags do Zendesk

Como o Zendesk menciona [no fórum de suporte deles](https://support.zendesk.com/hc/en-us/articles/360022366013-Understanding-different-types-of-tags-in-Chat), há dois tipos diferentes de tags no Zendesk Chat:

> O Zendesk Chat oferece dois tipos diferentes de tags para categorizar seus visitantes e sessões de chat:
>
> * **Tags de chat** contêm informações sobre o conteúdo específico de uma sessão de chat.
> * **API JavaScript e tags de gatilho** contêm informações mais gerais sobre o visitante.

{% hint style="warning" %}
As tags de chat só podem conter caracteres alfanuméricos, hífens (-) ou sublinhados (\_). O comprimento máximo de uma tag de chat é de 140 caracteres
{% endhint %}

#### Tags de chat (`zendeskChat.tags`)

Você pode usar ambos os tipos de tags no seu fluxo usando as variáveis de sessão do Zendesk. As tags de chat podem ser acessadas por meio da `zendeskChat.tags` variável, você pode adicionar mais tags de chat a uma conversa enviando valores para essa variável.

#### API JavaScript e tags de gatilho (`zendeskChat.visitor_tags`)

{% hint style="warning" %}
As tags da API JavaScript e de gatilho são somente leitura; use Tags de chat se quiser adicionar tags dinamicamente pelo fluxo.
{% endhint %}

As tags de visitante podem ser usadas para passar metadados sobre a solicitação do seu usuário para o bot quando um usuário inicia uma conversa. Digamos que você tenha um site com um widget de Chat do Zendesk e queira iniciar o bot a partir de uma determinada intenção, porque o usuário estava naquela página específica de FAQ. Você pode passar essas tags para o bot dentro do código do seu site chamando o SDK JavaScript do Zendesk:

```markup
<script id="ze-snippet" src="<ZENDESK_SNIPPET_URL>"> </script>
<script>
  window.zESettings = {
    webWidget: {
      chat: {
        departments: {
          select: "Chatbot"
        }
      }
    }
  };
  zE('webWidget', 'chat:addTags', ['change_password']);
</script>
```

Se você importar este script em uma página, todo usuário que iniciar uma conversa será direcionado ao bot com a tag `change_password` . Você pode então usar essa tag na configuração do fluxo para direcionar esse usuário imediatamente para a parte certa da conversa:

![Use tags de visitante para guiar o usuário para uma parte específica do seu fluxo](/files/59a49fcb0c7aab106c458a29bf4db640bd33c572)

## Configurar o encaminhamento

Para transferir a conversa do chatbot para um departamento diferente, você pode criar um bloco de Ação contendo uma configuração de Encaminhamento. Configure o provedor de encaminhamento do Zendesk Chat e o departamento para o qual você deseja encaminhar a conversa.

![](/files/ec8f9aa55b304552f2d9d9cdeae67a656fa844b6)

Assim que essa Ação for acionada e o departamento escolhido tiver pelo menos um agente online, o chatbot será pausado e o usuário será transferido para esse departamento. O bloco "Encaminhamento Fechado" será acionado caso ninguém naquele departamento esteja online.

## Entrando no ar

Para entrar no ar, você deve configurar um canal do Zendesk para o ambiente Ao vivo em [app.chatlayer.ai](https://app.chatlayer.ai). Recomendamos criar um Agente de Bot, Departamento e Widget separados, conectados a esse Departamento, tanto para os ambientes Rascunho quanto Ao vivo. Isso garante que não haverá conflitos entre as versões do seu bot.

Tem mais dúvidas sobre como configurar o Zendesk Live chat no seu bot? Não hesite em contatar [nosso departamento de Suporte](https://support.chatlayer.ai/)!


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.chatlayer.ai/chatlayer-documentation-pt-br/integrateandcode/human-offloading-live-chat/zendesk-chat.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.