エンゲージメントメッセンジャー でのカスタムコードを使用した機能の起動

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間:5分
  • カスタムコードを使用してディープリンクを有効にし、Web サイトと統合された エンゲージメントメッセンジャー の機能を起動します。

    始める前に

    エンゲージメントメッセンジャーの構成

    Web アプリケーションへのエンゲージメントメッセンジャー の埋め込み

    必要なロール:ec_admin および Web サイトアドミニストレーター

    このタスクについて

    注:

    既存のコードを使用している場合は、必ず v=3.1 を表示するようにスクリプトを更新してください。例:

    <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>

    手順

    1. 移動先 Engagement Messenger > モジュール.
    2. [Engagement Messenger モジュールを構成] で [実装] タブを開きます。
    3. [埋め込みコード] セクションからコードをコピーします。
    4. テキストエディターで、エンゲージメントメッセンジャー を統合する Web サイトの Web ページの HTML ファイルを開きます。
    5. 本文終了タグの前にコピーしたコードを貼り付けます。
    6. 機能コンテキストを定義し、機能の変数を指定します。
      機能コンテキストを定義するには、次の形式を使用します。
      { 
      	feature: "<feature_name>", 
      	openOnLoad: <true/false>, 
      	params: { 
      		"<param_name>": "<param_value>",
      		"<param_name>": "<param_value> 
      	} 
      }
      この形式で、機能変数を指定します。
      機能
      機能名。詳細については、「エンゲージメントメッセンジャー でサポートされている機能コンテキストパラメーター 」を参照してください。
      openOnLoad
      エンゲージメントメッセンジャー を自動的に開く場合のみ、このオプションを含めて [true] に設定します。このオプションのデフォルト設定では、エンゲージメントメッセンジャー は自動的に開きません。
      <param_name>": "<param_value>
      機能に関連付けられたパラメーターの名前と値。詳細については、「エンゲージメントメッセンジャー でサポートされている機能コンテキストパラメーター」を参照してください。
    7. 埋め込みコードの SN_CSM_EC.init 関数に機能コンテキストを渡すためのカスタムラッパー関数を作成します。
      たとえば、次のコードでは、チャット機能コンテキストの chatFeatureContext() カスタムラッパー関数を使用しています。
      
      function chatFeatureContext(){ 
      	return { 
      			feature: "CHAT",
      			openOnLoad: false,
      			params: { 
      				"topic_id": "8708db281bd5b81080df6247b04bcb79",
      				"language": "fr"		
      				} 
      		  } 
      }
    8. SN_CSM_EC.loadEMFeature() 関数をステップ 7 で作成したカスタムラッパー関数に置き換えます。
      たとえば、次のコードでは、chatFeatureContext() ラッパー関数が loadFeature 属性の値として渡されます。
      SN_CSM_EC.init({ 
      		moduleID: "https://example.service-now.com/#<module_id>", 
      		loadFeature: chatFeatureContext()
      }); 
      
    9. ファイルを保存します。
    10. オプション: 指定された機能が起動することを確認します。
      1. エンゲージメントメッセンジャー を埋め込んだ Web サイトを開きます。
      2. ランチャーアイコンをクリックします。
      3. 埋め込みコードで構成した機能が エンゲージメントメッセンジャー で起動されることを確認します。

    タスクの結果

    埋め込みコードで指定した機能は、埋め込み先の Web サイトで エンゲージメントメッセンジャー を開くとデフォルトで起動されます。

    次のコードは、デフォルトでチャット機能を開始します。また、トピックのシステム識別子 (sys_id) を渡してチャットがロードされたときに、デフォルトで 仮想エージェント トピックをトリガーする方法も示しています。言語を指定して、その言語でチャットを開始することもできます。

    <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>
    関数
    chatFeatureContext():チャットコンテキストのラッパー関数。
    機能
    CHAT仮想エージェントまたはライブエージェントチャットを開始するためのチャット機能。
    openOnLoad
    falseエンゲージメントメッセンジャー の自動起動を無効にします。
    topic_id
    8708db281bd5b81080df6247b04bcb79:モジュールシステム識別子 (sys_id)。
    言語
    fr:デフォルトのチャット言語をフランス語に設定します。