API de Extração de Dados

As APIs de Extração de dados permitem extrair dados de NiCE CXone para fins de relatórios externos. Por exemplo, você pode extrairQM dados de fluxo de trabalho,QM dados de perguntas e respostas,Recording Management (CXone) metadados de interação, ouWFM Dados da Folha de pagamento. Os dados só podem ser filtrados de acordo com o intervalo DE datas especificado. Os dados do Gerenciamento de qualidade são enviados para a API de Extração de Dados a cada 15 minutos.

Você pode testar as APIs de Extração de Dados e revisar sua documentação no portal do desenvolvedorIcon of dark gray square with an arrow pointing out of its upper right corner.

Ao chamar POST /jobs, um jobId é retornado enquanto os dados estão sendo preparados. Você pode verificar se os dados estão prontos ao consultar o serviço a partir do terminal /jobs/{jobId}, que retorna o status do trabalho. Se o status for sucesso, também será retornado um URL adicional. O URL ficará acessível por 30 segundos (sem incluir o tempo necessário para fazer o download do arquivo).

Você pode escrever Scripts para chamar a API periodicamente, em vez de recuperar os dados manualmente a cada vez. A qualquer momento, apenas um usuário por inquilino pode chamar uma API. Você só pode chamar a API uma vez em um período de 30 segundos.

A partir de 17 de Novembro de 2026, você pode extrair dados de 15 dias somente por Chamada de API. Você pode usar qualquer data DE início em seu histórico e uma data DE término até 15 dias depois. Se você quiser extrair dados por mais de 15 dias, será necessário fazer múltiplas Chamadas de API.

Alice é a responsável pela Conformidade no Contact center da Classics, Inc. Ela deseja recuperar as gravações de voz de um agente específico ao longo de um período de 60 dias. Alice cria quatro Chamadas de API, uma chamada para cada período de 15 dias.

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.

Uso dessas API requer as seguintes permissões:

  • Entidade:

    • Se você estiver extraindo metadados de interação, então você precisa da permissão pesquisa e Reproduzir > API > Extract Interaction Metadata.

    • Se você estiver extraindo QM dados do fluxo de trabalho, precisará da permissão QM Tools > Data Extraction APIs > QM Workflow API.

    • Se você estiver extraindo QM dados de P&R, você precisará da permissão QM Ferramentas > API de Extração de Dados > API de Workflow do QM.

    • Se você estiver extraindo dados de WFM Folha de pagamento, então você precisa da permissão WFM > API de Extração de Dados > WFM API de Folha de pagamento.

    • Se você estiver extraindo QM notas do avaliador, então você precisará da permissão QM Tools > API de Extração de Dados > API de Notas do Avaliador QM.

Get Empregos

Visualize uma lista de todos os status de trabalhos por locatário. Os status possíveis são Operando, Sucedido, Falhou, cancelado e Expirado.

Método: GET

Terminal: /data-extraction/v1/jobs

Parâmetros: Nenhum

Preparar empregos

Depois que uma solicitação para extrair dados é feita, os dados são coletados e preparados para extração. Os dados estão disponíveis no S3 como um Arquivo csv por 24 horas. Quando concluído, um id do trabalho é retornado.

Método: POST

Terminal: /data-extraction/v1/jobs

Parâmetros: Nenhum

Obter Empregos por Id do trabalho

Exibir o status de um trabalho específico de acordo com seu ID de trabalho. Se um trabalho foi bem-sucedido, uma URL para acessar os dados extraídos é retornada e fica acessível por 30 segundos (sem incluir o tempo necessário para o download do arquivo). Se o trabalho falhar, uma mensagem de erro será retornada. O link pode ser usado para acessar os dados extraídos. Os possíveis status do trabalho são Em execução, Succeeded, Failed, Cancelled e Expirado.

Método: GET

Terminal: /data-extraction/v1/jobs

Parâmetros:

jobId*:

Sequência

Identificador exclusivo para a solicitação que foi feita para extrair dados de clientes.

QM Entidade de Workflow e CSV Arquivo

A API de Fluxo de trabalho do QM permite extrair dados do fluxo de trabalho do QM, incluindo avaliações, autoavaliações e calibrações.

Para o trabalho POST:

  • entityName é: qm-workflows

  • A versão é: 4

Os dados são filtrados de acordo com a Data de Envio (em UTC).

QM Perguntas e respostas (Q&A) Entidade e Arquivo csv

A API de perguntas e respostas do QM permite que você extraia as perguntas e respostas das avaliações, autoavaliações e calibrações do QM.

Para o trabalho POST:

  • entityName é: qm-questions

  • version é: 2

Os dados são filtrados de acordo com a Data de Envio (em UTC).

QM Notas do avaliador e Arquivo csv

A API de Notas de Avaliador do QM permite extrair notas de avaliador do QM.

Para o trabalho POST:

  • entityName é: qm-evaluation-comment-entity

  • Versão é: 1

Os dados são filtrados de acordo com a Data de Envio (em UTC).

Entidade de Metadados de Interação e Arquivo csv

A API Interaction Metadata permite extrair Metadados de interação de Recording Management (CXone).

Para o trabalho POST:

  • entityName é: recording-interaction-metadata

  • Versão é: 12

  • Para filtrar dados por data e hora, use startDate e endDate em UTC com o formato: yyyy-mm-dd hh:mm:ss

    A partir de 17 de Novembro de 2026, o intervalo DE datas entre startDate e endDate não pode exceder 15 dias corridos. Um intervalo de exatamente 15 dias é aceito. Se você solicitar um intervalo de 16 dias ou mais, a solicitação será rejeitada.

WFM Entidade de folha de pagamento e Arquivo csv

A API de Folha de pagamento do WFM (versão1) permite que você extraia dados de atividade de WFM para fins de relatórios de folha de pagamento externos.

O nome da entidade WFM Folha de pagamento para o trabalho POST é: wfm-payroll.

Os dados são filtrados de acordo com o código da folha de pagamentoencontro. Manter em mente, o fuso horário da data e hora está de acordo com o fuso horário da unidade DE agendamento.