Points de terminaison de l'état de l'agent

Les points de terminaison de l'API d'état des agents permettent d'accéder aux objets d'état des agents. Un objet agent est créé pour chaque utilisateur configuré dans Contact Center AI Platform (CCAI Platform) et disposant d'un rôle incluant une autorisation d'agent.

Voici les points de terminaison de l'API d'état de l'agent :

Les points de terminaison d'état des agents vous permettent de modifier l'état des agents. Ils permettent de passer de l'état Disponible à n'importe quel état personnalisé. Les transitions vers et depuis des états définis par le système, comme En appel, déclenchent une erreur. De plus, ces points de terminaison sont compatibles avec les mises à jour groupées, ce qui permet de modifier simultanément l'état de toute une équipe ou de groupes d'agents sélectionnés.

Modifier l'état de l'agent

Ce point de terminaison vous permet de modifier l'état des agents. Le tableau suivant présente les propriétés du corps JSON :

Property (Propriété) Obligatoire Type de données Définition
état TRUE Chaîne État dans lequel définir les agents (par exemple, "Disponible").
agent_ids TRUE Entier Arry ARRAY d'ID d'agents.
team_ids TRUE Tableau d'entiers ARRAY d'ID d'équipe.

Point de terminaison :

Method: POST
Type: RAW
URL: https://{subdomain}.{domain}/apps/api/v1/agent_statuses

En-têtes

Clé Valeur Description
Content-Type application/json

Corps :

{
    "status": "Available",
    "agent_ids": [
        11,
        12
    ],
    "team_ids": []
}

Exemple de requête et de réponses

Les sections suivantes fournissent des exemples de requêtes au point de terminaison.

Modifier l'état des agents

L'exemple suivant illustre la requête et la réponse associée pour la modification de l'état de certains agents lorsque l'action a réussi.

Requête

En-têtes

Clé Valeur Description
Content-Type application/json

Corps :

{
    "status": "Available",
    "agent_ids": [
        11,
        12
    ],
    "team_ids": [
        1
    ]
}
Réponse :
[
    {
        "agent_id": 11,
        "name": "Darth Vader",
        "email": "notanakinskywalker@empire.com",
        "agent_number": "Agent No.111",
        "previous_status": "lunch",
        "current_status": "Available"
    },
    {
        "agent_id": 12,
        "name": "Craig T",
        "email": "craigT@nelson.com",
        "agent_number": "Agent No.112",
        "previous_status": "In-call",
        "current_status": "In-call",
        "message": "Agent can't be changed from system status 'In-call'"
    },
    {
        "agent_id": 13,
        "name": "Raymond D",
        "email": "rayd@nelson.com",
        "agent_number": "Agent No.113",
        "previous_status": "Offline",
        "current_status": "Offline",
        "message": "Agent's status can't be changed if they are offline or logged out"
    }
]

Code d'état : 200

L'état n'existe pas

Cet exemple montre la requête et la réponse associée lorsque l'état fourni n'existe pas et est donc considéré comme non valide.

Requête

En-têtes

Clé Valeur Description
Content-Type application/json

Corps :

Body
{
    "status": "Napping",
    "agent_ids": [
        11,
        12
    ],
    "team_ids": []
}
Réponse : Erreur : l'état "Napping" n'existe pas
{
    "message": "status 'Napping' does not exist"
}

Code d'état : 400

État défini sur l'état du système

Cet exemple montre la requête et la réponse lorsque l'état est défini sur un état système, en l'occurrence "in-call" (en appel). Il n'est pas possible de définir l'état d'un agent sur un état géré par le système.

Requête

En-têtes

Clé Valeur Description
Content-Type application/json

Corps :

Body
{
    "status": "In-call",
    "agent_ids": [
        11,
        12
    ]
}
Réponse : Erreur : Impossible de modifier l'état de l'agent sur "En communication"
{
    "message": "Agent can't be changed to system status 'In-call'"
}

Code d'état : 400

Obtenir les états des agents

Ce point de terminaison vous permet de récupérer l'état des agents. Le tableau suivant présente les propriétés du corps JSON :

Property (Propriété) Obligatoire Type de données Définition
état TRUE Chaîne État dans lequel définir les agents (par exemple, "Disponible").
agent_ids FALSE Entier Arry ARRAY d'ID d'agents.
team_ids FALSE Tableau d'entiers ARRAY d'ID d'équipe.

Point de terminaison :

Method: GET
Type: RAW
URL: https://{subdomain}.{domain}/apps/api/v1/agent_statuses

En-têtes

Clé Valeur Description
Content-Type application/json

Corps :

{
    "agent_ids": [
        11,
        12
    ],
    "team_ids": [
        1
    ]
}

Exemple de requête et de réponses

Les sections suivantes fournissent des exemples de requêtes au point de terminaison.

Obtenir l'état des agents et des équipes spécifiques

Cet exemple montre comment obtenir l'état des agents dont les ID sont 11 et 12, ainsi que celui de tout agent de l'équipe dont l'ID est 1.

Requête

En-têtes

Clé Valeur Description
Content-Type application/json

Corps :

{
    "agent_ids": [
        11,
        12
    ],
    "team_ids": [
        1
    ]
}
Réponse : état des agents demandés
[
    {
        "agent_id": 11,
        "name": "Darth Vader",
        "email": "notanakinskywalker@empire.com",
        "agent_number": "Agent No.111",
        "status": "lunch",
        "ip_addrs": [
            "34.211.11.101"
        ]
    },
    {
        "agent_id": 12,
        "name": "Craig T",
        "email": "craigT@nelson.com",
        "agent_number": "Agent No.112",
        "status": "In-call",
        "ip_addrs": [
            "34.211.11.102"
        ]
    },
    {
        "agent_id": 13,
        "name": "Raymond D",
        "email": "rayd@nelson.com",
        "agent_number": "Agent No.113",
        "status": "Offline",
        "ip_addrs": [
            "34.211.11.103"
        ]
    }
]

Code d'état : 200