SparkTG

Einen Agenten aktualisieren (v2)-Dokumentation

Einen Agenten aktualisieren (v2)

v2

Einen Agenten aktualisieren (v2)

An- und Abmelden, Pausen und Profiländerungen

API v2v21 Endpunkt

Übersicht

Einen Agenten an- oder abmelden, in eine Pause schicken oder seine Telefonnummer, Landesvorwahl oder seinen Anzeigenamen ändern. Dies ersetzt PATCH /api/v1/agents. Identifizieren Sie den Agenten mit genau einem von agent_number oder agent_sip und senden Sie dann mindestens ein zu änderndes Feld; weggelassene Felder bleiben unberührt. Der Body ist JSON, und jedes unten nicht aufgeführte Feld wird mit 400 abgelehnt. null und leere Strings werden abgelehnt; dieser Endpunkt löscht nichts. Jeder erfolgreiche Aufruf wird einmal abgerechnet.

Verfügbare Endpunkte

PUT/api/v2/agents

Wichtige 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.

0 ParameterIn den Beispielen verfügbar

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.

0 ParameterIn den Beispielen verfügbar

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.

0 ParameterIn den Beispielen verfügbar

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.

0 ParameterIn den Beispielen verfügbar

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.

0 ParameterIn den Beispielen verfügbar

Kurzbeispiel

Testen Sie diese API mit einem einfachen cURL-Befehl

Einfacher API-Aufruf
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}'
💡 Ersetzen Sie <YOUR_TOKEN> durch Ihr API-Token

Antwortvorschau

Beispielantwort dieser API

Beispielantwort
{"status":"success","changed":["status","break_id"],"agent":{"id":735,"name":"Priya Sharma","number":"9876500000","country_code":"91","sip":"10114","status":2,"break_id":3}}
Vollständiges Antwortformat im Abschnitt „Antwort“ ansehen