仮想エージェントの URL パラメーター

  • リリースバージョン: Zurich
  • 更新日 2025年07月31日
  • 所要時間：4分

    • 仮想エージェントには、アドミニストレーターがインスタンス URL に追加して、ページコンテンツのレンダリング方法を制御できるさまざまなシステムパラメーターが用意されています。

    仮想エージェントの URL 構造

    インスタンスに対して表示されるページを制御するには、URL パラメーターをインスタンス URL (https://<instancename>.service-now.com) に追加します。

    仮想エージェントチャットウィジェットのシステムパラメーター

    仮想エージェントチャットウィジェットは、ポータルでの使用、またはサードパーティのページへの埋め込みがサポートされています。次のシステムパラメーターは、 仮想エージェント チャットウィジェットに表示される会話コンテンツを制御します。
    パラメーター 説明 例
    sysparm_branding_key

    チャットの自社用カスタム設定構成を Web チャットクライアントに適用します。

    値：構成の自社用カスタム設定キー
    • ブランディング構成を宛先ページに適用します:https://<instance_name>.service-now.com/$sn-va-web-client-app.do?sysparm_branding_key=<branding_key>
    • 埋め込みチャットウィジェットにブランディング構成を適用します ( https://<instance_name>.service-now.com/$sn-va-web-client-app._embed.do?sysparm_branding_key=<branding_key>
    sysparm_default_topic トピック sys_ID を使用して起動時にデフォルトのトピックを設定します。 https://<instance_name>.service-now.com/$sn-va-web-client-app.do?sysparm_default_topic=<topic_sys_id>
    sysparm_domain_id チャットをドメインの指定された Sys ID に制限します。 https://<instance_name>.service-now.com/$sn-va-web-client-app.do?sysparm_domain_id=<domain_sys_id>
    sysparm_live_agent_only 可能であれば、ユーザーをライブエージェントに直接誘導します。 https://<instance_name>.service-now.com/$sn-va-web-client-app._embed.do?sysparm_live_agent_only=true
    sysparm_load_active_only 現在のアクティブな会話をロードします。
    値：
    • true：アクティブな会話のみをロードします。
    • false：アクティブな会話をロードしません。
    注:
    sysparm_skip_load_history および sysparm_load_active_only パラメーターが両方とも true に設定されている場合、既存の sysparm_skip_load_history パラメーターが優先されます。
    		 https://<instance_name>.service-now.com/$sn-va-web-client-app.do?sysparm_load_active_only=true
    sysparm_search_text 会話の検索テキストを設定します。 https://<instance_name>.service-now.com/$sn-va-web-client-app.do?sysparm_search_text=<search_text>

    たとえば、<search_text>は request&laptop です。
    sysparm_skip_load_history 前のメッセージ履歴をスキップし、新しい会話を開始します。
    値：
    • true：メッセージ履歴をロードしません。
    • false：メッセージ履歴をロードします。
    注:
    sysparm_skip_load_history パラメーターが false に設定され、sysparm_load_active_only が true に設定されている場合、sysparm_load_active_only は現在のアクティブな会話をロードします。
    		 https://<instance_name>.service-now.com/$sn-va-web-client-app.do?sysparm_skip_load_history=true
    sysparm_ preview_mode 会話をテストモードで表示します。 https://<instance_name>.service-now.com/$sn-va-web-client-app.do?sysparm_preview_mode=true
    sysparm_requester_session_language 仮想エージェントの動的翻訳がインストールおよび構成されている場合の会話セッションの要求者の言語を指定します。 https://<instance_name>.service-now.com/$sn-va-web-client-app.do?sysparm_requester_session_language=<2 文字の言語コード>