Teamendpunkte

Teams sind eine Gruppierung, der ein Kundenservicemitarbeiter zugewiesen werden kann. Das Team kann dann einer Warteschlange zugewiesen werden. Jedes Objekt steht für ein einzelnes Team.

Es gibt drei Teamendpunkte:

• /team – Ruft eine Liste von Teams ab.

• /team/tree – ruft Teams in einer Baumstruktur ab.

• /team/{:id} – ruft eine einzelne Teamressource ab.

Sehen Sie sich das folgende Modell an, um festzustellen, welche Felder möglicherweise personenbezogene Daten enthalten.

[
  {
    "id": 0,
    "name": "string",
    "parent_id": 0,
    "position": 0,
    "deleted": true,
    "agents_count": 0,
    "assignees": {
      "id": 0,
      "name": "string", // This may be considered PII
      "last_name": "string", // This may be considered PII
      "first_name": "string", // This may be considered PII
      "agent_number": "string", // This may be considered PII
      "avatar_url": "string"
    }
  }
]

Teamliste

Parameter	Erforderlich	Datentyp	Definition
sort_column	FALSE	String	Sortiert die Antwort anhand eines beliebigen Felds im Antwortobjekt.
sort_direction	FALSE	ASC oder DESC	Gibt die Sortierreihenfolge an, entweder aufsteigend oder absteigend.
Seite	FALSE	String	Paare mit „per“, um die Seite der Datensätze anzugeben. Wenn „per“ beispielsweise auf 200 und „page“ 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	Paare mit Seite, um anzugeben, wie viele Datensätze in einer Seite mit Datensätzen enthalten wären. Wenn „per“ beispielsweise auf 200 und „page“ 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.
agents_count[from]	FALSE	Zahl	Erstellt eine Untergrenze für das Feld „Anzahl der Kundenservicemitarbeiter“. Alle zurückgegebenen Datensätze liegen nach dem eingegebenen Wert.
agents_count[to]	FALSE	Zahl	Erstellt eine Obergrenze für das Feld „Anzahl der Kundenservicemitarbeiter“. Alle zurückgegebenen Datensätze liegen vor dem eingegebenen Wert.
id[]	FALSE	Array[String]	Array[Strings]. ID der Datensätze, die gesucht und zurückgegeben werden sollen
name[]	FALSE	Array[String]	Gibt Datensätze basierend auf dem Namen der Ressource zurück.
parent_id[]	FALSE	Array[String]	Gibt Datensätze basierend auf der übergeordneten ID der angegebenen Datensätze zurück.
position[]	FALSE	Array[String]	Gibt Datensätze basierend auf der Position eines Menüs zurück
with_deleted	FALSE	Boolesch	Gibt Datensätze zurück, die gelöscht wurden (True), oder schließt Datensätze aus, die gelöscht wurden (False).

Endpunkt:

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

Weitere Beispielanfragen/-antworten

Beispielanfrage: Teamliste

Body: None

Beispielantwort: Teamliste

[
  {
    "id": 11,
    "name": "Forest Moon of Endor Team",
    "parent_id": null,
    "position": 28,
    "agents_count": 3,
    "deleted": false,
    "assignees": [
      {
        "id": 19,
        "agent_number": "77",
        "name": "Storm Trooper 1",
        "last_name": "Storm",
        "first_name": "Trooper 1"
      },
      {
        "id": 20,
        "agent_number": "78",
        "name": "Storm Trooper 2",
        "last_name": "Storm",
        "first_name": "Trooper 2"
      },
      {
        "id": 21,
        "agent_number": "79",
        "name": "Storm Trooper 3",
        "last_name": "Storm",
        "first_name": "Trooper 3"
      }
    ]
  },
  {
    "id": 12,
    "name": "Death Star Team",
    "parent_id": null,
    "position": 28,
    "agents_count": 3,
    "deleted": false,
    "assignees": [
      {
        "id": 34,
        "agent_number": "80",
        "name": "Storm Trooper 5",
        "last_name": "Storm",
        "first_name": "Trooper 5"
      },
      {
        "id": 35,
        "agent_number": "81",
        "name": "Storm Trooper 6",
        "last_name": "Storm",
        "first_name": "Trooper 6"
      },
      {
        "id": 36,
        "agent_number": "82",
        "name": "Storm Trooper 7",
        "last_name": "Storm",
        "first_name": "Trooper 7"
      }
    ]
  }
]

Statuscode:200

Einzelnes Team

Parameter	Erforderlich	Datentyp	Definition
record_id	FALSE	String	Gibt einen bestimmten Datensatz basierend auf der ID zurück
with_deleted	FALSE	Boolesch	Gibt Datensätze zurück, die gelöscht wurden (True), oder schließt Datensätze aus, die gelöscht wurden (False).

Endpunkt:

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

Weitere Beispielanfragen/-antworten

Beispielanfrage: Einzelnes Team

Body: None

Beispielantwort: Einzelnes Team

    {
        "id": 11,
        "name": "Forest Moon of Endor Team",
        "parent_id": null,
        "position": 28,
        "agents_count": 3,
        "deleted": false,
        "assignees": [
            {
                "id": 19,
                "agent_number": "77",
                "name": "Storm Trooper 1",
                "last_name": "Storm",
                "first_name": "Trooper 1"
            },
            {
                "id": 20,
                "agent_number": "78",
                "name": "Storm Trooper 2",
                "last_name": "Storm",
                "first_name": "Trooper 2"
            },
            {
                "id": 21,
                "agent_number": "79",
                "name": "Storm Trooper 3",
                "last_name": "Storm",
                "first_name": "Trooper 3"
            }
        ]
    }

Statuscode:200

Teamstruktur

Endpunkt:

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

Weitere Beispielanfragen/-antworten

Beispielanfrage: Teamstruktur

Body: None

Beispielantwort: Teamstruktur

[
  {
    "id": 147,
    "name": "Storm Trooper Reigment",
    "parent_id": null,
    "position": 1,
    "agents_count": 9,
    "deleted": false,
    "children": [
      {
        "id": 34,
        "name": "Storm Trooper 1st Regiment",
        "parent_id": 147,
        "position": 1,
        "agents_count": 2,
        "deleted": false,
        "children": []
      }
    ]
  }
]

Statuscode:200