Iniciar um recurso em App de mensagens de interação usando código personalizado

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 2 min. de leitura
  • Use o código personalizado para habilitar o link profundo e iniciar um recurso em App de mensagens de interação integrado ao seu site.

    Antes de Iniciar

    Como configurar o App de mensagens de interação.

    Incorporar App de mensagens de interação em sua aplicação web.

    Função necessária: ec_admin e administrador do site

    Por Que e Quando Desempenhar Esta Tarefa

    Nota:

    Se você estiver usando o código existente, verifique se atualizou o script para mostrar v=3.1. Por exemplo:

    <script src="https://example.service-now.com/scripts/sn_csm_ec.js?v=3.1"></script>
    <script>
    SN_CSM_EC.init({
          moduleID: "https://example.service-now.com/#aeff0547dd393010f87734cef087e2ba",
          loadFeature: SN_CSM_EC.loadEMFeature()
    });
    </script>

    Procedimento

    1. Navegar até App de mensagens de interação > Módulos.
    2. No módulo Configurar App de mensagens de interação, abra a guia Implementar.
    3. Copie o código da seção Código de incorporação.
    4. Em um editor de texto, abra o arquivo HTML da página da Web no site em que você integra App de mensagens de interação.
    5. Cole o código que você copiou antes do marcador do corpo de fechamento.
    6. Defina o contexto do recurso e especifique as variáveis para o recurso.
      Use o seguinte formato para definir um contexto de recurso:
      { 
      	feature: "<feature_name>", 
      	openOnLoad: <true/false>, 
      	params: { 
      		"<param_name>": "<param_value>",
      		"<param_name>": "<param_value> 
      	} 
      }
      No formato, especifique as variáveis de recurso.
      feature
      O nome do recurso. Para obter mais informações, consulte Parâmetros de contexto do recurso compatíveis com App de mensagens de interação .
      abrirEmCarga
      Inclua esta opção e defina-a como verdadeira somente se quiser que App de mensagens de interação abra automaticamente. A configuração padrão para esta opção é App de mensagens de interação para não abrir automaticamente.
      <param_name>": "<param_value>
      Nome e valor de um parâmetro associado ao recurso. Para obter mais informações, consulte Parâmetros de contexto do recurso compatíveis com App de mensagens de interação.
    7. Crie uma função de wrapper personalizada para passar o contexto do recurso para a função SN_CSM_EC.init do código de incorporação.
      Por exemplo, o código a seguir usa a função de wrapper personalizada chatFeatureContext() para o contexto do recurso de bate-papo.
      
      function chatFeatureContext(){ 
      	return { 
      			feature: "CHAT",
      			openOnLoad: false,
      			params: { 
      				"topic_id": "8708db281bd5b81080df6247b04bcb79",
      				"language": "fr"		
      				} 
      		  } 
      }
    8. Substitua a função SN_CSM_EC.loadEMFeature() por uma função de wrapper personalizada que você criou na etapa 7.
      Por exemplo, no código a seguir, a função de wrapper chatFeatureContext() é passada como o valor do atributo loadFeature.
      SN_CSM_EC.init({ 
      		moduleID: "https://example.service-now.com/#<module_id>", 
      		loadFeature: chatFeatureContext()
      }); 
      
    9. Salve o arquivo.
    10. Opcional: Verifique se o recurso designado é iniciado.
      1. Abra o site no qual você incorporou App de mensagens de interação.
      2. Selecione o ícone do inicializador.
      3. Verifique se App de mensagens de interação inicia o recurso que você configurou no código de incorporação.

    Resultado

    O recurso que você especificou no código de incorporação é iniciado por padrão quando App de mensagens de interação é aberto no site no qual está incorporado.

    Exemplo

    O código a seguir inicia o recurso de bate-papo por padrão. Ele também mostra como acionar um tópico Virtual Agent por padrão quando o bate-papo é carregado, passando o identificador do sistema (sys_id) do tópico. Você também pode especificar um idioma para iniciar o bate-papo nesse idioma.

    <script src="https://example.servicenow.com/scripts/sn_csm_ec.js?v=3.1"></script>
    <script>
    function chatFeatureContext(){ 
    	return { 
    			feature: "CHAT",
    			openOnLoad: false,
    			params: { 
    				"topic_id": "8708db281bd5b81080df6247b04bcb79",
    				"language": "fr"		
    				} 
    		  } 
    }
    
    SN_CSM_EC.init({
    	moduleID: "https://example.service-now.com/#d27c94d6db403810a2a6a0ced39619da",
    	loadFeature: chatFeatureContext()
    });
    </script>
    função
    chatFeatureContext(): a função de wrapper para o contexto de bate-papo.
    feature
    CHAT: o recurso de bate-papo para iniciar o bate-papo Virtual Agent ou Atendente.
    abrirEmCarga
    false: desabilita a inicialização automática de App de mensagens de interação.
    topic_id
    8708db281bd5b81080df6247b04bcb79: o identificador do sistema do módulo (sys_id).
    idioma
    fr: define o idioma de bate-papo padrão como francês.