Personalizar o Widget Guide Usando API
Você pode personalizar a aparência e o comportamento do widget Guide usando estas JavaScript API.
Ajustar o CSS
Altera os elementos CSS do widget do Guide. Make all CSS changes in a single call. Uma segunda chamada substitui as alterações feitas pela primeira chamada.
Sintaxe de exemplo
cxone('guide', 'setCustomCss', '[data-selector="GUIDE_CHANNEL_BACK_BUTTON"] {color: white !important; background: red !important;}');
Para ocultar um seletor de dados, use display:none. Por exemplo, para ocultar o botão do menu Guide:
cxone('guide', 'setCustomCss', '[data-selector="GUIDE_MENU_BUTTON"] {display: none;}');
| Interface Guide | seletores de dados |
|---|---|
| Widget Guide e botões |
|
| Portais |
|
| Artigos |
|
|
Chats e e-mails |
|
|
Ofertas proativos |
|
Ajustar o tamanho do botão do Canal
Define o tamanho a ser usado para botões de canal. Insira um valor em ems ou pixels. O tamanho padrão do botão é 3em.
cxone('guide', 'setButtonSize', '80px');
Ajustar o Deslocamento do botão do Canal
Define o valor de deslocamento a ser usado para os botões de canal. Enter um valor em ems ou pixels.
cxone('guide', 'setOffsetX', '48px');cxone('guide', 'setOffsetY', '3em');
Abrir o menu Guide
Mostra o menu de botões do Guide.
cxone('guide', 'openMenu');
Fechar o menu Guide
Fecha o menu de botões do Guide.
cxone('guide', 'closeMenu');
Alterar Tamanho da fonte
Define o tamanho da fonte padrão usado no widget Guide. Insira um valor em pixels. O tamanho de fonte padrão é 14 pixels. O valor definido aqui determina o tamanho em usado em todo o Guide.
cxone('guide','setFontSize',14);
Alterar Altura do widget Guide
Define a altura do widget Guide. Insira um valor em ems ou pixels. A altura padrão é 40em. A altura máxima é 40 rem.
cxone('guide','setDesiredGuideHeight','30em');
Alterar Largura do widget Guide
Define a largura do widget Guide. Insira um valor em ems ou pixels. A largura padrão é 23.125em.
cxone('guide','setDesiredGuideWidth','608px');
Exibir o Guide no modo de Tela cheia
Você pode exibir Guide no modo de tela cheia. O conteúdo de Guide aparece em uma janela em vez do widget Guide.
cxone('guide','setFullDisplay');
Uma prática recomendada no modo de tela cheia é ocultar o botão minimizar. Para fazer isso, use os dois comandos a seguir:
cxone('guide', 'setFullDisplay');
cxone('guide', 'setCustomCss', '[data-selector="GUIDE_SINGLE_MENU_CLOSE_BUTTON"] {display: none !important;}');
Ocultar Pesquisa pré-contato de chat
Use esta API para instruir o Guide para iniciar um chat sem exibir a pesquisa pré-contato na web.
cxone('guide','hidePreSurvey');
Use as APIs de chat para predefinir os valores da pesquisa pré-contato na web. Alternativamente, você pode especificá-los como parâmetros para a API hidePreSurvey. Por exemplo:
cxone('guide','hidePreSurvey', 'Dre', {email: 'dre@classics.com'});
Definir valores de Campo personalizado para a Pesquisa de pré-contato
Use esta API para definir valores para os campos personalizados que aparecem em uma pesquisa pré-contato. Você pode definir valores para os seguintes itens:
-
Nome
-
Qualquer campo personalizado de contato
-
Qualquer campo personalizado do cliente
Você pode marcar um valor de campo personalizado como hidden:true. O formulário de pesquisa pré-contato não exibe o campo oculto. Mas o valor definido para o campo oculto é passado para a janela de chat.
Para os campos personalizados não marcados como hidden:false, Guide predefine os campos personalizados na pesquisa pré-contato com os valores especificados pelo comando da API. O visitante pode usar os valores padrão ou alterá-los conforme desejar.
Os campos personalizados são limitados a 1024 caracteres.
O exemplo de sintaxe JavaScript a seguir mostra como especificar um nome que é oculto e passado diretamente para o chat:
cxone('guide','setCustomFields', {customerName: {value:'Francis', hidden: true}});
O exemplo de sintaxe JavaScript a seguir mostra como especificar dois valores de campo personalizado de contato. O valor email é oculto na pesquisa pré-contato e passado diretamente para o chat. O valor address é visível e pode ser editado na pesquisa pré-contato.
cxone('guide','setCustomFields',
{contactCustomFields:[
{ident:'email', value: 'josey@nice.com', hidden:true},
{ident: 'address', value: '123 Main St', hidden:false}
]});
O exemplo de sintaxe JavaScript a seguir mostra como especificar um campo personalizado de cliente:
cxone('guide','setCustomFields',
{contactCustomerFields:[
{ident: 'email', value: 'kaya.sanchez@acme.com'}
]});
O exemplo de sintaxe JavaScript a seguir mostra como especificar tanto um campo personalizado de contato quanto um campo personalizado de cliente:
cxone('guide','setCustomFields',
{contactCustomFields:[{ident: 'email', value: 'josey@nice.com', hidden:true}, {ident:'address', value: '123 Main St', hidden:false}], contactCustomerFields:[{ident: 'email', value: 'kaya.sanchez@acme.com'}]});
Termos de uso
Permite disponibilizar um documento de termos de uso para os visitantes na janela de chat. Esta função adiciona um botão à janela. Você pode personalizar o rótulo e o estilo do botão e o que acontece quando os visitantes clicam nele. A ação de clique pode mostrar os termos de uso como uma janela interna ou um link externo.
Dependências:
-
As propriedades display, type e url são obrigatórias.
-
display deve ter menos de 256 caracteres, mas não pode estar vazio.
-
url deve começar com https: ou https: e deve ter menos de 2048 caracteres.
Uma janela interna:
cxone('guide','showTermsOfUse', 'Show terms of Use', 'modal' , 'Our terms of use are ...');
Um link externo:
cxone('guide','showTermsOfUse', {display: 'Terms of Use', type: 'externalLink', url: 'https://yourdomain.com/'});
Para desativar o recurso:
cxone('guide','hideTermsOfUse');
Exibir diretamente um Ponto de entrada
Use esta API para exibir manualmente um ponto de entrada em uma janela. O botão padrão para o ponto de entrada é usado.
Essa API é fornecida para casos específicos em que alguém pode precisar mostrar manualmente um ponto de entrada em uma janela. Não é geralmente recomendada e não deve ser usada em combinação com Guide regras de engajamento.
Se você criou um ponto de entrada no outono de 2024 ou posteriormente, contate seu representante de conta para obter assistência na determinação do ID do ponto de entrada.
Para usar essa API, você deve passar o ID do ponto de entrada a ser exibido. Você pode obter o ID do ponto de entrada clicando em Editar ao lado do ponto de entrada e, em seguida, copiando a última parte da URL da página.
cxone('guide','openEntrypoint','e1348160-2016-4d91-958e-fd063c669fe6');
Habilitar reavaliação de Regra para Aplicativos de Página única (SPAs)
Para oferecer suporte ao roteamento dinâmico em aplicativos de página única, você pode configurar Guide para reavaliar automaticamente as regras quando um usuário navegar para uma nova página. Para habilitar o roteamento dinâmico, adicione o parâmetro resetRulesOnNewPage à função cxone('guide','init'); em seu script incorporado:
cxone('guide','init', {resetRulesOnNewPage: true});
Quando resetRulesOnNewPage for definido como true.
-
Guide monitora transições de página usando o módulo Analytics.
-
Ao detectar uma nova página, o mecanismo de regras é redefinido para seu estado inicial.
-
Todas as regras, incluindo aquelas com avaliações estáticas ou aquelas que já foram disparadas, são reavaliadas imediatamente.
-
Os ouvintes e temporizadores de regra são reiniciados como se a página tivesse acabado de ser carregada.
Por padrão, o parâmetro é definido como false.