Parâmetros de URL Virtual Agent

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 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 cliente Web Virtual Agent

    O cliente web Virtual Agent é compatível para uso em portais ou incorporado em páginas de terceiros. Os parâmetros do sistema a seguir controlam o conteúdo da conversa renderizado no cliente Web Virtual Agent.
    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://<instancename.service-now.com/$sn-va-web-client-app.do?sysparm_branding_key=acme
    • Aplique a configuração de identidade visual a um cliente Web incorporado: https://<instancename.service-now.com/$sn-va-web-client-app._embed.do?sysparm_branding_key=acme
    sysparm_default_topic Define o tópico padrão na inicialização por meio do tópico sys_ID. https://<instancename> .service-now.com/$sn-va-web-client-app.do?sysparm_default_topic=1f5ac6dfc34020105a61d7de76400001
    sysparm_domain_id Restringe o bate-papo ao ID do sistema especificado para um domínio. https://<instancename>.service-now.com/$sn-va-web-client-app.do?sysparm_domain_id=c90d4b084a362312013398f051272c0d
    sysparm_live_agent_only Leva o usuário diretamente para um atendente, se disponível. https://<instancename.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://<instancename.service-now.com>$sn-va-web-client-app.do?sysparm_load_active_only=true
    sysparm_nowassist Carrega o Now Assist no cliente do Virtual Agent. https://<instancename> .service-now.com/$sn-va-web-client-app._embed.do?sysparm_nowassist=true
    sysparm_search_text Define o texto de pesquisa da conversa. https://<instancename> .service-now.com/$sn-va-web-client-app.do?sysparm_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://<instancename.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://<instancename.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 da conversa https://<instancename.service-now.com>$sn-va-web-client-app.do?sysparm_requester_session_language=<two-letter language code>