Adicionar o cliente web Virtual Agent portátil a um site de terceiros

Para usar o widget de bate-papo do cliente web portátil para Virtual Agent em páginas da web de terceiros, adicione o código necessário à sua página da web.

Antes de Iniciar

Configurar o cliente da Web portátil do Virtual Agent antes de concluir as etapas deste tópico.

Para obter informações adicionais, revise o artigo Como incorporar o Virtual Agent em um site externo no site ServiceNow Community.

Função necessária: virtual_agent_admin ou admin

Procedimento

Importe e instancieesta referência de script com o cabeçalho da página para criar uma instância de bate-papo do ServiceNow no cabeçalho da sua página externa:

Nota:

No exemplo de referência de script, site1.example.com refere-se à URL da sua instância de ServiceNow.

<script type="module" >
      import ServiceNowChat from "https://site1.example.com/uxasset/externals/now-requestor-chat-popover-app/index.jsdbx?sysparm_substitute=false";
      var chat = new ServiceNowChat({ instance: "https://site1.example.com/", });
    </script>

Dica:

Se a sua organização usa um nome de domínio personalizado, insira-o como a propriedade da instância, em vez do nome de domínio ServiceNow, para garantir que os resultados do navegador sejam consistentes entre vários navegadores.

Exemplo com configuração

const chat = new ServiceNowChat({
	instance: 'https://site1.example.com',
	context: {
		skip_load_history: 1
	},
	branding: {
		bgColor: '#333',
		primaryColor: '#000',
		hoverColor: '#EFEFEF',
		activeColor: '#AAA',
		openIcon: 'custom-open.svg',
		closeIcon: 'custom-close.svg',
		sizeMultiplier: 1.6
	},
	offsetX: 50,
	offsetY: 50,
	position: 'left',
	translations: {
		'Open dialog': 'Open chat',
		'Open Chat. {0} unread message(s)': 'Click to open',
		'Close chat.': 'Click to close',
	},
});

Esquema de configuração JSON

{
    instance: <string> - url to your instance, must be of the same domain (sub-domain)
    context: <object> - sys_parm variables to pass into the iframe
    branding: <object> - branding settings
          bgColor: <rgb|hex> - can take an rgb tuple, ie: '56,56,56' or a 3 or 6 hex color code, ie: #333 or #efefef.  background color of button
   	primaryColor: <rgb|hex> - font color
   	hoverColor: <rgb|hex> - hover background color of button
   	activeColor: <rgb|hex> - click / active background color of button
   	openIcon: <string> - name of the uploaded custom icon in settings
   	closeIcon: <string> - name of the uploaded custom icon in settings
   offsetX: <integer> - distance in pixels the button moves along the x-axis
   offsetY: <integer> - distance in pixels the button moves along the y-axis
   position: <enum: left|right> - position left or right side of screen
   translations: <object> - contains label mappings for translations or label changes
   	'Open dialog': <string> - replacement text for accessibility
   	'Open Chat. {0} unread messages(s)': <string> - replacement text for tooltip
   	'Close chat.': <string> - replacement text for tooltip
}