Endpoint del team

I team rappresentano un raggruppamento a cui può essere assegnato un agente, che a sua volta può essere assegnato a una coda. Ogni oggetto rappresenta una singola squadra.

Esistono tre endpoint del team:

  • /team: recupera un elenco di team.

  • /team/tree: estrae i team in una struttura ad albero.

  • /team/{:id} - estrae una singola risorsa del team.

Esamina il seguente modello per determinare quali campi potrebbero contenere PII.

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

Elenco Team

Parametro Obbligatorio Tipo di dati Definizione
sort_column FALSE Stringa Ordina la risposta in base a qualsiasi campo dell'oggetto risposta.
sort_direction FALSE ASC o DESC Indica la direzione dell'ordinamento, crescente o decrescente
pagina FALSE Stringa Coppie con per per indicare la pagina dei record. Ad esempio, se per è impostato su 200 e page è 2, la risposta conterrà i record da 201 a 400, poiché la pagina 1 conterrà i record da 1 a 200.
per FALSE Stringa Coppie con la pagina per annotare quanti record verranno inclusi in una pagina di record. Ad esempio, se per è impostato su 200 e page è 2, la risposta conterrà i record da 201 a 400, poiché la pagina 1 conterrà i record da 1 a 200.
agents_count[from] FALSE Numero crea un limite inferiore del campo conteggio agenti. Tutti i record restituiti saranno successivi al valore inserito.
agents_count[to] FALSE Numero crea un limite superiore del campo conteggio agenti. Tutti i record restituiti saranno precedenti al valore inserito.
id[] FALSE Array[Stringa] Array[Strings]. ID dei record da cercare e restituire
name[] FALSE Array[Stringa] Restituisce i record in base al nome della risorsa.
parent_id[] FALSE Array[Stringa] Restituisce i record in base all'ID padre dei record specificati
position[] FALSE Array[Stringa] Restituisce i record in base alla posizione di un menu
with_deleted FALSE Booleano Restituisce i record eliminati (True) o non include i record eliminati (False)

Endpoint:

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

Altri esempi di richieste/risposte:

Richiesta di esempio: elenco delle squadre

Body: None

Esempio di risposta: elenco dei 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"
      }
    ]
  },
  {
    "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"
      }
    ]
  }
]

Codice di stato: 200

Un solo team

Parametro Obbligatorio Tipo di dati Definizione
record_id FALSE Stringa Restituisce un record specifico in base all'ID.
with_deleted FALSE Booleano Restituisce i record eliminati (True) o non include i record eliminati (False)

Endpoint:

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

Altri esempi di richieste/risposte:

Esempio di richiesta: singolo team

Body: None

Esempio di risposta: un solo 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"
            }
        ]
    }

Codice di stato: 200

Albero del team

Endpoint:

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

Altri esempi di richieste/risposte:

Richiesta di esempio: struttura del team

Body: None

Esempio di risposta: albero del team

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

Codice di stato: 200