APIs de extração de dados

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

Você pode experimentar as APIs Data Extração e revisar sua documentação no portal do desenvolvedor .

Ao chamar POST /jobs, um jobId é retornado enquanto os dados estão sendo preparados. Você pode verificar se os dados estão prontos sondando o serviço do ponto de extremidade /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ê pode chamar a API apenas uma vez em um período de 30 segundos.

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.

Uso dessas APIs

  • 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 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 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á extraindoWFMDados da folha de pagamento, então você precisa do WFM> APIs de extração de dados>WFM API Payroll permissão.

    • Se estiver extraindo QM notas do avaliador, você precisará da permissão QM Tools > Data Extraction APIs > QM Evaluator Notes API.

Conseguir empregos

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

Método: GET

Ponto de extremidade: /data-extraction/v1/jobs

Parâmetros: nenhum

Valor de exemplo

 "jobs": [ { "id": "9dd92a83-1234-8549-8df4-939485722942", "status": "RUNNING" }, { "id": "12345d5h-c099-2345-k3r3-w3ko9ppp1234", "status": "FAILED" } ] }

Respostas

  • Status 200 - Sucesso. Status recuperado para todos os trabalhos.

  • Status 401 - Não autorizado. Credenciais inválidas.

  • Status 403 - Proibido. O usuário não tem permissão para visualizar o status do trabalho.

  • Status 500 - Erro interno do servidor.

Preparar trabalhos

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

Ponto de extremidade: /data-extraction/v1/jobs

Parâmetros: nenhum

Organismo de solicitação*: application/json

exportRequest {
Descrição:

 

Parâmetros que precisam ser fornecidos para extrair dados.
nome da entidade

string

Nome da entidade a extrair. Para os nomes de entidade corretos, veja abaixo.
versão

string

Versão da entidade a ser extraída. Para as versões corretas de cada entidade, veja abaixo.
startDate

fragmento($ date)

Data, no UTC, a partir da qual iniciar a extração de dados. O formato da data é <AAAA-MM-DD>. Por exemplo, para extrair dados de 22 de maio de 2019, insira a data: 22/05/2019.
endDate

fragmento($ date)

Data, no UTC, a partir da qual parar a extração de dados. O formato da data é <AAAA-MM-DD>. Por exemplo, para extrair dados até 29 de maio de 2019, insira a data: 29/05/2019.
}  

Valor de exemplo

{ "entityName": "qm-workflows", "version": "3", "startDate": "2019-05-22", "endDate": "2019-05-29" }

Respostas

  • Status 202 - Sucesso. Trabalho assíncrono exportado com sucesso.

    string

    Exemplo: 12345d5h-c099-9303-j99j-w3ko9ppp1234

  • Status 400 - Solicitação inválida. Filtros de data incorretos etc.

  • Status 401 - Não autorizado. Credenciais inválidas.

  • Status 403 - Proibido. O usuário não tem permissão para visualizar o status do trabalho.

  • Status 404 - Não encontrado. Entidade ausente ou versão inválida.

  • Status 500 - Erro interno do servidor.

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

Método: GET

Ponto de extremidade: /data-extraction/v1/jobs

Parâmetros:

jobId*:

string

Identificador exclusivo para a solicitação que foi feita para extrair dados do cliente.

Valor de exemplo

 12345d5h-r3ds-9303-0pw3-w3ko9ppp1234

Respostas

  • Status 202 - Sucesso. Status do trabalho recuperado.

     jobResponse{ description: Displays the job status jobStatus: { description: Job Status, includes job ID and job status id:	string Unique identifier of the job. status: string example: SUCCEEDED Job status that can be returned. Enum: [ RUNNING, SUCCEEDED, FAILED, CANCELLED, EXPIRED ] result: { description:	Job result. If successful, contains the url, if failed, an error message is displayed. url: string example: https://s3.example.amazonaws.com/results-bucket/data-extraction/{details} A url to access the extracted data is returned when a job for extracting data is successful. errorMessage: string Error message displayed when a request for extracting data fails. } } }

  • Status 400 - Solicitação inválida. Filtros de data incorretos etc.

  • Status 401 - Não autorizado. Credenciais inválidas.

  • Status 403 - Proibido. O usuário não tem permissão para visualizar o status do trabalho.

  • Status 404 - Não encontrado. Entidade ausente ou versão inválida.

  • Status 500 - Erro interno do servidor.

QM Entidade de fluxo de trabalho e arquivo 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 o Data de Envio (em UTC).

Nome da Coluna

Descrição

Nome do Locatário

Nome do inquilino.

Identificação do agente

Identificador exclusivo do agente.

Tipo de campo: string com até 36 caracteres (VARCHAR)

Tipo

Tipo de avaliação, por exemplo:

  • Avaliação

  • Auto-avaliação

Tipo de campo: string com até 24 caracteres (VARCHAR)

Gatilho de fluxo de avaliação

Evento que iniciou a avaliação:

  • Calibração

  • Colaborativo

  • Manual

  • QP

Tipo de campo: string com até 24 caracteres (VARCHAR)

Status do fluxo de trabalho

Status do fluxo de trabalho:

  • Enviado ao agente

  • Em revisão

  • Disputa

  • Concluído Reconhecido

  • Concluir a autoavaliação

  • Concluído Revisado

  • Concluído Nenhuma Revisão

  • Concluído

  • Excluído

  • Excluído - Concluído

  • Expirado

  • Excluído - Expirado

  • Excluído - Concluído Confirmado

  • Excluído - Concluído Revisado

  • Excluído - Concluído sem revisão

Tipo de campo: string com até 128 caracteres (VARCHAR)

Reconhecida automaticamente

Os valores possíveis são:

  • TRUE: Se o agente não reconheceu a avaliação, ela foi automaticamente reconhecida.

  • FALSE: Se o agente reconheceu a avaliação.

  • Valor vazio: em casos de autoavaliação, nenhum reconhecimento é necessário.

Tipo de campo: BOOLEAN

Estado do fluxo de trabalho

Estado do fluxo de trabalho:

  • Abrir

  • Fechado

  • Tempo esgotado

Tipo de campo: string com até 128 caracteres (VARCHAR)

ID do fluxo de trabalho

O identificador exclusivo da avaliação.

Tipo de campo: string com até 36 caracteres (VARCHAR)

Versão da API: 3 e superior

Nome do plano

O nome do plano de qualidade usado para iniciar esta avaliação.

Tipo de campo: string com até 128 caracteres (VARCHAR)

Nome do formulario

O nome do formulário usado para esta avaliação.

Tipo de campo: string com até 256 caracteres (VARCHAR)

Versão do formulário

A versão do formulário de avaliação usado para esta avaliação.

Tipo de campo: Número (4,0)

Data de Início

Data e hora (em UTC) quando esta avaliação começou.

Tipo de campo: TIMESTAMP_LTZ(3)

Data de Envio

Data e hora (em UTC) em que essa avaliação foi enviada.

Tipo de campo: TIMESTAMP_LTZ(3)

Última Atualização

Timestamp (em UTC) quando essa avaliação foi modificada pela última vez.

Tipo de campo: TIMESTAMP_LTZ(3)

No caso de Apelações, você deseja extrair a Data de envio, não Última Atualização.

Pontuação - Porcentagem

Pontuação da avaliação como uma porcentagem.

Tipo de campo: FLOAT

Pontuação

Pontuação de avaliação.

Tipo de campo: FLOAT

Pontuação máxima possível

A maior pontuação possível para cada questão do formulário de avaliação.

Tipo de campo: FLOAT

Classificação

Intervalo personalizado de valores definido pelo usuário para definir a classificação do formulário.

Tipo de campo: string com até 256 caracteres (VARCHAR)

Pergunta crítica com falha

Se o valor for true, o usuário falhou em uma pergunta crítica e a pontuação do formulário de avaliação é definida como zero.

Se o valor for false, o usuário respondeu a pergunta corretamente.

Tipo de campo: BOOLEAN

Comentários de revisão do usuário

Os comentários inseridos pelo usuário (agente) ao contestar a avaliação.

Tipo de campo: string com até 256 caracteres (VARCHAR)

Comentários sobre o resolvedor de disputas

Os comentários inseridos pelo usuário (gerente / avaliador) ao encerrar a disputa.

Tipo de campo: string com até 256 caracteres (VARCHAR)

ID do segmento

O ID do segmento da interação que está sendo avaliada.

Tipo de campo: string com até 36 caracteres (VARCHAR)

ID do ACD

Identificador único do distribuidor automático de chamadas.

Tipo de campo: Número(38,0)

Tipo de interação

Tipo de interação:

  • PHONE_CALL

  • E-MAIL

  • CHAT

  • SMS

  • WORKITEM

  • GOOGLE_BUSINESS_MESSAGES_PRIVATE

  • APPLE_BUSINESS_CHAT_PRIVATE

  • TELEGRAM_PRIVATE

  • LINE_PRIVATE

  • WHATSAPP_PRIVATE

  • SLACK_PRIVATE

  • MICROSOFT_TEAMS_PRIVATE

  • TW_PRIVATE

  • VIBER_PRIVATE

  • CUSTOM_PRIVATE

  • WE_CHAT_PRIVATE

  • FB_PRIVATE

Tipo de campo: string com até 50 caracteres (VARCHAR)

Data de início da interação

Data e hora de início (em UTC) da interação.

Tipo de campo: TIMESTAMP_LTZ(6)

Data de término da interação

Data e hora de término (em UTC) da interação.

Tipo de campo: TIMESTAMP_LTZ(6)

Direção de interação

Direção da chamada:

  • Entrada

  • Saída

Tipo de campo: string com até 50 caracteres (VARCHAR)

ID da Equipe

O identificador exclusivo da equipe do agente.

Tipo de campo: string com até 36 caracteres (VARCHAR)

Nome da Equipe

Nome da equipe do agente.

Tipo de campo: string com até 50 caracteres (VARCHAR)

Número de telefone

Número de telefone do cliente.

Tipo de campo: string com até 200 caracteres (VARCHAR)

FirstName (Eva)

Primeiro nome do avaliador.

Tipo de campo: string com até 255 caracteres (VARCHAR)

LastName (Eva)

Sobrenome do avaliador.

Tipo de campo: string com até 255 caracteres (VARCHAR)

FirstName (Agent)

Primeiro nome do agente avaliado.

Tipo de campo: string com até 255 caracteres (VARCHAR)

LastName (Agent)

Sobrenome do agente avaliado.

Tipo de campo: string com até 255 caracteres (VARCHAR)

FirstName (Disp)

Primeiro nome do resolvedor de disputas.

Tipo de campo: string com até 255 caracteres (VARCHAR)

LastName (Disp)

Sobrenome do resolvedor de disputas.

Tipo de campo: string com até 255 caracteres (VARCHAR)

FirstName (Assigner)

Nome do usuário que atribuiu a avaliação.

Tipo de campo: string com até 255 caracteres (VARCHAR)

LastName (Assigner)

Sobrenome do usuário que atribuiu a avaliação.

Tipo de campo: string com até 255 caracteres (VARCHAR)
Motivo

Motivo da exclusão da avaliação.

Tipo de campo: string com até 128 caracteres (VARCHAR)

Versão da API: 4 e superior
ID pai

O ID do fluxo de trabalho pai da avaliação, como colaborativo e calibração.

Tipo de campo: string com até 36 caracteres (VARCHAR)

Versão da API: 4 e superior
Assunto da avaliação

Os valores possíveis são:

  • Funcionário

  • Segmento

Tipo de campo: string com até 128 caracteres (VARCHAR)

Versão da API: 4 e superior

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

A API de perguntas e respostas do QM permite extrair perguntas e respostas de 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 o Data de Envio (em UTC).

Nome da Coluna

Descrição

ID da pergunta

Identificador único da questão.

Tipo de campo: NUMBER(38,0)
Título da pergunta

O texto da pergunta.

Tipo de campo: string com até 2048 caracteres (VARCHAR)
Número da pergunta

O número da pergunta no formulário de avaliação.

Tipo de campo: string com até 15 caracteres (VARCHAR)
Resposta

A resposta do avaliador à pergunta.

Tipo de campo: string com até 10000 caracteres (VARCHAR)
Opções

As opções de resposta disponíveis para a pergunta, como sim / não, opções numéricas, opções de botão de rádio, etc.

Tipo de campo: ARRAY
ID de Formulário

Identificador único do formulário de avaliação.

Tipo de campo: string com até 36 caracteres (VARCHAR)

Nome do formulario

O nome do formulário usado para esta avaliação.

Tipo de campo: string com até 256 caracteres (VARCHAR)

Versão do formulário

A versão do formulário de avaliação usado para esta avaliação.

Tipo de campo: NUMBER(4,0)
Data de início da avaliação

Data e hora (em UTC) quando esta avaliação começou.

Tipo de campo: TIMESTAMP_LTZ(3)
Data de envio da avaliação

Data e hora (em UTC) em que essa avaliação foi enviada.

Tipo de campo: TIMESTAMP_LTZ(3)

No caso de Apelações, você deseja extrair a Data de envio, não a data da última modificação.

Tipo de fluxo de trabalho

Tipo de avaliação, por exemplo:

  • Avaliação

  • Auto-avaliação

Tipo de campo: string com até 24 caracteres (VARCHAR)
ID da seção Identificador único da seção em formulário de avaliação.

Tipo de campo: NUMBER(38,0)
Título da seção

O nome da seção no formulário de avaliação.

Tipo de campo: string com até 2048 caracteres (VARCHAR)
Marcável

Sinalizador true ou false se a pergunta puder ser pontuada.

Tipo de campo: BOOLEAN
Pontuação real

A pontuação que o agente recebeu na pergunta.

Tipo de campo: FLOAT
Pontuação da seção (%)

A pontuação percentual da seção onde a pergunta foi localizada.

Tipo de campo: FLOAT
Pontuação máx.

A pontuação máxima que um agente poderia ter recebido na questão.

Tipo de campo: FLOAT

Identificação do agente

Identificador exclusivo do agente.

Tipo de campo: string com até 36 caracteres (VARCHAR)

FirstName (Agent)

Primeiro nome do agente avaliado.

Tipo de campo: string com até 255 caracteres (VARCHAR)

LastName (Agent)

Sobrenome do agente avaliado.

Tipo de campo: string com até 255 caracteres (VARCHAR)

ID da Equipe

O identificador exclusivo da equipe do agente.

Tipo de campo: string com até 36 caracteres (VARCHAR)

Nome da Equipe

Nome da equipe do agente.

Tipo de campo: string com até 50 caracteres (VARCHAR)

FirstName (Eva)

Primeiro nome do avaliador.

Tipo de campo: string com até 255 caracteres (VARCHAR)

LastName (Eva)

Sobrenome do avaliador.

Tipo de campo: string com até 255 caracteres (VARCHAR)
Crítico

Sinalizador true ou false se a pergunta for crítica.

Tipo de campo: BOOLEAN

Pergunta crítica com falha

Se o valor for true, o usuário falhou em uma pergunta crítica e a pontuação do formulário de avaliação é definida como zero.

Se o valor for false, o usuário respondeu a pergunta corretamente.

Tipo de campo: BOOLEAN
Obrigatório

Sinalizador true ou false se a pergunta for obrigatória.

Tipo de campo: BOOLEAN
Tipo de pergunta

O tipo de pergunta:

  • Rádio

  • Sim/Não

  • Caixa de seleção

  • Lista suspensa

  • Data/Hora

Tipo de campo: string com até 64 caracteres (VARCHAR)

ID do segmento

O ID do segmento da interação que está sendo avaliada.

Tipo de campo: string com até 36 caracteres (VARCHAR)

Data de início da interação

Data e hora de início (em UTC) da interação.

Tipo de campo: TIMESTAMP_LTZ(6)

Data de término da interação

Data e hora de término (em UTC) da interação.

Tipo de campo: TIMESTAMP_LTZ(6)

ID de WorkflowInstance

O identificador exclusivo da avaliação.

Tipo de campo: string com até 36 caracteres (VARCHAR)

Pontuação de avaliação (%)

A pontuação percentual da avaliação.

Tipo de campo: FLOAT

ID do banco

Identificador único do banco de questões onde a questão está localizada.

Tipo de campo: string com até 36 caracteres (VARCHAR)
Nome oculto

O sinalizador True oculta e o sinalizador False mostra as perguntas. Ao usar a regra do formulário QM em um formulário de qualidade, ele oculta uma pergunta complementar com base na pontuação de uma pergunta anterior.

Tipo de campo: BOOLEAN

Versão da API: 2 e superior

Notas de avaliador e arquivo CSV do QM

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 o Data de Envio (em UTC).

Nome da Coluna

Descrição

ID do comentário

O identificador exclusivo do comentário.

Tipo de campo: string com até 36 caracteres (VARCHAR)

Comentários

O texto do comentário.

Tipo de campo: string com até 300 caracteres (VARCHAR)

Hora do comentário

Data e hora em que o comentário foi adicionado.

Tipo de campo: TIMESTAMP_LTZ(3)

Atividade

O nome da ação de avaliação quando o comentário foi adicionado.

Tipo de campo: string com até 50 caracteres (VARCHAR)

Comentário por ID

O identificador exclusivo do usuário que adicionou o comentário.

Tipo de campo: string com até 36 caracteres (VARCHAR)

Comentário por Nome

Nome do usuário que adicionou o comentário.

Tipo de campo: string com até 255 caracteres (VARCHAR)

Comentário por sobrenome

Sobrenome do usuário que adicionou o comentário.

Tipo de campo: string com até 255 caracteres (VARCHAR)

ID da pergunta

O identificador exclusivo da pergunta.

Tipo de campo: string com até 36 caracteres (VARCHAR)

Título da pergunta

O texto da pergunta.

Tipo de campo: string com até 2048 caracteres (VARCHAR)

ID de Formulário

O identificador exclusivo do formulário de avaliação.

Tipo de campo: string com até 36 caracteres (VARCHAR)

Nome do formulario

O nome do formulário usado para a avaliação.

Tipo de campo: string com até 256 caracteres (VARCHAR)

Versão do formulário

A versão do formulário de avaliação utilizado para a avaliação.

Tipo de campo: NUMBER(4,0)

ID do fluxo de trabalho

O identificador exclusivo da avaliação.

Tipo de campo: string com até 36 caracteres (VARCHAR)

Status do fluxo de trabalho

O status do fluxo de trabalho.

Tipo de campo: string com até 128 caracteres (VARCHAR)

Identificação do agente

O identificador exclusivo do agente.

Tipo de campo: string com até 36 caracteres (VARCHAR)

FirstName (Agent)

Nome do agente.

Tipo de campo: string com até 255 caracteres (VARCHAR)

LastName (Agent)

Sobrenome do agente.

Tipo de campo: string com até 255 caracteres (VARCHAR)

ID da Equipe

O identificador exclusivo da equipe do agente.

Tipo de campo: string com até 36 caracteres (VARCHAR)

Nome da Equipe

Nome da equipe do agente.

Tipo de campo: string com até 50 caracteres (VARCHAR)

Entidade de metadados de interação e arquivo CSV

A API Interaction Metadata permite extrair metadados de interação de Recording.

Para o trabalho POST:

  • entityName é: recording-interaction-metadata

  • versão é: 10

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

Nome da Coluna

Descrição

ID da chamada ACD (por exemplo, ID do contato principal)

O ID de chamada ACD depende da solução ACD, por exemplo, este é o mesmo que o CXone Mpower ID de contato mestreFechado O mestre ou ID pai para um ou mais contatos relacionados. Um novo ID de contato mestre será atribuído se um contato tiver sido transferido três vezes ou mais..

Tipo de campo: número contendo até 38 dígitos

ID do segmento

Identificador único do segmento. Um segmento é uma interação com duas partes, como um cliente e um agente.

Tipo de campo: string com até 36 caracteres (VARCHAR UUID)

Motivo de início do segmento

Motivo do início do segmento:

  • Conferência

  • RVI

  • Segmento: Primeiro segmento no contato

  • Transferência

  • Contato

  • Elevado

  • Transferido para número externo

  • Transferência externa

Tipo de campo: string com até 100 caracteres (VARCHAR)

Motivo do fim do segmento

Motivo do término do segmento:

  • Conferência

  • RVI

  • Segmento: Último segmento no contato

  • Transferência

  • Contato

  • Elevado

  • Transferido para número externo

  • Transferência externa

Tipo de campo: string com até 100 caracteres (VARCHAR)
Direção

Direção do segmento:

  • Entrada

  • Saída

  • Interna

  • Desconhecido

Tipo de campo: string com até 150 caracteres (VARCHAR)

Data de Início

Data e hora de início (em UTC) do segmento.

Tipo de campo: TIMESTAMP

Data de Término

Data e hora de término (em UTC) do segmento.

Tipo de campo: TIMESTAMP
Tipo de canal

Tipo de interação:

  • Voz

  • Chat

  • E-mail

  • RVI

  • Item de Trabalho

  • SMS

  • Canais de mensagens: Facebook Messenger, WhatsApp, Apple Messages for Business(Apple Business Chat), LINE Messaging,Telegram Messenger, Viber Messenger, Custom, Microsoft TeamsSlack.

  • Canais sociais públicos: Facebook, Google Places, Google Play,LinkedIn, YouTube, Apple Apps Reviews, Custom (público).

Tipo de campo: string com até 150 caracteres (VARCHAR)
Gravação de tela

Se o segmento incluir gravação de tela:

  • Sim

  • Não
Status de gravação de voz

Status da gravação:

  • Sucesso

  • Parcialmente gravado: Partes deste segmento não foram gravadas, mas a interação ainda pode ser reproduzida

  • Não corresponde a nenhuma política: nenhuma gravação - nenhuma das políticas de gravação foi acionada por esta interação

  • Não gravado devido à gravação %: Nenhuma política de gravação - uma gravação foi acionada por esta interação, mas não foi gravada devido à porcentagem de gravação definida na política

  • Política de não gravação: nenhuma política de gravação - a não gravação foi acionada para esta interação

  • Consentimento recusado no RVI: Não há gravação

  • Falha: Não há gravação

  • Mascarado: Sem gravação - a gravação foi mascarada

  • Gravar transferências para números externos não selecionados: Não há gravação

  • Pode ser gravado (voz) não selecionado: Sem gravação - o atributo Agente Pode ser gravado (voz) não foi selecionado

Tipo de campo: string com até 250 caracteres (VARCHAR)
Status de gravação de tela

Status da gravação:

  • Sucesso

  • Parcialmente gravado: Partes deste segmento não foram gravadas, mas a interação ainda pode ser reproduzida

  • Não corresponde a nenhuma política: nenhuma gravação - nenhuma das políticas de gravação foi acionada por esta interação

  • Não gravado devido à gravação %: Nenhuma política de gravação - uma gravação foi acionada por esta interação, mas não foi gravada devido à porcentagem de gravação definida na política

  • Política de não gravação: nenhuma política de gravação - a não gravação foi acionada para esta interação

  • Consentimento recusado no RVI: Não há gravação

  • Falha: Não há gravação

  • Mascarado: Sem gravação - a gravação foi mascarada

Tipo de campo: string com até 250 caracteres (VARCHAR)

Alertas de gravação

Os alertas de gravação incluem:

  • ScreenAgent está inacessível: ScreenAgent não está configurado corretamente ou não está em execução.

  • Erro de gravação de tela:

    • A chamada pode não estar totalmente gravada

    • Erro de gravação de tela

    • Erro de configuração da máquina ScreenAgent

    • Sem conexão entre o ScreenAgent e as telas do agente

    • Erro de configuração de rede da máquina ScreenAgent

    • O ScreenAgent não iniciou a gravação devido à configuração da máquina

    • ScreenAgent falhou ao carregar a gravação devido à configuração de certificado autoassinado

    • Erro de configuração do disco rígido da máquina ScreenAgent

    • O ScreenAgent atingiu o número máximo de chamadas paralelas

    • A gravação de tela atingiu a duração máxima da chamada

      Consulte Resolver problemas do ScreenAgent.

  • Gravação muito curta:

    • A gravação de tela é muito curta.

    • O áudio tem menos de 4 segundos e pode não ser gravado.

  • Nenhuma conexão com o servidor de mídia: Houve um problema com o servidor de mídia, resultando em nenhuma gravação disponível. Esse erro pode ocorrer por vários motivos, e a descrição do erro para o alerta de gravação fornece informações mais detalhadas. Para a solução Multi-ACD (Open), esse erro indica eventos de SIP ausentes do cliente. Isso pode significar que todo o convite está faltando ou apenas um lado (Nearend ou Farend) está sendo recebido.

  • O gravador de voz não pôde gravar a chamada: Sem gravação. Houve um problema com o gravador de voz. Pode haver vários motivos para isso. A descrição do erro do alerta de gravação fornece informações mais detalhadas.

  • Áudio não disponível: dados de áudio incompletos: O áudio não está disponível para esta interação (dados de áudio incompletos). Entre em contato com CXone Mpower suporte.

  • Áudio não disponível: pacotes de áudio ausentes: O áudio não está disponível para esta interação (pacotes de áudio ausentes). Entre em contato com CXone Mpower suporte.

  • Áudio não disponível: pacotes de áudio ausentes da fonte externa: (Recurso CR) O áudio não está disponível para esta interação (pacotes de áudio ausentes no fluxo de mídia). Entre em contato com CXone Mpower suporte.

  • Erro no sistema: A gravação não começou ou outro erro geral. Entre em contato com CXone Mpower suporte.

  • Falha no mascaramento: Falha ao mascarar a gravação. Você pode reproduzir a gravação para verificar se há dados confidenciais. Para excluir a gravação, clique em AçaoCaptura de tela do botão de ações e selecione Excluir gravações.

  • Gravação interrompida sob demanda: Gravação interrompida pelo usuário.

Nome da política

Nome da política de gravação ou não registre a política aplicada a esta interação.

Tipo de campo: string com até 100 caracteres (VARCHAR)
ANI

Para chamadas recebidas, ANI é o número de telefone do chamador (ID do chamador).

Tipo de campo: string com até 200 caracteres (VARCHAR)
DNIS

Para chamadas recebidas, DNIS é o número de telefone que foi chamado (número discado).

Tipo de campo: string com até 200 caracteres (VARCHAR)
ACW (em segundos)

Quantos segundos a gravação da tela continuou após o término da chamada para capturar o trabalho após a chamada do agente.
Disposição Identifique as atribuições do agente com informações adicionais sobre a chamada.

ID de segmento externo

O ID de um segmento conforme definido na fonte externa da gravação. Os valores estão disponíveis somente para usuários com o AppLink.

Tipo de campo: string com até 100 caracteres (VARCHAR)

Versão da API: 6 e superior

ID de contato externo

O ID de um contato conforme definido na fonte externa da gravação. Os valores estão disponíveis somente para usuários com o AppLink.

Tipo de campo: string com até 100 caracteres (VARCHAR)

Versão da API: 6 e superior

Fonte

A fonte do CXone Mpower de gravação ou uma fonte externa. Os valores incluem:

  • Engage

  • BrandEmbassy

  • Atividade

  • InContactACD

  • Multi-ACD

  • MigratedCallsExternal

  • MigratedCallsEngage

  • MigratedCallsNim

  • SmartReach

Tipo de campo: string com até 30 caracteres (VARCHAR)

Versão da API: 6 e superior

Contato associado sem lista

Lista de números de contato dos agentes associados ao segmento. Os elementos dessa lista são apenas do tipo numérico.

Tipo de campo: variante

Versão da API: 7 e superior

ID de interação

Um ID exclusivo (UUID) de uma interação. Quando há vários segmentos associados a uma única interação, estes podem ter o mesmo ID de interação. O ID de interação não é igual ao ID de segmento ou ID de contato.

Tipo de campo: string com até 36 caracteres (VARCHAR)

Versão da API: 7 e superior
Contagem de esperas O número total de vezes que o agente colocou o cliente em espera durante uma chamada.

API versão: 8 e superior
Duração da espera em Segundos O número total de segundos que o cliente foi colocado em espera durante uma chamada (a soma de todas as retenções).

API versão: 8 e superior

Chamada Complexa

Indica se uma chamada teve vários participantes.

campo tipo: valores booleanos que consistem em TRUE ou FALSE (BOOLEANO)

API versão: 9 e superior

Status de mascaramento da gravação de voz

Indica o status da gravação de voz mascarando uma interação.

campo tipo: String

API versão: 10 e superior

Os valores possíveis são:

  • Sucesso: Gravação de voz foi mascarado com sucesso

  • Falha: Gravação de voz mascaramento falhou

  • Parcial: Gravação de voz estava parcialmente mascarado

  • NA: Não aplicável

Status de mascaramento de gravação de tela

Indica o status do mascaramento da gravação de tela para uma interação.

campo tipo: String

API versão: 10 e superior

Os valores possíveis são:

  • Sucesso: A gravação de tela foi mascarada com sucesso

  • Falha: Falha no mascaramento da gravação de tela

  • Parcial: A gravação de tela foi parcialmente mascarada

  • NA: Não aplicável
ID de usuário do agente

Identificador único atribuído ao agente.

O arquivo CSV contém esse campo como uma coluna separada para cada agente, suportando até 5 agentes.

Exemplos de nomes de coluna: Agent 1 User ID, Agent 2 User ID, ..., Agent 5 User ID

Tipo de campo: string com até 36 caracteres (VARCHAR)
ID ACD do Agente

Identificador exclusivo atribuído ao agente pelo ACD.

O arquivo CSV contém esse campo como uma coluna separada para cada agente, suportando até 5 agentes.

Exemplos de nomes de coluna: Agent 1 ACD ID, Agent 2 ACD ID, ..., Agent 5 ACD ID

Tipo de campo: string com até 50 caracteres (VARCHAR)
Número de contato do agente

Identificador exclusivo do contato criado para esse agente.

Esse campo não está disponível para Multi-ACD (Open).

O arquivo CSV contém esse campo como uma coluna separada para cada agente, suportando até 5 agentes.

Exemplos de nomes de coluna: Agent 1 Contact Number, Agent 2 Contact Number, ..., Agent 5 Contact Number

Tipo de campo: número contendo até 38 dígitos

Versão da API: 5 e superior

Nome do Agente

Nome do agente, conforme especificado na conta de funcionário de CXone Mpower.

O arquivo CSV contém esse campo como uma coluna separada para cada agente, suportando até 5 agentes.

Exemplos de nomes de coluna: Agent 1 Name, Agent 2 Name, ..., Agent 5 Name

Tipo de campo: string com até 100 caracteres (VARCHAR)

ID da equipe do agente

Identificador único atribuído à equipe do agente.

O arquivo CSV contém esse campo como uma coluna separada para cada agente, suportando até 5 agentes.

Exemplos de nomes de coluna: Agent 1 Team ID, Agent 2 Team ID, ..., Agent 5 Team ID

Tipo de campo: string com até 36 caracteres (VARCHAR UUID)

Equipe do Agente

Nome da equipe do agente.

O arquivo CSV contém esse campo como uma coluna separada para cada agente, suportando até 5 agentes.

Exemplos de nomes de coluna: Agent 1 Team, Agent 2 Team, ..., Agent 5 Team

Tipo de campo: string com até 40 caracteres (VARCHAR)

Competências do Agente

Classificação atribuída ao agente no ACD, com base em habilidades, especialidades e conhecimentos.

O arquivo CSV contém esse campo como uma coluna separada para cada agente, suportando até 5 agentes.

Exemplos de nomes de coluna: Agent 1 Skills, Agent 2 Skills, ..., Agent 5 Skills

Tipo de campo: string com até 50 caracteres (VARCHAR)

Nome dos dados comerciais

Nome do campo de dados comerciais conforme especificado.

O arquivo CSV contém este campo como uma coluna separada para cada entrada de dados comerciais:

  • Para API versões 7 a 10, o arquivo suporta até 50 entradas: 35 varchar, 10 numéricas e 5 booleanas

  • Para API versão 11, disponível para clientes no programa Controlled Release (CR), o arquivo suporta até 250 entradas: 1-35 varchar, 36-45 numérico, 46-65 booleano, 66-95 data, 96-210 varchar, 211-250 numérico

Exemplos de nomes de coluna: Business Data Name 1, Business Data Name 2, ..., Business Data Name 50 (ou até Business Data Name 250 para CR)

Tipo de campo: string com até 128 caracteres (VARCHAR)

Versão da API: 7 e superior

Valor dos dados comerciais

O valor dos dados comerciais pode ser texto, numérico ou verdadeiro/falso.

O arquivo CSV contém este campo como uma coluna separada para cada entrada de dados comerciais:

  • Para API versões 7 a 10, o arquivo suporta até 50 entradas: 35 varchar, 10 numéricas e 5 booleanas

  • Para API versão 11, disponível para clientes no programa Controlled Release (CR), o arquivo suporta até 250 entradas: 1-35 varchar, 36-45 numérico, 46-65 booleano, 66-95 data, 96-210 varchar, 211-250 numérico

Exemplos de nomes de coluna: Business Data Value 1, Business Data Value 2, ..., Business Data Value 50 (ou até Business Data Value 250 para CR)

Tipo de campo:

  • String com até 4000 caracteres (VARCHAR)

  • Valor numérico contendo até 38 dígitos (NÚMERO)

  • Valores booleanos que consistem em TRUE ou FALSE (BOOLEAN)

  • Valores de data no formato suportado (DATE)

Versão da API: 7 e superior

As atualizações de dados comerciais feitas mais de 2 dias após a criação da interação não são incluídas na saída do API de extração de dados.

WFMEntidade da folha de pagamento e arquivo CSV

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

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

Nome da Coluna

Descrição

Nome próprio

Primeiro nome do agente.

Tipo de campo: string com até 255 caracteres (VARCHAR)

Sobrenome

Sobrenome do agente.

Tipo de campo: string com até 255 caracteres (VARCHAR)

Nome do usuário

Nome de usuário do agente.

Tipo de campo: string com até 255 caracteres (VARCHAR)

Unidade de agendamento

Unidade de agendamento do agente.

Tipo de campo: string com até 256 caracteres (VARCHAR)

Fuso Horário da Unidade de Programação

Fuso horário da unidade de programação do agente.

Tipo de campo: string com até 128 caracteres (VARCHAR)

Código de folha de pagamento

O código da folha de pagamento que contém os dados de atividades agendadas.

Tipo de campo: string com até 50 caracteres (VARCHAR)

Data

Data (no fuso horário da unidade de programação) da atividade.

Tipo de campo: DATE

Hora de Início

Hora de início (no fuso horário da unidade de programação) da atividade.

Tipo de campo: TIME (9)

Duração em segundos

A duração da atividade em segundos.

Tipo de campo: NUMBER (8,0)