APIs de gravação sob demanda

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

Essas APIs permitem iniciar, parar e desativar a gravação de chamadas sob demanda, o que possibilita o controle de gravações via API.

A documentação das APIs de registro sob demanda está disponível no portal da Comunidade de Desenvolvedores .

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 dessa API requer a permissão Interactions Hub >APIs > Multi-ACD Record on Demand API.

Comece a gravar sob demanda

A API permite que um agente ou aplicativo comece a gravar uma chamada em andamento para um usuário específico. Ele pode ser usado para capturar interações ou conversas específicas que sejam relevantes para fins de conformidade, garantia de qualidade ou treinamento.

É possível especificar o início da gravação apenas da voz ou da voz e da tela. Este método API tem prioridade em comparação com políticas de gravação.

O sinalizador mediaType é opcional e permite controlar quais tipos de mídia são gravados. Os valores compatíveis são voice e voiceAndScreen, permitindo iniciar a gravação somente da voz ou da voz e da tela. Se o sinalizador não for passado, o valor padrão será voice.

Método: POST

Endpoint: /interaction-recording-management-service/interactions/start-recording-on-demand

Parâmetro:

userId*:

string

O tipo de mídia a ser gravado.

POST /interaction-recording-management-service/interactions/start-recording-on-demand?user-id=1234567

Resposta

  • Status 200-Operação bem-sucedida. Iniciar a gravação quando a solicitação sob demanda for iniciada.

  • Status 202-Operação em andamento. A solicitação de início sob demanda foi aceita e está sendo processada.

  • 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 409 - A solicitação não pode ser executada devido ao estado do serviço.

  • Status 425 - A interação está bloqueada durante o processamento de um registro anterior sob demanda/Parar solicitação sob demanda

  • Status 500-Interna erro de servidor.

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

Parar gravação sob demanda

A API permite interromper a gravação da voz e da tela de uma chamada em andamento para um usuário específico. Ela pode ser usada para proteger a privacidade do cliente ou para cumprir as normas que restringem a gravação de determinados tipos de conversas.

Esse método de API dá prioridade sobre Recording políticas. A opção POST Interromper a gravação sob demanda somente pode ser retomada chamando Iniciar a gravação sob demanda.

Método: POST

Endpoint: /interaction-recording-management-service/interactions/stop-recording-on-demand

Parâmetro:

userId*:

string

ID do usuário do agente a ser gravado.

POST /interaction-recording-management-service/interactions/stop-recording-on-demand?user-id=1234567

Resposta

  • Status 200-Operação bem-sucedida. A solicitação de interrupção da gravação sob demanda foi iniciada.

  • Status 202-Operação em andamento. A solicitação de interrupção sob demanda foi aceita e está sendo processada.

  • 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 409 - A solicitação não pode ser executada devido ao estado do serviço.

  • Status 425 - A interação é bloqueada durante o processamento de um registro anterior sob demanda/Parar solicitação sob demanda.

  • Status 500-Interna erro de servidor.

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

Desative a Opção de Gravar a Chamada

A API permite desabilitar a opção de gravar a voz e a tela de uma chamada, caso o cliente recuse o consentimento e não concorde em ser gravado. Isso é especialmente relevante para o Regulamento Geral de Proteção de Dados da UE (RGPD). Se um cliente recusar o consentimento, CXone Mpower Recording não gravará a chamada, mesmo que haja uma política de gravação definida para gravar a chamada, ou se o agente gravar a chamada sob demanda ou usando API.

Após a API, a gravação de chamadas não pode ser iniciada para o contato inteiro com o cliente, incluindo transferências, consultas e conferências. Se o API foi chamado enquanto a gravação da chamada estava em andamento Recording interromperá a gravação, a parte gravada da chamada estará disponível para pesquisa e reprodução.

O consentimento de gravação somente se aplica à chamada atual. Ele não é salvo para o cliente para interações futuras.

Método: POST

Endpoint: /interaction-recording-management-service/interactions/do-not-record

Parâmetro:

userId*:

string

ID do usuário do agente a ser gravado.

POST /interaction-recording-management-service/interactions/do-not-record?user-id=1234567

Resposta

  • Status 200-Operação bem-sucedida. A solicitação de não gravação foi iniciada.

  • Status 202-Operação em andamento. A solicitação de Não gravar foi aceita e está sendo processada.

  • 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 409 - A solicitação não pode ser executada devido ao estado do serviço.

  • 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.