Les équipes représentent un groupe auquel un agent peut être affecté, qui peut ensuite être affecté à une file d'attente. Chaque objet représente une seule équipe.
Il existe trois points de terminaison d'équipe :
/team: extrait une liste d'équipes./team/tree: extrait les équipes dans une structure arborescente./team/{:id}: extrait une seule ressource d'équipe.
Consultez le modèle suivant pour déterminer les champs susceptibles de contenir des informations personnelles.
[
{
"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"
}
}
]
Liste "Équipe"
| Paramètre | Obligatoire | Type de données | Définition |
|---|---|---|---|
| sort_column | FALSE | Chaîne | Trie la réponse en fonction de n'importe quel champ de l'objet de réponse. |
| sort_direction | FALSE | ASC ou DESC | Indique le sens du tri (croissant ou décroissant). |
| page | FALSE | Chaîne | Associe "per" pour indiquer la page d'enregistrements. Par exemple, si "per" est défini sur 200 et "page" sur 2, la réponse contient les enregistrements 201 à 400, car la page 1 contient les enregistrements 1 à 200. |
| per | FALSE | Chaîne | Associe "page" pour indiquer le nombre d'enregistrements à inclure dans une page d'enregistrements. Par exemple, si "per" est défini sur 200 et "page" sur 2, la réponse contient les enregistrements 201 à 400, car la page 1 contient les enregistrements 1 à 200. |
| agents_count[from] | FALSE | Nombre | Crée une limite inférieure pour le champ du nombre d'agents. Tous les enregistrements renvoyés seront postérieurs à la valeur saisie. |
| agents_count[to] | FALSE | Nombre | Crée une limite supérieure pour le champ du nombre d'agents. Tous les enregistrements renvoyés seront antérieurs à la valeur saisie. |
| id[] | FALSE | Tableau[Chaîne] | Tableau[Chaînes]. ID des enregistrements à rechercher et à renvoyer |
| name[] | FALSE | Tableau[Chaîne] | Renvoie les enregistrements en fonction du nom de la ressource. |
| parent_id[] | FALSE | Tableau[Chaîne] | Renvoie les enregistrements en fonction de l'ID parent des enregistrements donnés. |
| position[] | FALSE | Tableau[Chaîne] | Renvoie les enregistrements en fonction de la position d'un menu. |
| with_deleted | FALSE | Booléen | Renvoie les enregistrements qui ont été supprimés (True) ou n'inclut pas les enregistrements qui ont été supprimés (False). |
Point de terminaison :
Method: GET
Type:
URL: https://{{subdomain}}.{{domain}}/manager/api/v1/teams
Autres exemples de requêtes/réponses :
Exemple de requête : liste "Équipe"
Corps : Aucun
Exemple de réponse : liste "Équipe"
[
{
"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"
}
]
}
]
Code d'état : 200
Équipe unique
| Paramètre | Obligatoire | Type de données | Définition |
|---|---|---|---|
| record_id | FALSE | Chaîne | Renvoie un enregistrement spécifique en fonction de son ID. |
| with_deleted | FALSE | Booléen | Renvoie les enregistrements qui ont été supprimés (True) ou n'inclut pas les enregistrements qui ont été supprimés (False). |
Point de terminaison :
Method: GET
Type:
URL: https://{{subdomain}}.{{domain}}/manager/api/v1/teams/{{team_id}}
Autres exemples de requêtes/réponses :
Exemple de requête : équipe unique
Corps : Aucun
Exemple de réponse : équipe unique
{
"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"
}
]
}
Code d'état : 200
Arborescence des équipes
Point de terminaison :
Method: GET
Type:
URL: https://{{subdomain}}.{{domain}}/manager/api/v1/teams/tree
Autres exemples de requêtes/réponses :
Exemple de requête : arborescence des équipes
Corps : Aucun
Exemple de réponse : arborescence des équipes
[
{
"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": []
}
]
}
]
Code d'état : 200