Extremos del agente

Los extremos de los agentes proporcionan un medio para obtener objetos de agentes. Cada objeto de agente representa un solo agente dentro de Contact Center AI Platform (CCAI). Revisa el siguiente modelo para ver qué campos pueden contener información de identificación personal (PII).

[
  {
    "id": 0,
    "email": "string",
    "created_at": "2018-05-30T20:46:31.333Z",
    "last_login_time": "2018-05-30T20:46:31.333Z",
    "first_name": "string",
    "middle_name": "string",
    "last_name": "string",
    "avatar_url": "string",
    "agent_number": "string",
    "status": {
      "id": 0,
      "name": "string",
      "color": "string"
    },
    "status_updated_at": "2018-05-30T20:46:31.333Z",
    "crm_authenticated": true,
    "online": true,
    "wrap_up": true,
    "call_count": 0,
    "chat_count": 0,
    "location": "string",
    "roles": [
      "agent"
    ],
    "teams": [
      {
        "id": 0,
        "name": "string",
        "parent_id": 0,
        "position": 0,
        "deleted": true,
        "agents_count": 0
      }
    ],
    "channels": [
      {
        "channel_type": "chat",
        "menu": {
          "id": 0,
          "name": "string",
          "parent_id": 0,
          "position": 0,
          "deleted": true,
          "hidden": "string",
          "menu_type": "ivr_menu",
          "output_msg": "string"
        }
      }
    ]
  }
]

Agentes

Parámetro	Obligatorio	Tipo de datos	Definición
página	FALSO	String	Se combina con per para indicar qué página de registros. Por ejemplo, si per se establece en 200 y page en 2, la respuesta contendrá los registros del 201 al 400, ya que la página 1 contendrá del 1 al 200.
por	FALSO	String	Se empareja con la página para indicar cuántos registros se incluirían en una página de registros. Por ejemplo, si per se establece en 200 y page en 2, la respuesta contendrá los registros del 201 al 400, ya que la página 1 contendrá del 1 al 200.
id[]	FALSO	Array[String]	Es un array de cadenas. Es el ID de los registros que se buscarán y devolverán.
agent_number[]	FALSO	Array[String]	Números de agente asignados por el administrador en el momento de crear un agente
status_id[]	FALSO	Array[String]	Filtra por estado del agente
online[]	FALSO	Booleano	Filtrar si los agentes están en línea o no
wrap_up[]	FALSO	Booleano	Filtrar si los agentes están en estado de cierre
location[]	FALSO	Array[String]	Filtra por la ubicación del agente
last_login_time[from]	FALSO	Hora en UTC	Crea un límite inferior del campo de fecha y hora del último acceso. Todos los registros devueltos serán posteriores al valor ingresado.
last_login_time[to]	FALSO	Hora en UTC	Crea un límite superior del campo de fecha y hora del último acceso. Todos los registros devueltos serán anteriores al valor ingresado.
status_updated_at[from]	FALSO	Hora en UTC	Crea un límite inferior del campo de fecha y hora de actualización del estado. Todos los registros devueltos serán posteriores al valor ingresado.
status_updated_at[to]	FALSO	Hora en UTC	Crea un límite superior del campo de estado actualizado en. Todos los registros devueltos serán anteriores al valor ingresado.

Endpoint:

Method: GET
Type: 
URL: https://{​{subdomain}​}.{​{domain}​}/manager/api/v1/agents

Más ejemplos de solicitudes y respuestas:

Ejemplo de solicitud: Ejemplo de agentes

Cuerpo: Ninguno

Ejemplo de respuesta: Ejemplo de agentes

[
  {
    "id": 45,
    "email": "[e-mail]",
    "roles": [
      "agent"
    ],
    "first_name": "Craig T",
    "middle_name": null,
    "last_name": "Nelson",
    "avatar_url": "https://subdomain.somedomain.com/default-profile.png",
    "agent_number": null,
    "crm_authenticated": false,
    "status": {
      "id": -6,
      "name": "Wrap-up",
      "color": "purple",
    },
    "online": false,
    "wrap_up": false,
    "call_count": 0,
    "chat_count": 0,
    "location": null,
    "created_at": "2016-11-10T00:15:04.000Z",
    "last_login_time": "2016-11-10T00:17:57.000Z",
    "status_updated_at": null,
    "teams": [
      {
        "id": 163,
        "name": "team CTN",
        "parent_id": null,
        "position": 11,
        "agents_count": 12,
        "deleted": false
      }
    ],
    "channels": [
      {
        "channel_type": "voice_call",
        "menu": {
          "id": 2029,
          "name": "Mobile Queue",
          "parent_id": null,
          "position": 0,
          "deleted": false,
          "menu_type": "mobile_menu",
          "output_msg": null,
          "hidden": false
        }
      }
    ]
  },
  {
    "id": 60,
    "email": "[e-mail]",
    "roles": [
      "agent"
    ],
    "first_name": "Darth",
    "middle_name": null,
    "last_name": "Vader",
    "avatar_url": "https://subdomain.somedomain.com/default-profile.png",
    "agent_number": null,
    "crm_authenticated": false,
    "status": {
      "id": -7,
      "name": "In-call",
      "color": "light_blue",
    },
    "online": false,
    "wrap_up": false,
    "call_count": 0,
    "chat_count": 0,
    "location": null,
    "created_at": "2017-02-03T19:44:14.000Z",
    "last_login_time": "2017-02-03T20:05:31.000Z",
    "status_updated_at": "2017-02-04T12:36:11.000Z",
    "teams": [],
    "channels": [
      {
        "channel_type": "voice_call",
        "menu": {
          "id": 1693,
          "name": "Premium Support",
          "parent_id": null,
          "position": 0,
          "deleted": false,
          "menu_type": "ivr_menu",
          "output_msg": "You selected premium support",
          "hidden": false
        }
      }
    ]
  },
  {
    "id": 81,
    "email": "[e-mail]",
    "roles": [
      "agent"
    ],
    "first_name": "Barry",
    "middle_name": null,
    "last_name": "Allen",
    "avatar_url": "https://subdomain.somedomain.com/default-profile.png",
    "agent_number": null,
    "crm_authenticated": false,
    "status": {
      "id": -10,
      "name": "Offline",
      "color": "grey",
    },
    "online": false,
    "wrap_up": false,
    "call_count": 0,
    "chat_count": 0,
    "location": null,
    "created_at": "2017-03-13T23:47:39.000Z",
    "last_login_time": "2017-03-13T23:48:17.000Z",
    "status_updated_at": "2017-03-13T23:56:04.000Z",
    "teams": [],
    "channels": [
      {
        "channel_type": "voice_call",
        "menu": {
          "id": 2028,
          "name": "Speed Issues",
          "parent_id": 2027,
          "position": 0,
          "deleted": false,
          "menu_type": "mobile_menu",
          "output_msg": null,
          "hidden": false
        }
      }
    ]
  }
]

Código de estado: 200

Estado actual de los agentes

El estado actual de los agentes muestra todos los agentes que accedieron y su estado actual, cuánto tiempo estuvieron en ese estado y la información adicional para indicar si el agente está en espera y por cuánto tiempo.

Endpoint:

Method: GET
Type: 
URL: https://{​{subdomain}​}.{​{domain}​}/manager/api/v1/agents/current_status

Más ejemplos de solicitudes y respuestas:

Ejemplo de solicitud: Estado actual de los agentes

Cuerpo: Ninguno

Ejemplo de respuesta: Estado actual de los agentes

[
  {
    "id": 1,
    "status": "Available",
    "status_id": 0,
    "status_updated_at": "2021-05-10T17:45:01.000Z",
    "on_hold": false,
    "on_hold_duration": 0
  }
]

Código de estado: 0

Se esperan claves JSON no reconocidas en las respuestas de la API

Todas las actualizaciones de la API son retrocompatibles. Nos reservamos el derecho de introducir nuevas claves JSON en las respuestas de la API existentes en cualquier momento. Te recomendamos que manejes las respuestas de forma defensiva ignorando las claves no reconocidas para mantener la funcionalidad continua.