Google uses AI technology to translate content into your preferred language. AI translations can contain errors.

Agent-Endpunkte

Agent-Endpunkte bieten eine Möglichkeit, Agent-Objekte abzurufen. Jedes Agent-Objekt stellt einen einzelnen Agenten in der Contact Center AI Platform (CCAI Platform) dar. In diesem Modell sehen Sie, welche Felder personenidentifizierbare Informationen enthalten können.

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

Agents

Parameter	Erforderlich	Datentyp	Definition
Seite	FALSE	String	Wird mit „pro“ kombiniert, um anzugeben, welche Seite der Datensätze angezeigt werden soll. Wenn „pro“ beispielsweise auf 200 und „Seite“ auf 2 festgelegt ist, enthält die Antwort die Datensätze 201 bis 400, da Seite 1 die Datensätze 1 bis 200 enthält.
pro	FALSE	String	Wird mit „Seite“ kombiniert, um anzugeben, wie viele Datensätze auf einer Seite enthalten sein sollen. Wenn „pro“ beispielsweise auf 200 und „Seite“ auf 2 festgelegt ist, enthält die Antwort die Datensätze 201 bis 400, da Seite 1 die Datensätze 1 bis 200 enthält.
ID[]	FALSE	Array[String]	Array[Strings] ID der Datensätze, die gesucht und zurückgegeben werden sollen
agent_number[]	FALSE	Array[String]	Agentennummern, die vom Administrator beim Erstellen eines Agenten zugewiesen wurden
status_id[]	FALSE	Array[String]	Filtert nach Agentenstatus
online[]	FALSE	Boolesch	Filtert danach, ob Agents online sind oder nicht
wrap_up[]	FALSE	Boolesch	Filtert danach, ob sich Agents im Status „Nachbereitung“ befinden
Standort[]	FALSE	Array[String]	Filtert nach Agentenstandort
last_login_time[from]	FALSE	Zeit in UTC	Erstellt eine Untergrenze für das Feld „Letzte Anmeldung“. Alle zurückgegebenen Datensätze liegen nach dem eingegebenen Wert.
last_login_time[to]	FALSE	Zeit in UTC	Erstellt eine Obergrenze für das Feld „Letzte Anmeldung“. Alle zurückgegebenen Datensätze liegen vor dem eingegebenen Wert.
status_updated_at[from]	FALSE	Zeit in UTC	Erstellt eine Untergrenze für das Feld „Status aktualisiert am“. Alle zurückgegebenen Datensätze liegen nach dem eingegebenen Wert.
status_updated_at[to]	FALSE	Zeit in UTC	Erstellt eine Obergrenze für das Feld „Status aktualisiert am“. Alle zurückgegebenen Datensätze liegen vor dem eingegebenen Wert.

Endpunkt:

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

Weitere Beispielanfragen und ‑antworten:

Beispielanfrage: Agents-Beispiel

Text: Keine

Beispielantwort: Agents-Beispiel

[
  {
    "id": 45,
    "email": "craigT@nelson.com",
    "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": "notanakinskywalker@empire.com",
    "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": "email@email.com",
    "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
        }
      }
    ]
  }
]

Statuscode: 200

Aktueller Status von Agents

„Aktueller Status von Agents“ gibt alle angemeldeten Agents und ihren aktuellen Status zurück. Außerdem wird angegeben, wie lange sie sich in diesem Status befinden, und es werden zusätzliche Informationen dazu geliefert, ob der Agent in der Warteschleife ist und wie lange.

Endpunkt:

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

Weitere Beispielanfragen und ‑antworten:

Beispielanfrage: Aktueller Status von Agents

Text: Keine

Beispielantwort: Aktueller Status von Agents

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

Statuscode: 0

Unerkannte JSON-Schlüssel in API-Antworten erwarten

Alle API-Updates sind abwärtskompatibel. Wir behalten uns das Recht vor, jederzeit neue JSON-Schlüssel in vorhandenen API-Antworten einzuführen. Wir empfehlen, Antworten defensiv zu verarbeiten und alle nicht erkannten Schlüssel zu ignorieren, um die fortlaufende Funktionalität aufrechtzuerhalten.

Agent-Endpunkte Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.