SDK do Agent:

Linguagem do SDK: TypeScript

Versão atual: 24.4

Data de lançamento da versão atual: 15 de outubro de 2024

Disponibilidade: todas as regiões e todos os segmentos de negócios

Suporte para navegador: Google Chrome, Microsoft Edge, Island Enterprise

Repositório do SDK: GitHub

NPM: ACD , Agente , Autenticação , Digital , Voz

API Referência: CXone Mpower Portal do desenvolvedor

O SDK do CXone Mpower Agent permite que você crie uma aplicativo de agente. Também permite integrar a funcionalidade do Agent a um aplicativo existente. Em vez de usar as APIs CXone Mpower diretamente, os desenvolvedores podem usar a funcionalidade pré-criada por meio do SDK. Isso acelera o tempo de desenvolvimento e economiza recursos. Seus desenvolvedores não precisam saber como todas as APIs CXone Mpower funcionam. O SDK permite usar grupos de APIs em wrappers JavaScript consumíveis.

O SDK do Agent é uma compilação de SDKs menores. Cada SDK menor se concentra em um aspecto específico da funcionalidade, como autenticação ou controles de chamadas. Para atender ao seu caso de uso, você pode escolher apenas os SDKs necessários. Por exemplo, talvez você não precise do SDK Voice, que fornece a funcionalidade WebRTC para um Integrated Softphone. Isso também significa que os desenvolvedores só precisam instalar os SDKs necessários para o seu caso de uso.

Fatos importantes sobre o SDK do Agent:

• O SDK funciona por meio de assinaturas de eventos. Os dados da plataforma CXone Mpower são publicados com um evento. Para usar os dados, seu aplicativo deve assinar esses eventos.

• Todos os recursos do Agent estão disponíveis por meio desse SDK.

• Você precisa registrar o aplicativo que será usado com o SDK. Preencha o formulário de registro para receber credenciais para esse aplicativo. A página Introdução do portal de desenvolvedores orienta você ao longo do processo de registro do seu aplicativo e da configuração de autenticação.

• O SDK aceita o OpenID Connect com o fluxo de autenticação PKCE.

Casos de uso para o SDK do Agent

A seguir são citados três casos de uso comuns do SDK do Agent.

• Cliente de agente personalizado:
  Nesse caso, você tem um recurso ou requisito específico que o Agent nativo não fornece ainda. Além disso, você pode não conseguir simplesmente incorporar a funcionalidade necessária ao Agent. Por exemplo, talvez você precise limitar a visibilidade dos agentes nas informações de contato. Isso poderia ser para um requisito de segurança específico. Pode ser necessário mascarar todos os dados do contato dos agentes, o que somente um cliente personalizado pode facilitar.

• Integrar um cliente de agente com um aplicativo de terceiros:
  Nesse caso, você não pode incorporar o o aplicativo de agente a outro aplicativo. Outros aplicativos são geralmente CRMs, sites de online banking ou sistemas de reservas de hotéis. Esse caso de uso é quando você quer a funcionalidade de um cliente de agente, mas não precisa necessariamente da interface de usuário do cliente. Usando o SDK, você pode incorporar parte da funcionalidade em outro aplicativo. Tomando o sistema de hotel como exemplo, a equipe poderia ligar para um quarto específico por meio do sistema de reservas.

• Assinatura de eventos para aplicativos incorporados:
  Isso é comumente usado para cumprir certas restrições de segurança do navegador. Por exemplo, o Google impede a postagem de dados em uma janela em iframe de outro site. Isso complica o modo como as janelas podem compartilhar mensagens ou dados entre os dois quadros. Por exemplo, você tem um aplicativo aplicativo de saúde que tem iframe no Agent. Quando o agente aceita um contato, você quer usar o número de telefone do contato para consultar as informações dele em seu aplicativo de saúde. Isso permite que você exiba automaticamente as informações do contato para o agente. Se o agente usar o Google Chrome, o aplicativo de saúde não poderá obter o número de telefone do contato do Agent. Ele precisará assinar o fluxo de eventos VC, que é o mesmo que o Agent usa.

Detalhamento do SDK

O SDK do Agent é composto pelos seguintes SDKs menores:

SDK	Detalhes
ACD	Esse SDK oferece recursos para lidar com chamadas de voz, correios de voz e itens de trabalho Método personalizável de entrega de contatos para um agente via scripts do Studio.. Por exemplo: Para chamadas de voz, você pode iniciar, receber, transferir e colocar chamadas em conferência. Para correio de voz, você pode receber, armazenar e gerenciar mensagens de voz. Para itens de trabalho, você pode automatizar a distribuição de itens de trabalho para os agentes. Isso otimiza a carga de trabalho dos agentes usando regras e critérios predefinidos. Exibir detalhes técnicos Estes são os principais detalhes técnicos do SDK ACD: Após uma autenticação bem-sucedida, você pode chamar initAcdEngagement() para criar a instância desse módulo e incorporar recursos ACD. Você pode estabelecer uma sessão entre um agente e o contato usando os métodos startSession e joinSession. Depois que a sessão é estabelecida, seu aplicativo pode chamar outros métodos para recursos como discagem, transferência, conferência, entre outros. A chamada bem-sucedida dos métodos desse módulo gera eventos ACD.
Agente	Esse SDK é para lidar com eventos de sessão. Ele permite iniciar sessões, entrar em uma sessão que está em andamento, entre outras coisas. Os focos principais são: O loop get-next-event Qualquer coisa que as áreas ACD e Digital Experience da plataforma CXone Mpower tenham em comum, como WEM ou notificações.
Auth	Esse SDK facilita a autenticação e autorização seguras. Basicamente, ele permite configurar um fluxo de login usando a autenticação global do CXone Mpower . O fluxo de autenticação aceito é OpenID Connect com PKCE. Os usuários devem se autenticar com uma conta do CXone Mpower. Isso permite que você verifique as identidades e as permissões dos usuários com base na função Diferente de sentimento negativo. Os sinais de frustração mostram que um cliente está chateado, e não apenas dizendo algo negativo. deles no CXone Mpower. Os recursos principais incluem: Atualizar tokens auth automaticamente. Isso permite que os usuários permaneçam conectados até que fechem o aplicativo ou façam logout. Gerenciamento e validação de tokens. Se um usuário já estiver conectado no CXone Mpower, você pode passar o token auth válido para o seu aplicativo. Exibir detalhes técnicos Estes são os principais detalhes técnicos do SDK Auth: Chame cxoneAuth.init() para passar cxoneHostname, clientId e redirectUri ao SDK. Invoque o método getAuthorizeUrl() para redirecionar o usuário para a página de autenticação global do CXone Mpower. Após o login, ele é redirecionado para o seu aplicativo. Quando o usuário insere as credenciais e inicia a autenticação, um objeto AuthSettings é criado com as informações do usuário. A instância CXoneAuth é inicializada usando AuthSettings. Use getAccessTokebByCode() para capturar o código retornado e gerar um token de autenticação. Isso também salva as informações do usuário. Assine onAuthStatusChange, que gera eventos sobre autenticação, como AUTHENTICATED ou AUTHENTICATEDFAILED. No caso de AUTHENTICATED, isso aciona automaticamente o fluxo de atualização, mantendo o usuário conectado.
Digital	Esse SDK permite integrar canais de comunicação digital. Você pode usar canais digitais padrão, como e-mail, chat e SMS, além de plataformas de mídia social, como o WhatsApp. Dependendo do número de canais configurados, você pode criar a comunicação multicanal. Exibir detalhes técnicos Estes são os principais detalhes técnicos do SDK Digital: Após uma autenticação bem-sucedida, você pode chamar CXoneDigitalClient.instance.initDigitalEngagement(). Isso gera uma instância dos componentes necessários para mensagens digitais e estabelece uma conexão WebSocket digital. Use eventos digitais para receber casos já atribuídos e suas cadeias de mensagens existentes. Seu aplicativo podem responder a mensagens digitais com o método reply(). Você também pode iniciar uma nova interação de saída com o método reply(). Para usar esse SDK, a origem do seu aplicativo deve ser permitida pelo Digital Experience plataforma. Você deve fornecer quaisquer origens para o seu Representante de contas. As origens devem ser permitidas pelo Digital plataforma.
Voz	Esse SDK fornece a funcionalidade do Integrated Softphone. É um wrapper para o WebRTC.

Recursos

Um SDK permite que você crie sua própria funcionalidade personalizada. Portanto, seus recursos de suporte são principalmente conteúdo de autoatendimento. Suas opções de suporte técnico são baseadas no contrato de suporte da sua organização com a NICE. Entre em contato com o seu Representante de contas para obter mais informações sobre as opções de suporte.

Além dessa página, seu conteúdo de autoatendimento se concentra em recursos para desenvolvedores. O pacote de SDKs inclui o seguinte:

• READMEs para cada SDK que fornece informações sobre como começar a usá-los.

• Uma amostra de aplicativo para mostrar a funcionalidade básica.

• Exemplos de uso com trechos de código da amostra de aplicativo.

• Comentários sobre os códigos.

Suporte a vários soquetes

A fila de interface do usuário CXone Mpower é uma abordagem baseada em WebSocket para emitir eventos de ACD. Esta é uma alternativa à sondagem longa do próximo evento. A fila da interface do usuário não oferece suporte a conexões de vários soquetes - os mesmos eventos não podem ser emitidos para o cliente Agent e para o SDK do Agent. Portanto, se você quiser testar ou verificar determinadas funcionalidades do SDK usando Agent, feche o aplicativo que está consumindo o SDK.

Eventos

A seguir são citados os eventos que o seu aplicativo pode ouvir. Os eventos são categorizados pelo módulo em que estão disponíveis.

SDK ACD

SDK Agent

SDK Auth

SDK digital

SDK Voice