API de Recording de interação de Tela

Uma API pode ser usada para iniciar a gravação de tela da atividade de desktop . Isso permite a gravação das telas dos agentes quando nenhum contato está em andamento e a gravação das telas de back-office.

Esta API está disponível para usuários do Engagement Hub com funcionalidade de Recording de voz ou de tela e usuários NiCE CXoneACD.

Antes de Iniciar

Você pode testar as NiCE CXone APIs no portal do desenvolvedor Icon of dark gray square with an arrow pointing out of its upper right corner. Faça login com uma conta NiCE CXone e, em seguida, você pode fazer solicitações com o locatárioClosed Agrupamento organizacional de alto nível usado para gerenciar o suporte técnico, o faturamento e as configurações globais do seu sistema NiCE CXone. da sua conta.

Para começar a usar a API, você deve registrar-se com NiCE para receber credenciais válidas usadas para autenticação. Revise a página de Introdução Icon of dark gray square with an arrow pointing out of its upper right corner no portal do desenvolvedor para obter instruções.

Além disso, o uso dessas API requer a permissão Interactions Hub Record screen interaction.

Iniciar interação de Tela Recording

A API permite a iniciação da gravação de tela para um usuário específico que não esteja em uma chamada ativa. Você deve especificar a duração da gravação fornecendo-a como um parâmetro no comando de iniciar. A duração deve estar entre 5 segundos e 3:30 horas, o tempo máximo permitido. A Recording será parada automaticamente quando a duração for atingida. Além disso, você pode parar a gravação de tela invocando o comando stop-screen-interaction-recording.

  • Quando a gravação é iniciada (indicada por um código da resposta 202) ou bem-sucedida (indicada por um código da resposta 200), o Id do contato associado à tela gravada será fornecido. Esse Id do contato deve ser usado ao emitir o comando Parar.

  • A API pode ser utilizada durante uma chamada em andamento entre um agente e um cliente, que pode ser gravada. Nesses casos, haverá duas gravações distintas - uma capturando a conversa de voz e a outra baseada em interações de API - cada uma associada a IDs de contato diferentes.

  • Se o mascaramento for aplicado a uma chamada em andamento, ele também afetará uma interação de screen recording de API que possa estar sendo gravada em paralelo.

  • Ao usar a API, pode haver até 10 instâncias de Recording de interação de tela por usuário, cada uma com um id do contato diferente. Qualquer Chamada de API subsequente para o mesmo usuário resultará em um erro (429).

Método: POST

Terminal: /interaction-recording-management-service/v1/interactions/start-screen-interaction-recording

Parâmetros:

userId*:

(query)

Sequência

Id DO usuário a ser registrado.

recordingDuration*:

(query)

number

Especifica a duração necessária de Recording dentro do alcance de 5-13200 segundos

Parar gravação de interação na tela

A API permite parar a gravação de tela do id do contato de um usuário específico que foi iniciada usando o comando start-screen-interaction-recording. Você deve usar o id do contato fornecido na resposta do comando start-screen-interaction-recording. Se esse método não for chamado, a gravação de tela é parada automaticamente após a duração fornecida no comando start-screen-interaction-recording.

Método: POST

Terminal: /interaction-recording-management-service/v1/interactions/stop-screen-interaction-recording

Parâmetros:

userId*:

Sequência

O id DO usuário gravado a ser interrompido.

contactId*:

number

O id do contato retornado no comando Iniciar gravação de tela.