API de exportación de programaciones de agente

Utilice la API de Programaciones de agentes de exportación para exportar fácilmente horarios de agentes desde CXone Mpower Workforce Management a otras aplicaciones. Con esta API, puede recuperar la programación de un único agente por solicitud. La programación del agente se puede recuperar por un periodo de hasta siete días.

Las API de Programaciones del Agente de Exportación están disponibles en el portal para desarrolladores.

Por ejemplo, quiere tener una programación automática en su sistema de respuesta de voz interactiva (IVR). Puede usar esta API para indicar a la persona que llama si un determinado empleado está disponible.

Consulta Primeros pasos en el portal para desarrolladores antes de usar esta API.

Antes de usar la API de exportación de programaciones de agente, debe:

  • Generar una clave de acceso. Cuando cree el empleado en CXone Mpower para el servicio, necesita:

    • Tener el permiso Ver o Gestionar en WFM > Programación> Administrador de programación.

    • Estar asignado a una vista que dé permiso para ver las unidades de programación (o equipos) del agente.Unidad de programación del agente.

  • Seguir el proceso de registro y autenticación explicado en el portal de desarrolladores.

Puede consultar con su administrador si dispone de estos permisos. El administrador puede hallar estos permisos en CXone Mpower. Vaya a Admin > Parámetros de seguridad > Roles y permisos y seleccione el rol.

Solicitud API

El nombre de entidad Exportar programaciones de agente para el trabajo POST es exportar API. El punto de conexión es /schedules/export.

  • startDate: El formato es aaaa-mm-dd.

  • endDate: El formato es aaaa-mm-dd. El rango puede ser de hasta siete días a partir de la fecha de inicio.

  • userID: Puede usar la API Buscar usuarios para encontrar el ID del usuario.

  • userID: El ID único del agente.

  • shifts: Detalles sobre el turno.

    • shiftNotes: Comentarios sobre el turno del agente.

    • activityIntervals: Cuantas actividades hay en el turno.

    • baseActivityCode: Detalle del código de actividad base del turno.

      • title: Nombre del código de actividad.

      • Los atributos que se pueden incluir en este código de actividad: open, work, overTime.

    • start: Fecha y hora de inicio de la actividad.

    • end: Fecha y hora de finalización de la actividad.

  • activityIntervals: Actividades que no se programaron como parte de un turno.

  • start: Fecha de inicio del turno.

  • end: Fecha de finalización del turno.

Valor de ejemplo

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

Respuestas

  • Estado 200 - Éxito. La programación se ha exportado correctamente.

     {
"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"
}

  • Estado 400: Solicitud incorrecta. Esto puede ocurrir cuando:

    • No se pude recuperar una programación. userID incorrecto o no tiene permiso para ver este agente.

    • El rango de fechas solicitado es superior a siete días.

    • Falta información en la solicitud o los datos son incorrectos.

  • Estado 401 - El token de acceso no es válido.

  • Estado 403 - La cuenta de usuario que realiza la llamada a la API no tiene el permiso requerido.

API para encontrar el ID de usuario

Al exportar la programación de agente, necesita el ID de usuario del agente. Puede usar la API Buscar usuarios para encontrarlo.

El nombre de entidad para el trabajo GET es user search, y el punto de conexión es /user-management/v2/users/search.

En la solicitud, ingrese el nombre de usuario del empleado. Esto le dará el ID de usuario. Puede encontrar el nombre de usuario en su cuenta de empleado.

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