API Usuarios

Recordar que para poder usar esta API se necesita usar un token como Authorization.

Servicio users/get

Este servicio permite obtener todos los usuarios del sistema o buscar uno específicamente.

Retorna un arreglo de objetos que representan usuarios de sistema. Cada uno de estos objetos tiene los siguientes campos:

fullName: String - Nombre completo del usuario, String vacío en caso de no tener.
userId: String - Identificador único que el usuario utiliza para iniciar sesión.
email: String - El correo electrónico del usuario, String vacío en caso de no tener.
isAdmin: Boolean - true en caso de que el usuario sea supervisor (incluyendo el caso en el que el usuario es supervisor y agente), false en caso de que el usuario solo sea agente.

Recibe opcionalmente como query param el userId del usuario a buscar, en caso de recibirlo, retorna un arreglo que solo contiene el usuario encontrado, o que es vacío en caso de no existir el usuario.

Ejemplos de request:

curl --request GET \
  --url https://{{instance}}.ucontactcloud.com/Integra/resources/users/get \
  --header 'Authorization: Basic {{apiToken}}'

curl --request GET \
  --url https://{{instance}}.ucontactcloud.com/Integra/resources/users/get?userId={{userName}} \
  --header 'Authorization: Basic {{apiToken}}'

Ejemplos de respuestas:

Respuesta en la que no se especificó un userId.

[
  {
    "fullName": "Agente Primero",
    "userId": "agente1",
    "email": "agente1@ucontactcloud.com",
    "isAdmin": false
  },
  {
  "fullName": "Supervisor Webchat",
  "userId": "supervisorWebchat",
  "email": "supWebchat@mail.com",
  "isAdmin": true
  },
  {
  "fullName": "Supervisor SMS",
  "userId": "supervisorSMS",
  "email": ""
  "isAdmin": true
  },
  {
  "fullName": "",
  "userId": "supervisorCalidad",
  "email": "",
  "isAdmin": false
  },
  {
  "fullName": "Agente Segundo",
  "userId": "agente2",
  "email": "",
  "isAdmin": false
  }
]

Respuesta en la que se especificó userId=agente1

[
  {
    "fullName": "Agente Primero",
    "userId": "agente1",
    "email": "agente1@ucontactcloud.com",
    "isAdmin": false
  }
]

Respuesta en la que se especificó userId=agente3

[]