API Exportar Horários de Agente

Use o API Exportar Agendas de agente para exportar facilmente agendas de agentes de CXone Mpower Workforce Management para outros aplicativos. Com essa API, você pode recuperar o agendamento de um único agente por solicitação. O cronograma do agente pode ser recuperado por um período de até sete dias.

As APIs Exportar Horários de Agente estão disponíveis no Portal DEVone Developer Community.

Por exemplo, você deseja ter um cronograma automático no seu sistema de resposta de voz interativa (IVR). Você pode usar essa API para informar ao chamador se um determinado funcionário está disponível.

Consulte Introdução em o portal da Comunidade de Desenvolvedores do DEVone antes de usar este API.

Antes de usar a API Exportar Horários de Agente, você deve:

  • Gerar uma chave de acesso. Quando você cria o funcionário no CXone Mpower para o serviço, ele precisa:

    • Ter a permissão Exibir ou Gerenciar em WFM > Agendamento > Gerenciador de Agendamento.

    • Receber uma permissão Exibir que dê permissão para ver as unidades de agendamento (ou equipes) do agente.

  • Seguir o processo de registro e autenticação explicado no portal de programadores.

Você pode verificar com seu administrador se possui essas permissões. O administrador pode encontrar essas permissões no CXone Mpower. Vá para Admin > Configurações de Segurança > Funções e permissões e selecione a função.

Solicitação de API

O nome da entidade Exportar Horários de Agente do trabalho POST é exportar API. O endpoint é /schedules/export.

  • startDate: o formato é aaaa-mm-dd.

  • endDate: o formato é aaaa-mm-dd. O intervalo pode ser de até sete dias a contar da data de início.

  • userID: você pode usar a API Procurar usuários para encontrar o ID do usuário.

  • userID: o ID exclusivo do agente.

  • shifts: detalhes sobre o turno.

    • shiftNotes: comentários sobre o turno do agente.

    • activityIntervals: quantas atividades estão no turno.

    • baseActivityCode: detalhes do código de atividade base do turno.

      • title: nome do código da atividade.

      • Os atributos que podem ser incluídos neste código de atividade: open, work, overTime.

    • start: data e hora de início da atividade.

    • end: data e hora de término da atividade.

  • activityIntervals: atividades que não foram agendadas como parte de um turno.

  • start: data de início do turno.

  • end: data de término do turno.

Valor de exemplo

 {
“startDate”: “2023-10-08”,
“endDate”: “2023-10-14”,
“userID”: “11ed7199-e04e-1f80-9ebb-0262bc110012”
}

Respostas

  • Status 200 - Sucesso. O cronograma foi exportado com sucesso.

     {
"agentSchedules": [
{
"userId": "11ed7199-e04e-1f80-9ebb-0262bc110012",
"shifts": [
{
"shiftNotes": null,
"activityIntervals": [],
"baseActivityCode": {
title": "Open (Default)",
"open": true,
"work": true,
"overTime": false
},
"start": "2023-06-28T03:00:00Z",
"end": "2023-06-28T12:00:00Z"
}
],
"activityIntervals": []
}
],
"start": "2023-06-28",
"end": "2023-06-28"
}

  • Status 400 – Solicitação incorreta. Isso pode acontecer quando:

    • Não é possível recuperar o cronograma. userID incorreto, ou você não tem permissão para visualizar esse agente.

    • O intervalo de datas solicitado é superior a sete dias.

    • A solicitação está faltando ou contém dados errados.

  • Status 401 – O token de acesso é inválido.

  • Status 403 – A conta do usuário que está fazendo a chamada de API não tem a permissão necessária.

API para encontrar o ID do usuário

Ao exportar um cronograma de agente, você precisa do ID de usuário do agente. Você pode usar a API Procurar usuários para encontrá-lo.

O nome da entidade do trabalho GET é pesquisa de usuário e o endpoint é /user-management/v2/users/search.

Na solicitação, insira o nome de usuário do funcionário. Isso exibirá o ID de usuário. Você pode encontrar o nome do usuário na seu conta de funcionário.

 
{
“filter”; {
“userName”: [“AgentSmile@BankABC.com”]
}