SDK do CXone Agent:

O conteúdo desta página é para um produto ou recurso em versão controlada (CR). Se você não faz parte do grupo CR e deseja obter mais informações, entre em contato com o seu Representante de Contas do CXone.

Linguagem do SDK: TypeScript

Versão atual: 24.3

Data de lançamento da versão atual: 23 de julho 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: peça para o seu Representante de Contas do CXone fornecer um link para o repositório

O que é um SDK?

Um kit de desenvolvimento de software (SDK) é como uma caixa de ferramentas para desenvolvedores. Ele fornece um conjunto de ferramentas e recursos que facilitam a criação de aplicativos de software. Você poderia pensar nisso como uma coleção de blocos de construção pré-fabricados. Esses blocos de construção possuem funcionalidades existentes. Seus desenvolvedores podem usar esses blocos existentes em vez de criar a funcionalidade por conta própria desde o início. A seguir estão quatro benefícios gerais do uso de um SDK:

Eficiência: O SDK fornece ferramentas prontas e componentes pré-criados que economizam o tempo dos desenvolvedores. Em vez de reinventar a roda, eles podem concentrar-se nos aspectos únicos do aplicativo.
Consistência: O SDK garante a consistência entre diferentes aplicativos. Ao usar o mesmo conjunto de ferramentas e bibliotecas, os desenvolvedores mantêm uma experiência uniforme para os usuários.
Compatibilidade de plataformas: Os SDKs iOS e Android são personalizados para suas respectivas plataformas. Eles lidam com complexidades específicas do plataforma, facilitando a criação de aplicativos de plataforma cruzada.
Controle de qualidade: Com o logger, os desenvolvedores podem verificar seu código, detectar bugs antecipadamente e fornecer um software mais confiável.

Em resumo, um SDK simplifica o desenvolvimento, garante a qualidade e estimula a colaboração, tornando-o uma ferramenta essencial para uma criação de aplicativo eficiente.

O SDK do CXone Agent permite que você crie um aplicativo de agente Uma maneira de escrever datas como um inteiro de ponto flutuante. Indica o número de dias desde 30 de dezembro de 1899.. Também permite integrar a funcionalidade do CXone Agent a um aplicativo existente. Em vez de usar as APIs CXone 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 funcionam. O SDK permite usar grupos de APIs em wrappers JavaScript consumíveis.

O SDK do CXA é 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 Softphone Integrado. 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 CXA:

O SDK funciona por meio de assinaturas de eventos. Os dados da plataforma CXone são publicados com um evento. Para usar os dados, seu aplicativo deve assinar esses eventos.
Todos os recursos do CXone 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 CXA

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

Cliente de agente personalizado:
Nesse caso, você tem um recurso ou requisito específico que o CXone Agent nativo não fornece ainda. Além disso, você pode não conseguir simplesmente incorporar a funcionalidade necessária ao CXone 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 CXone 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 CXone Agent. Ele precisará assinar o fluxo de eventos VC, que é o mesmo que o CXone Agent usa.

Detalhamento do SDK

O SDK do CXA é 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.
Agent	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 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 . O fluxo de autenticação aceito é OpenID Connect com PKCE. Os usuários devem se autenticar com uma conta do CXone. Isso permite que você verifique as identidades e as permissões dos usuários com base na função Procura sinais para identificar a frustração do cliente. Os sinais incluem palavras e frases como "Estou com muita raiva". Frustração não é o mesmo que sentimento negativo. Os sinais de frustração mostram que um cliente está chateado, e não apenas dizendo algo negativo. deles no CXone. 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, 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. 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().
Voice	Esse SDK fornece a funcionalidade do Softphone Integrado. É 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 do CXone 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.

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

Exibir eventos

Instância	Evento	Descrição
CXoneAcdClient.instance.contactManager	conferenceCallEvent	Ouve eventos relacionados a teleconferências.
	onDispositionEvent	Lida com eventos relacionados a disposições Resultado atribuído pelo agente ou sistema no final de uma interação por voz (disposição) ou digital (status). de interações.
	onTagsEvent	Gerencia eventos relacionados a tags associadas a interações.
	voiceContactUpdateEvent	Ouve atualizações de contatos de voz.
	voiceMailContactUpdateEvent	Ouve atualizações de contatos de correios de voz.
	workItemContactUpdateEvent	Ouve atualizações de contatos de itens de trabalho.
CXoneAcdClient.instance.notification	onUpdateMessageEvent	Ouve novas mensagens ou notificações para o agente.
CXoneAcdClient.instance.screenPop	agentAssistSubject	Lida com eventos relacionados à assistência ao agente ou aplicativos copilot.
	contactScreenPopSubject	Lida com eventos relacionados à exibição de telas de contatos recebidos.
	pageOpenSubject	Lida com eventos relacionados à abertura de página da web.
	popUrlSubject	Lida com eventos relacionados à exibição de URLs em uma nova janela ou guia.
	runAppSubject	Lida com eventos relacionados à execução de aplicativos ou abertura de formulários personalizados.
CXoneAcdClient.instance.session	agentLegEvent	Ouve eventos relacionados à parte A parte de uma interação que ocorre entre o CXone e o agente. do agente na sessão.
	agentStateSubject	Observável que emite eventos relacionados a alterações no estado do agente, como de Disponível para Indisponível.
	naturalCallingSkillListSubject	Ouve atualizações da lista de competências habilitadas para chamada natural. Os tipos de eventos incluem: SESSION_START, SESSION_END, JOIN_SESSION_SUCCESS e JOIN_SESSION_FAILURE.
	networkOfflineSubject	Ouve eventos relacionados a problemas de conectividade de rede.
	onAgentSessionChange	Ouve alterações no status da sessão do agente, como início ou fim. Os tipos de eventos incluem: SESSION_START, SESSION_END, JOIN_SESSION_SUCCESS e JOIN_SESSION_FAILURE.
CXoneAcdClient.instance.session.agentStateService	agentStateSubject	Observável que emite atualizações sobre as alterações no estado do agente.

SDK Agent

Exibir eventos

Instância	Evento	Descrição
CXoneClient.instance	autoSummaryService	Serviço para gerenciamento de resumos automáticos.
	copilotNotificationClient	Facilita o recebimento de notificações em tempo real para o Agent Copilot.
	cxoneApiPerformanceMetrics	Ouve métricas de desempenho da API CXone.
CXoneClient.instance.agentSession	agentSessionEndSubject	Emite um evento quando a sessão do agente atual termina.
CXoneClient.instance.agentSetting	mchAgentSettingsChangeEvent	Ouve alterações nas configurações de Tornar chamada ouvida (MCH) do agente.
CXoneClient.instance.autoSummaryService	onAutoSummaryReceived	Evento observável disparado quando um resumo gerado automaticamente é recebido para um contato.
CXoneClient.instance.commitment	onCommitmentEvent	Ouve eventos relacionados aos compromissos do agente.
	onCommitmentStatusEvent	Ouve alterações no status dos compromissos do agente.
	onUpdateCommitments	Ouve atualizações dos compromissos do agente.
CXoneClient.instance.contactManager	onDigitalContactEvent	Fornece atualizações sobre interações de contato digital, como sessões de chat e mensagens enviadas no CXone.
	onDispositionEvent	Fornece atualizações sobre o status da disposição da chamada depois que ela termina.
	voiceContactUpdateEvent	Fornece atualizações em tempo real sobre os detalhes da chamada de voz em andamento, como nome do chamador e número de telefone.
CXoneClient.instance.copilotNotificationClient	onMessageNotification	Observável/emissor de evento usado para assinar mensagem ou notificações recebidas do Copilot. Os tipos de eventos incluem: ADAPTIVE_CARD, RT_SUMMARY, NEXT_BEST_RESPONSE, NEXT_BEST_RESPONSE_LLM, NEXT_BEST_RESPONSE_EXPERT, KB_ANSWERS, SENTIMENT, KB_LINKS, KB_IMAGES, TEXT, FINAL_SUMMARY, FINAL_SUMMARY_NOTES, KB_ANSWERS_VOICE, KB_IMAGES_VOICE, ENLIGHTEN_AGENT_COPILOT e AGENT_COPILOT.
CXoneClient.instance.directory	directoryEvent	Ouve eventos relacionados ao diretório, como agentes, equipes ou competências. Fornece atualizações sobre alterações nos dados do diretório, como novos contatos, atualizações e modificações de permissão no CXone.
	onUpdateSkillsEvent	Ouve atualizações sobre as competências atribuídas ao agente.
CXoneClient.instance.directory.dynamicDirectory	searchDirectoryResult	Aguarda o retorno dos resultados depois que você pesquisa algo, como uma pessoa ou departamento, em um diretório dentro do sistema.
CXoneClient.instance.indicator	agentIndicatorsEvent	Evento que fornece atualizações sobre indicadores do agente, como disponibilidade, atividade atual e indicadores de status personalizados do agente.
	contactIndicatorsEvent	Evento que fornece atualizações sobre indicadores de contato que podem desencadear ações como exibir formulários personalizados para coletar informações adicionais.
CXoneClient.instance.notification	onCXoneNotificationEvent	Ouve notificações da plataforma CXone.
CXoneClient.instance.screenPop	contactScreenPopSubject	Evento que aciona a abertura de uma página da web com informações do autor de uma chamada existente.
	pageOpenSubject	Evento que aciona a abertura de uma página da web que não está necessariamente relacionada à chamada atual.
	popUrlSubject	Evento que aciona a abertura de página da web relevante para uma chamada existente.
	runAppSubject	Evento que aciona a inicialização de um aplicativo ou a exibição de um formulário personalizado para uma chamada.
CXoneClient.instance.session	agentLegEvent	Ouve atualizações sobre um segmento de chamada específico do agente, como uma chamada recebida ou realizada.
CXoneClient.instance.session.agentStateService	agentStateSubject	Evento que fornece atualizações em tempo real sobre o status de disponibilidade do agente e alterações no estado no CXone.
CXoneClient.instance.skillActivityQueue	agentQueueSubject	Evento que fornece atualizações sobre informações de fila atribuídas ao agente, como nome da fila, contagem de chamadas e disponibilidade do agente.
	agentQueuesDetailSubject	Evento que fornece atualizações detalhadas sobre as filas atribuídas aos agentes, incluindo métricas como tempo médio de espera, acordos de nível de serviço (SLAs) e desempenho dos agentes.
	skillActivityEvent	Evento que fornece atualizações sobre métricas de atividades de competências, como tamanho da fila de chamadas, tempo médio de espera e agentes disponíveis.

SDK Auth

Exibir eventos

Instância	Evento	Descrição
CXoneAuth.instance	onAuthStatusChange	Observável que ouve as alterações no status de autenticação do usuário. Os tipos de eventos incluem: AUTHENTICATED,AUTHENTICATING, NOT_AUTHENTICATED, AUTHENTICATION_FAILED e REFRESH_TOKEN_SUCCESS

Instância

Evento

Descrição

CXoneAuth.instance

onAuthStatusChange

Observável que ouve as alterações no status de autenticação do usuário.

Os tipos de eventos incluem: AUTHENTICATED,AUTHENTICATING, NOT_AUTHENTICATED, AUTHENTICATION_FAILED e REFRESH_TOKEN_SUCCESS

SDK digital

Exibir eventos

Instância	Evento	Descrição
CXoneDigitalClient.instance.digitalContactManager	onDigitalContactEvent	Ouve eventos relacionados a contatos digitais. Os tipos de eventos incluem: CASE_INBOX_ASSIGNEE_CHANGED, CASE_STATUS_CHANGED, MESSAGE_ADDED_INTO_CASE, CASE_INBOX_ASSIGNED, CASE_INBOX_UNASSIGNED, MESSAGE_CREATED, MESSAGE_NOTE_CREATED, MESSAGE_NOTE_DELETED, MESSAGE_NOTE_UPDATED, MESSAGE_UPDATED, SENDER_TYPING_START, SENDER_TYPING_END e MESSAGE_PREVIEW.
	onDigitalContactNewMessageEvent	Ouve novas mensagens de contatos digitais.
	onDigitalContactUserTypingPreviewEvent	Ouve eventos de visualização de digitação de contatos digitais. Os tipos de eventos incluem: CASE_INBOX_ASSIGNEE_CHANGED, CASE_STATUS_CHANGED, MESSAGE_ADDED_INTO_CASE, CASE_INBOX_ASSIGNED, CASE_INBOX_UNASSIGNED, MESSAGE_CREATED, MESSAGE_NOTE_CREATED, MESSAGE_NOTE_DELETED, MESSAGE_NOTE_UPDATED, MESSAGE_UPDATED, SENDER_TYPING_START, SENDER_TYPING_END e MESSAGE_PREVIEW.

Instância

Evento

Descrição

CXoneDigitalClient.instance.digitalContactManager

onDigitalContactEvent

Ouve eventos relacionados a contatos digitais.

Os tipos de eventos incluem: CASE_INBOX_ASSIGNEE_CHANGED, CASE_STATUS_CHANGED, MESSAGE_ADDED_INTO_CASE, CASE_INBOX_ASSIGNED, CASE_INBOX_UNASSIGNED, MESSAGE_CREATED, MESSAGE_NOTE_CREATED, MESSAGE_NOTE_DELETED, MESSAGE_NOTE_UPDATED, MESSAGE_UPDATED, SENDER_TYPING_START, SENDER_TYPING_END e MESSAGE_PREVIEW.

onDigitalContactNewMessageEvent

Ouve novas mensagens de contatos digitais.

onDigitalContactUserTypingPreviewEvent

Ouve eventos de visualização de digitação de contatos digitais.

SDK Voice

Exibir eventos

Instância	Evento	Descrição
CXoneVoiceClientWrapper.instance	onCallStatusChanged	Lida com eventos relacionados a alterações no status da chamada.
	onConnectionStatusChanged	Lida com eventos relacionados a alterações no status da conexão de voz.