SparkTG

Documentation de Mettre à jour un agent (v2)

Mettre à jour un agent (v2)

v2

Mettre à jour un agent (v2)

Connexion, déconnexion, pauses et modifications du profil

API v2v21 point de terminaison

Présentation

Connectez ou déconnectez un agent, mettez-le en pause, ou modifiez son numéro de téléphone, son indicatif pays ou son nom d'affichage. Cela remplace PATCH /api/v1/agents. Identifiez l'agent avec exactement un des champs agent_number ou agent_sip, puis envoyez au moins un champ à modifier ; les champs omis ne sont pas touchés. Le corps est en JSON, et tout champ non listé ci-dessous est rejeté avec une erreur 400. null et les chaînes vides sont rejetés ; ce endpoint n'efface rien. Chaque appel réussi est comptabilisé une fois.

Points de terminaison disponibles

PUT/api/v2/agents

Paramè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.

0 paramètreDisponible dans les exemples

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.

0 paramètreDisponible dans les exemples

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.

0 paramètreDisponible dans les exemples

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.

0 paramètreDisponible dans les exemples

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.

0 paramètreDisponible dans les exemples

Exemple rapide

Essayez cette API avec une simple commande cURL

Appel d'API de base
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}'
💡 Remplacez <YOUR_TOKEN> par votre jeton d’API

Aperçu de la réponse

Exemple de réponse de cette API

Exemple de réponse
{"status":"success","changed":["status","break_id"],"agent":{"id":735,"name":"Priya Sharma","number":"9876500000","country_code":"91","sip":"10114","status":2,"break_id":3}}
Voir le format de réponse complet dans la section Réponse