Como usar Virtual Agent API

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 3 min. de leitura

    • Use o app de API ServiceNow® Virtual Agent para integrar qualquer interface de bate-papo ou um bot com ServiceNow® Virtual Agent ou Bate-papo do agente. O app está disponível no ServiceNow® Store.

    Visão geral do Virtual Agent API

    A API Virtual Agent é uma API REST. Esta API é criada na estrutura de integração de bate-papo personalizada que é fornecida com Virtual Agent a partir da versão Paris. A API permite que desenvolvedores de ServiceNow, usuários avançados e administradores usem Virtual Agent de uma das seguintes maneiras:

    Bot autônomo
    Use Virtual Agent como um bot autônomo que você integra com a empresa ou com qualquer outra interface de bate-papo de terceiros que ofereça suporte a interfaces conversacionais.

    Seus usuários finais podem interagir com Virtual Agent e Bate-papo do agente por meio de vários canais usando esta integração.

    Bot secundário
    Use Virtual Agent como um bot secundário em um ambiente que tem vários bots especializados gerenciados por um bot primário.

    Neste cenário, um bot primário gerencia a comunicação com bots secundários em nome do usuário final. Um bot primário pode ser IBM Watson Assistant, Microsoft LUIS ou um bot primário interno.

    Seus bots secundários, como o bot ServiceNow, podem lidar com tipos específicos de solicitações de usuário final, como tíquetes de serviço ou reservas.

    Bot Interconnect
    Use Virtual Agent Bot Interconnect como o bot primário em um ambiente de bate-papo diversificado. Bot Interconnect cria uma experiência de bate-papo unificada e fornece aos usuários finais acesso a vários canais e a uma ampla variedade de tarefas corporativas que estão disponíveis em ServiceNow.

    A API Virtual Agent é útil para criar integrações de servidor a servidor. No entanto, para integrações que exigem a transformação de controles sem suporte que devem ser renderizados em sua interface de bate-papo existente, considere o uso da Estrutura de integração de bate-papo personalizada.

    Para obter informações sobre recursos como o formato de URL e os parâmetros de solicitação e resposta compatíveis na API Virtual Agent, consulte API de integração de bots do Virtual Agent.

    Link de vídeo para a Virtual Agent Academy. Melhore suas experiências com a API Virtual Agent (vídeo da Virtual Agent Academy)

    Como a API Virtual Agent funciona

    O diagrama a seguir mostra como a REST API processa a entrada do usuário de uma interface de bate-papo de terceiros ou de um bot primário e, em seguida, gera uma resposta de bot.
    1. O usuário fornece entrada para um bot primário ou interface de bate-papo de terceiros.
    2. O bot envia uma solicitação POST JSON para o endpoint REST de entrada (via REST API de script).
    3. O ServiceNow AI Platform autentica e processa a solicitação, que é enviada para o Virtual Agent ou para um atendente.
    4. O ServiceNow AI Platform envia um JSON de resposta POST do endpoint REST de saída (via REST API) de volta para o bot.
    5. O bot primário ou as interfaces de bate-papo de terceiros exibem a resposta para o usuário.
    Figura 1. Pontos de extremidade REST de entrada e saída na API Virtual Agent
    Diagrama que mostra como os endpoints REST na API Virtual Agent lidam com a entrada e a autenticação do usuário e a resposta e autenticação de bots.

    Para ver uma demonstração da Virtual Agent API e perguntas frequentes, consulte Introdução às APIs do Virtual Agent no site da comunidade.

    Limitações

    A API Virtual Agent não é compatível com os seguintes recursos:
    • Bate-papo da identidade visual por meio desta integração de API Virtual Agent

    Compatibilidade de versão e lançamento

    Tabela 1. Versão da API Virtual Agent e compatibilidade de lançamento
    Versão Lançamentos compatíveis
    3.14.3 Yokohama
    3.14.2 Xanadu
    3.14.1 Xanadu
    3.10.0 Washington DC
    3.9.x Vancouver
    3.8.x Vancouver
    3.7.x Utah
    3.5.x Tokyo
    3.0.x San Diego
    2.0.x Rome

    Um subconjunto de recursos é compatível com Quebec.
    1.3.0 Quebec
    1.0.12 Quebec
    1.0.9 Paris
    Nota:
    A API Virtual Agent requer uma licença Pro semelhante à de Virtual Agent.