API de gravação sob demanda
Esta API está disponível para usuários do Engagement Hub com funcionalidade de voz ou gravação de 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 da API de gravação sob demanda está disponível no portal Developer Community
.
Antes de Iniciar
Você pode testar as NiCE CXone APIs no portal do desenvolvedor
. Faça login com uma conta NiCE CXone e, em seguida, você pode fazer solicitações com o locatário
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
no portal do desenvolvedor para obter instruções.
Além disso, o uso desta API requer a permissão Interactions Hub >API > Multi-ACD Record on Demand API.
Iniciar gravação sob demanda
A API permite que um agente ou aplicativo inicie a gravação de uma chamada em andamento para um usuário específico. Ela pode ser usada para capturar interações ou conversas específicas que sejam relevantes para fins de conformidade, garantia da qualidade ou treinamento.
Você pode especificar iniciar a gravação de apenas voz, ou de voz e 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 suportados são voice e voiceAndScreen, permitindo iniciar a gravação de apenas voz ou de voz e tela. Se o sinalizador não for passado, o valor padrão será voice.
Método: POST
Terminal: /interaction-recording-management-service/interactions/start-recording-on-demand
Parâmetro:
| userId*: |
Sequência 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. Nenhuma interação ativa foi encontrada.
-
A solicitação não pode ser executada devido ao status do serviço.
-
Status 425 - A interação está bloqueada durante o processamento de uma solicitação anterior de Gravar sob demanda/Parar 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 Recording de voz e 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 regulamentações que restringem a Recording de determinados tipos de conversas.
Este método de API tem prioridade sobre as políticas Recording Management (CXone). A opção POST Interromper a gravação sob demanda somente pode ser retomada chamando Iniciar a gravação sob demanda.
Método: POST
Terminal: /interaction-recording-management-service/interactions/stop-recording-on-demand
Parâmetro:
| userId*: |
Sequência 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. Nenhuma interação ativa foi encontrada.
-
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 de Gravar sob demanda/Parar sob demanda.
-
Status 500—erro interno de servidor.
-
Status 504—A solicitação atingiu o tempo limite.
Desabilitar 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 (GDPR) da UE. Se um cliente recusar o consentimento, então NiCE CXone Recording Management (CXone) 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 a API.
Após a Chamada de API, a gravação não pode ser iniciada para todo o contato do cliente, incluindo transferências, consultas e conferências. Se a API foi chamada enquanto a gravação da chamada estava em andamento, Recording Management (CXone) interromperá a gravação, e a parte gravada da chamada estará disponível para busca e reprodução.
O consentimento de gravação se aplica somente à chamada atual. Ele não é salvo para o cliente para interações futuras.
Método: POST
Terminal: /interaction-recording-management-service/interactions/do-not-record
Parameter:
| userId*: |
Sequência 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. Nenhuma interação ativa foi encontrada.
-
O 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—erro interno de servidor.
-
Status 504 — A solicitação atingiu o tempo limite.