Einen Agenten aktualisieren (v2)-Dokumentation
Einen Agenten aktualisieren (v2)
Einen Agenten aktualisieren (v2)
Einen Agenten aktualisieren (v2)
An- und Abmelden, Pausen und Profiländerungen
Übersicht
Verfügbare Endpunkte
/api/v2/agentsWichtige Parameter
agent_number(String)Die aktuelle Telefonnummer des Agenten. Senden Sie dieses Feld oder agent_sip, nicht beide.
agent_sip(String)Die SIP-Durchwahl des Agenten. Senden Sie dieses Feld oder agent_number, nicht beide.
status(Integer)0 meldet den Agenten an (Verfügbar). 2 meldet ihn ab (Offline) oder schickt ihn, zusammen mit einer break_id, in diese Pause. Andere Werte werden nicht akzeptiert.
break_id(Integer)In welche Pause der Agent geschickt wird. Muss eine für Ihren Service aktivierte Pause sein. break_id impliziert Status 2 und lässt sich nicht mit Status 0 kombinieren. Bei Status 2 ohne break_id wird die Standardpause 7 (Offline) verwendet, die den Agenten abmeldet.
number(String)Neue Telefonnummer: 4 bis 15 Ziffern, ohne +, Leerzeichen oder Bindestriche. Sie darf keinem anderen Agenten im Service gehören. Sie kann nicht geändert werden, solange der Agent in einem Gespräch ist.
country_code(String)1 bis 4 Ziffern ohne +, nicht mit 0 beginnend, zum Beispiel 91 oder 971.
Nutzungsszenarien
Einen Agenten anmelden
Setzen Sie status auf 0. Der Agent wird Verfügbar und erhält Anrufe aus seinen Warteschlangen. Dies holt einen Agenten auch aus jeder Pause zurück.
Einen Agenten abmelden
Setzen Sie status auf 2 ohne break_id. Der Agent wird Offline (Pause 7) und erhält keine Anrufe mehr. Status 2 mit break_id 7 bewirkt dasselbe.
Einen Agenten in eine Pause schicken
Senden Sie die break_id; Status 2 ist impliziert. Der Agent erhält keine Anrufe, bis er wieder angemeldet wird. Hier wird der Agent über die Telefonnummer statt über die SIP-Durchwahl ausgewählt.
Von einer Pause zur anderen wechseln
Ein Agent kann nicht direkt von einer Pause in eine andere wechseln; dieser Aufruf liefert 409. Melden Sie ihn zuerst an (Status 0) und senden Sie dann die neue break_id. Beide Aufrufe können gefahrlos wiederholt werden.
Profildaten aktualisieren
Ändern Sie Name, Telefonnummer und Landesvorwahl gemeinsam. Profilfelder können im selben Aufruf wie status oder break_id gesendet werden, die Nummer lässt sich aber nicht ändern, solange der Agent in einem Gespräch ist.
Kurzbeispiel
Testen Sie diese API mit einem einfachen cURL-Befehl
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}'Antwortvorschau
Beispielantwort dieser 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}}