O ponto de acesso direto (DAP, na sigla em inglês) da API para chat permite rotear automaticamente as sessões de chat recebidas para uma fila com base em uma resposta de um endpoint de API externa que você configura. Isso elimina a necessidade de os usuários finais selecionarem em um menu de fila. O endpoint pode ser seu ou de um serviço de terceiros.
Com esse recurso ativado, quando um usuário final inicia um chat, a plataforma CCAI envia uma solicitação ao endpoint de API. A API retorna dados de roteamento (pares de chave-valor), que a plataforma CCAI usa para corresponder ao usuário final à fila correta. Se nenhuma correspondência for encontrada, o menu padrão da fila vai aparecer como substituto.
A API DAP funciona para o seguinte:
Chats na Web e em dispositivos móveis
Chats novos e retomados
Antes de começar
Por padrão, essa capacidade fica inativa. Entre em contato com o Google Cloud suporte para ativar na sua instância.
Tipos de DAP
Há dois tipos de DAP: resposta da API e resposta do webhook. Cada tipo de DAP tem um fluxo de trabalho diferente.
Resposta da API
Este é o fluxo de trabalho de resposta da API:
Um usuário final inicia ou retoma uma conversa.
Antes que o menu da fila apareça, a plataforma CCAI envia uma solicitação ao endpoint de API, incluindo todos os parâmetros definidos, como metadados da sessão ou dados personalizados.
A API retorna um ou mais pares de chave-valor.
A plataforma CCAI corresponde esses pares aos pares de chave-valor configurados nas filas de chat. Todos os pares precisam corresponder para que o chat seja encaminhado a uma fila.
Se uma correspondência for encontrada, o usuário final será encaminhado diretamente para essa fila.
O menu padrão da fila aparece se uma das seguintes situações ocorrer:
Nenhuma correspondência for encontrada.
A API não responde dentro do tempo limite de solicitação de API configurado.
Resposta do webhook
Este é o fluxo de trabalho de resposta do webhook:
Um usuário final inicia ou retoma uma conversa.
Antes que o menu da fila apareça, a plataforma CCAI envia uma solicitação para o endpoint de API, incluindo um URL do webhook.
A API retorna uma resposta de confirmação (HTTP 200) dentro do tempo limite da solicitação de API.
Seu sistema processa a solicitação e envia dados de roteamento (pares de chave-valor) para a plataforma de CCAI usando o webhook.
A plataforma CCAI corresponde esses pares aos pares de chave-valor configurados nas filas de chat. Todos os pares precisam corresponder para que o chat seja encaminhado a uma fila.
Se uma correspondência for encontrada, o usuário final será encaminhado diretamente para essa fila.
O menu de fila padrão aparece se ocorrer alguma das seguintes situações:
Nenhuma correspondência for encontrada.
O reconhecimento não é recebido dentro do tempo limite da solicitação de API.
A resposta do webhook não é recebida dentro do tempo limite de retorno de chamada da API.
Configurar uma DAP de API para chat globalmente
Para configurar uma DAP de API para o chat globalmente, siga estas etapas:
No portal da plataforma CCAI, clique em Configurações > Configurações do desenvolvedor. Se o menu Configurações não aparecer, clique em Menu.
Acesse o painel Ponto de acesso direto de solicitação de API e clique em Gerenciar ponto de acesso direto de solicitação de API.
Clique na guia Chat.
Clique na chave Ponto de acesso direto para solicitação de API do Chat para ativar.
Em Tipo de ponto de acesso direto, selecione um dos seguintes tipos de DAP:
Resposta da API: a API retorna dados de rotas na resposta.
Resposta do webhook: a API reconhece a solicitação e envia dados de roteamento para um webhook.
Para especificar quais tipos de chat acionam a API DAP, em Tipos de chat, selecione uma ou ambas as opções a seguir:
Novas conversas
Chats retomados
No campo Solicitação de API, insira o URL do endpoint de API a ser usado para a DAP.
Para configurar a autenticação, faça o seguinte:
Para configurar a autenticação básica, faça o seguinte:
Em Método de autenticação, selecione Autenticação básica.
Em Credenciais de autenticação, insira seu nome de usuário e senha.
Para configurar um cabeçalho personalizado, faça o seguinte:
Em Método de autenticação, selecione Cabeçalho personalizado.
Selecione Adicionar campo. A caixa de diálogo Adicionar campo aparece.
Insira uma chave e um valor de campo e clique em Salvar.
Para configurar o tempo limite da solicitação de API, faça o seguinte:
Para Tempo limite da solicitação de API, defina o número de segundos que a plataforma CCAI aguarda a resposta da API antes de expirar.
Opcional (aparece apenas se você selecionou o tipo de DAP Resposta do webhook): em Tempo limite de retorno de chamada da API, defina o número de segundos que a plataforma CCAI aguarda os dados de roteamento do webhook (após o reconhecimento inicial) antes de atingir o tempo limite.
Para definir o método de solicitação, em Método de solicitação da API, selecione POST ou GET.
Para configurar um parâmetro de dados, faça o seguinte:
Clique no botão Transmitir parâmetros de dados para a posição ativada.
Clique em Add Parameter. A caixa de diálogo Adicionar parâmetro aparece.
Escolha uma destas opções:
Para configurar um parâmetro de dados fixos, faça o seguinte:
Na lista Tipo, clique em Fixo.
No campo Campo de destino, insira a chave de destino.
No campo Valor do destino, insira o valor do destino. Uma prévia do parâmetro de dados aparece no campo Prévia.
Para configurar um parâmetro de dados dinâmicos, faça o seguinte:
Na lista Tipo, clique em Dinâmica.
Escolha uma destas opções:
Para configurar metadados de sessão, faça o seguinte:
Na lista Origem, selecione Metadados da sessão.
Na lista Campo de entrada, selecione um tipo de metadados.
Para configurar dados personalizados assinados, faça o seguinte:
Na lista Origem, selecione Dados personalizados assinados.
Na lista Campo de entrada, insira o campo de entrada.
Para configurar dados personalizados não assinados, faça o seguinte:
Na lista Origem, selecione Dados personalizados não assinados.
Na lista Campo de entrada, insira o campo de entrada.
No campo Campo de destino, insira o campo de destino. Uma prévia do parâmetro de dados aparece no campo Prévia.
Clique em Add Parameter. Seu parâmetro de dados aparece na lista Parâmetros de dados.
Opcional: para testar sua configuração, faça o seguinte:
Acesse a seção Testar conexão. Seus parâmetros de dados vão aparecer na lista.
Opcional: para testar diferentes valores de parâmetros, edite os valores na lista.
Clique em Testar esta conexão.
Clique em Salvar API Chat.
Mudar a lógica de roteamento
A lógica de roteamento é a ordem em que a Plataforma CCAI tenta vários tipos de correspondência para associar um chat a uma fila. A plataforma CCAI avalia cada tipo de correspondência em ordem e encaminha o chat para a primeira fila correspondente. Se nenhuma correspondência for encontrada, o menu padrão da fila vai aparecer.
Estes são os três tipos de correspondência:
Resposta da API: corresponde com base nos pares de chave-valor da resposta da API.
Rótulo do ponto de acesso geral: corresponde com base no rótulo do ponto de acesso geral da fila.
Segmentação de usuários: correspondências com base em dados de segmentos de usuários.
Para mudar a lógica de roteamento, siga estas etapas:
No portal da plataforma CCAI, clique em Configurações > Configurações do desenvolvedor. Se o menu Configurações não aparecer, clique em Menu.
Acesse o painel Ponto de acesso direto de solicitação de API e clique em Gerenciar ponto de acesso direto de solicitação de API.
Clique na guia Chat.
Em Lógica de roteamento, mantenha o ponteiro sobre um tipo correspondente e arraste-o para uma nova posição.
Repita essa etapa se necessário.
Clique em Salvar API Chat.
Configurar uma DAP para chat no nível da fila
Para configurar uma DAP para chat no nível da fila, siga estas etapas:
No portal da plataforma CCAI, clique em Configurações > Fila. Se o menu Configurações não aparecer, clique em Menu. A página Configurações do menu de fila vai aparecer.
Dependendo do canal que você quer, faça o seguinte:
No painel Dispositivos móveis, clique em Editar / Ver.
No painel Web, clique em Editar / Ver.
Clique na fila que você quer editar.
No painel Configurações, acesse a seção Ponto de acesso.
Clique em Criar ponto de acesso direto. A caixa de diálogo Criar ponto de acesso direto vai aparecer.
Na lista Tipo de ponto de acesso, clique em Resposta da API.
No campo Nome do ponto de acesso, insira um nome.
Clique em Adicionar chave e valor. Insira um par de chave-valor para corresponder a um par de chave-valor retornado na resposta da API.
Repita a etapa anterior para adicionar mais pares de chave-valor.
Opcional: no campo Mensagem de saudação, digite a mensagem que você quer usar quando um usuário final for direcionado a essa opção de menu.
Clique em Criar. Seu DAP aparece na lista Ponto de acesso.