Parâmetros de URL Virtual Agent

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 1 min. de leitura
  • Virtual Agent fornece vários parâmetros do sistema que os administradores podem adicionar a um URL de instância para controlar como o conteúdo da página é renderizado.

    Estrutura do URL Virtual Agent

    Você pode controlar a página renderizada para uma instância adicionando parâmetros de URL ao URL da instância, que é https://<instancename>.service-now.com.

    Parâmetros do sistema para Virtual Agent widget de bate-papo

    . Virtual Agent o widget de bate-papo é compatível com portais ou incorporado em páginas de terceiros. Os parâmetros do sistema a seguir controlam o conteúdo da conversa renderizado no Virtual Agent widget de bate-papo.
    Parâmetro Descrição Exemplo
    sysparm_branding_key

    Aplica uma configuração de identidade visual do bate-papo ao cliente de bate-papo da Web.

    Valor: chave de identidade visual para configuração

    • Aplique a configuração de identidade visual a uma página de destino: https://<instance_name>.service-now.com/$sn-va-web-client-app.do?sysparm_branding_key=<branding_key>
    • Aplique a configuração de identidade visual a um widget de bate-papo incorporado: https://<instance_name>.service-now.com/$sn-va-web-client-app._embed.do?sysparm_branding_key=<branding_key>
    sysparm_default_topic Define o tópico padrão na inicialização por meio do tópico sys_ID. https://<instance_name>.service-now.com/$sn-va-web-client-app.do?sysparm_default_topic=<topic_sys_id>
    sysparm_domain_id Restringe o bate-papo ao ID do sistema especificado para um domínio. https://<instance_name>.service-now.com/$sn-va-web-client-app.do?sysparm_domain_id=<domain_sys_id>
    sysparm_live_agent_only Leva o usuário diretamente para um atendente, se disponível. https://<instance_name>.service-now.com/$sn-va-web-client-app._embed.do?sysparm_live_agent_only=true
    sysparm_load_active_only Carrega a conversa ativa atual.
    Valores:
    • verdadeiro: carrega somente a conversa ativa
    • falso: não carrega conversas ativa
    Nota:
    Se os parâmetros sysparm_skip_load_history e sysparm_load_active_only estiverem definidos como verdadeiros, o parâmetro sysparm_skip_load_history existente terá precedência.
    https://<instance_name>.service-now.com/$sn-va-web-client-app.do?sysparm_load_active_only=true
    sysparm_search_text Define o texto de pesquisa da conversa. https://<instance_name>.service-now.com/$sn-va-web-client-app.do?sysparm_search_text=<search_text>

    Por exemplo, <search_text> é request&laptop.

    sysparm_skip_load_history Ignora o histórico de mensagens anteriores e inicia uma nova conversa.
    Valores:
    • verdadeiro: não carrega o histórico de mensagens
    • falso: carrega o histórico de mensagens
    Nota:
    Se o parâmetro sysparm_skip_load_history estiver definido como falso e o sysparm_load_active_only estiver definido como verdadeiro, o sysparm_load_active_only carregará a conversa ativa atual.
    https://<instance_name>.service-now.com/$sn-va-web-client-app.do?sysparm_skip_load_history=true
    sysparm_ preview_mode Exibe a conversa no modo de teste. https://<instance_name>.service-now.com/$sn-va-web-client-app.do?sysparm_preview_mode=true
    sysparm_requester_session_language Especifica o idioma do solicitante para a sessão de conversa quando Tradução dinâmica para Virtual Agent está instalado e configurado. https://código de idioma do <instance_name>.service-now.com/$sn-va-web-client-app.do?sysparm_requester_session_language=<two-letter>