Documentation de Mettre à jour un agent (v2)
Mettre à jour un agent (v2)
Mettre à jour un agent (v2)
Mettre à jour un agent (v2)
Connexion, déconnexion, pauses et modifications du profil
Présentation
Points de terminaison disponibles
/api/v2/agentsParamètres clés
agent_number(String)Le numéro de téléphone actuel de l'agent. Envoyez ce champ ou agent_sip, pas les deux.
agent_sip(String)L'extension SIP de l'agent. Envoyez ce champ ou agent_number, pas les deux.
status(Integer)0 connecte l'agent (Disponible). 2 le déconnecte (Hors ligne) ou, avec un break_id, le met sur cette pause. Aucune autre valeur n'est acceptée.
break_id(Integer)La pause sur laquelle mettre l'agent. Doit être une pause activée pour votre service. Envoyer break_id implique le statut 2 et ne peut pas être combiné avec le statut 0. Avec le statut 2 et sans break_id, la pause par défaut 7 (Hors ligne) est utilisée, ce qui déconnecte l'agent.
number(String)Nouveau numéro de téléphone : 4 à 15 chiffres, sans +, espaces ni tirets. Il ne doit appartenir à aucun autre agent du service. Il ne peut pas être modifié pendant que l'agent est en communication.
country_code(String)1 à 4 chiffres sans +, ne commençant pas par 0, par exemple 91 ou 971.
Scénarios d'utilisation
Connecter un agent
Définissez status sur 0. L'agent devient Disponible et commence à recevoir les appels de ses files d'attente. Cela fait aussi sortir un agent de n'importe quelle pause.
Déconnecter un agent
Définissez status sur 2 sans break_id. L'agent passe Hors ligne (pause 7) et ne reçoit plus d'appels. Envoyer le statut 2 avec break_id 7 produit le même résultat.
Mettre un agent en pause
Envoyez le break_id ; le statut 2 est implicite. L'agent ne reçoit plus d'appels jusqu'à sa prochaine connexion. Ici, l'agent est désigné par son numéro de téléphone plutôt que par son extension SIP.
Passer d'une pause à une autre
Un agent ne peut pas passer directement d'une pause à une autre ; cet appel renvoie 409. Connectez-le d'abord (statut 0), puis envoyez le nouveau break_id. Les deux appels peuvent être réessayés sans risque.
Mettre à jour les informations de profil
Modifiez ensemble le nom, le numéro de téléphone et l'indicatif pays. Les champs de profil peuvent être envoyés dans le même appel que status ou break_id, mais le numéro ne peut pas être modifié pendant que l'agent est en communication.
Exemple rapide
Essayez cette API avec une simple commande cURL
curl -X PUT 'https://telephonycloud.co.in/api/v2/agents' \
-H 'Authorization: Bearer <YOUR_TOKEN>' \
-H 'Content-Type: application/json' \
-d '{"agent_sip": "10114", "status": 0}'Aperçu de la réponse
Exemple de réponse de cette API
{"status":"success","changed":["status","break_id"],"agent":{"id":735,"name":"Priya Sharma","number":"9876500000","country_code":"91","sip":"10114","status":2,"break_id":3}}