Gravação de interação na tela API

Um API pode ser usado para iniciar a gravação de tela de atividade na área de trabalho. Isso permite gravar as telas dos agentes quando nenhum contato estiver em andamento e a gravação das telas do back-office.

Este API está disponível para usuários do Engagement Hub com funcionalidade de gravação de voz ou tela e usuários CXone MpowerACD.

Antes que você comece

Você pode testar CXone Mpower APIs no portal do desenvolvedor . Efetue login com uma conta CXone Mpower e faça solicitações com o locatário da sua conta.

Para começar a usar as APIs, você deve se registrar no NiCE para receber credenciais válidas usadas para autenticação. Revise a página Introdução no portal do desenvolvedor para obter instruções.

Além disso, o uso dessas APIs requer a permissão Interactions Hub Gravar interação na tela.

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

O API habilita o início da gravação de tela para um usuário específico que não está em uma chamada ativa. Você deve especificar a duração da gravação fornecendo-a como um parâmetro no comando start. A duração deve ser entre 5 segundos a 3:30 horas, o tempo máximo permitido. A gravação será interrompida automaticamente quando a duração for atingida. Além disso, você pode interromper a gravação de tela invocando o comando stop-screen-interaction-recording.

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

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

  • Se o mascaramento for aplicado a uma chamada em tempo real, ele também afetará uma interação de gravação de tela API que pode ser gravada em paralelo.

  • Ao usar o API, pode haver uma única instância de gravação de tela. Se a tela de um agente já estiver sendo gravada por meio do API, qualquer chamada de API subsequente para esse mesmo agente não gerará uma nova gravação de tela nem atualizará a duração da gravação.

Método: POST

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

Parâmetros:

userId*:

(consulta)

string

ID do usuário a ser gravado.

recordingDuration*:

(consulta)

number

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

POST /interaction-recording-management-service/interactions/start-screen-interaction-recording?user-id=1234567&recordingDuration=3000

Respostas

  • Status 200-Operação bem-sucedida.

    description (string): a descrição da resposta.

    contactId (número): o ID do contato do ACD.

    interactionId (string): a ID de interação global.

    httpStatus (string): a descrição do status HTTP.

  • Status 202-A operação está em andamento.

    contactId (número): o ID do contato do ACD.

    interactionId (string): a ID de interação global.

    httpStatus (string): a descrição do status HTTP.

  • Status 400 – Solicitação incorreta.

  • Status 401 - O usuário solicitante não conseguiu se autenticar.

  • Status 403 – O usuário solicitante não está autorizado a realizar a operação.

  • Status 404-Não encontrado. Não foram encontradas interações ativas.

  • Status 425 - A interação está bloqueada durante o processamento de uma solicitação anterior.

  • Status 500-Interna erro de servidor.

  • Status 504 – A solicitação atingiu o tempo limite.

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

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

Método: POST

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

Parâmetros:

userId*:

string

O ID do usuário gravado a ser interrompido.
contactId*:

number

O contato ID retornado no comando Gravação da tela inicial.

POST /interaction-recording-management-service/interactions/stop-screen-interaction-recording?user-id=1234567&contactId=1122334455

Respostas

  • Status 200-Operação bem-sucedida.

  • Status 202-A operação está em andamento.

  • Status 400 – Solicitação incorreta.

  • Status 401 - O usuário solicitante não conseguiu se autenticar.

  • Status 403 – O usuário solicitante não está autorizado a realizar a operação.

  • Status 404-Não encontrado. Não foram encontradas interações ativas.

  • Status 425 - A interação está bloqueada durante o processamento de uma solicitação anterior.

  • Status 500-Interna erro de servidor.

  • Status 504 – A solicitação atingiu o tempo limite.