APIs de extração de dados

As APIs de extração de dados permitem extrair dados de CXone para fins de relatórios externos. Por exemplo, você pode extrairCXone QM dados de fluxo de trabalho,CXone QM dados de perguntas e respostas,CXone Recording metadados de interação, ouCXone WFM Dados da folha de pagamento. Os dados podem ser filtrados apenas de acordo com o período especificado.

As APIs de extração de dados estão disponíveis no Portal da comunidade de desenvolvedores DEVone.

Para obter mais informações sobre domínios e URLs, consulte Começando no portal DEVone Developer Community.

Ao chamar o terminal /trabalhos com o método POST, um ID de trabalho é retornado enquanto os dados estão sendo preparados. Você pode verificar se os dados estão prontos pesquisando o serviço a partir do terminal / trabalhos/ {jobId}, o status do trabalho é retornado. 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ê pode chamar a API apenas uma vez em um período de 30 segundos.

Antes que você comece

Antes de começar a usar a API de dados corporativos, você deve configurar permissões de usuários, gerar uma chave de acesso e seguir o processo de registro e autenticação explicado no portal de programadores. Permissões necessárias:

  • Entidade:

    • Se estiver extraindo metadados de interação, você precisará da permissão Pesquisa e Reprodução > APIs > Extrair metadados de interação.

    • Se você estiver extraindo dados de fluxo de trabalho CXone QM, então você precisa da permissão Ferramentas QM > APIs de extração de dados > API de fluxo de trabalho QM.

    • Se você está extraindo CXone QM Dados de perguntas e respostas , então você precisa da permissão Ferramentas QM> APIs de extração de dados > API de fluxo de trabalho QM.

    • Se você está extraindoCXone WFMDados da folha de pagamento, então você precisa do CXone WFM> APIs de extração de dados>CXone WFM API Payroll permissão.

GET Trabalhos

Veja uma lista de todos os status do trabalho por inquilino. Os status possíveis são Operando, Sucedido, Falhou, Cancelado e Expirado.

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

PEGUE Cargos por ID do cargo

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 status possíveis são Operando, Sucedido, Falhou, Cancelado e Expirado.

CXone QM Entidade de fluxo de trabalho e arquivo CSV

A API de fluxo de trabalho do CXone QM permite extrair dados do fluxo de trabalho do CXone 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 o Data de Envio (em UTC).

CXone QM Entidade de perguntas e respostas (Q&A) e arquivo CSV

A API de perguntas e respostas do CXone QM permite extrair perguntas e respostas de avaliações, autoavaliações e calibrações do CXone QM.

Para o trabalho POST:

  • entityName é: qm-questions

  • version é: 2

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

Notas de avaliador e arquivo CSV do CXone QM

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

Para o trabalho POST:

  • entityName é: qm-evaluation-comment-entity

  • versão é: 1

Os dados são filtrados de acordo com o 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 CXone Recording.

Para o trabalho POST:

  • entityName é: recording-interaction-metadata

  • version é: 7

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

CXone WFMEntidade da folha de pagamento e arquivo CSV

o CXone WFM Payroll API (versão1) permite que você extraiaCXone WFM dados de atividades para fins de relatórios externos da folha de pagamento.

oCXone WFM O nome da entidade da folha de pagamento para o trabalho POST é:folha de pagamento wfm.

Os dados são filtrados de acordo com o código da folha de pagamentoencontro. Lembre-se de que o fuso horário da data e hora está de acordo com o fuso horário da unidade de programação.