Die ACD API ermöglicht es ACD Funktionalität in Ihr Projekt zu integrieren. Die folgenden URLs stehen zur Verfügung:
Bereit-Status eines Agenten abfragen:
Mit dieser Methode kann der aktuelle Bereit-Status eines Agenten abgefragt werden. Verwendet die HTTP POST-Methode.
POST | https://api.tenios.com/acd/agent-state/retrieve |
Anfrageparameter:
access_key String | Der Zugriffsschlüssel (Access Key) für die API. Dieser kann im Kundenportal unter dem Menüpunkt MY ACCOUNT/ Allgemeine Einstellungen im Abschnitt API gefunden werden. |
email String | E-Mail Adresse des Agenten (Cloud PBX->BENUTZER DETAILS) |
Antwortparameter:
state String | Der aktuelle Bereit-Status des Agenten. Kann den Wert READY oder NOT_READY haben. |
Beispiel für eine erfolgreiche Anfrage:
Request:
{ "access_key": "XXXXX-XXXX-XXXXXX", "email": "test@test.com" }
API Response:
HTTP Status Code: 200 (OK)
{ "email": "test@test.com", "state": "NOT_READY" }
Bereit-Status eines Agenten ändern:
Eine Methode um den Bereit-Status des Agenten zu ändern. Verwendet die HTTP-POST Methode.
POST | https://api.tenios.com/acd/agent-state/change |
Anfrageparameter:
access_key String | Der Zugriffsschlüssel (Access Key) für die API. Dieser kann im Kundenportal unter dem Menüpunkt MY ACCOUNT/ Allgemeine Einstellungen im Abschnitt API gefunden werden. |
email String | E-Mail Adresse des Agenten (Cloud PBX->BENUTZER DETAILS) |
state String | Der Bereit-Status auf den der Agent gesetzt werden soll. Kann den Wert READY oder NOT_READY haben. |
nrr String Optional | Akronym eines bereits vorkonfigurierten NBG. |
Antwortparameter:
success boolean | Hat den Wert true, wenn der Bereit-Status erfolgreich gesetzt werden konnte, ansonsten false. |
Beispiel für eine erfolgreiche Anfrage:
Request:
{ "access_key": "XXXXX-XXXX-XXXXXX", "email": "agent@test.com", "state": "READY", "nrr": "COF" }
API Response:
HTTP Status Code: 200 (OK)
{ "success": true }
Beispiele für fehlerhafte Anfragen:
Initialen Status der Agenten abfragen:
Eine Methode um einen aktuellen Snapshot der Bereit-, InCall- und Wrapup-Status aller Agenten abzufragen. Verwendet die HTTP-POST Methode.
POST | https://api.tenios.com//user-states/snapshot |
Anfrageparameter:
access_key String | Der Zugriffsschlüssel (Access Key) für die API. Dieser kann im Kundenportal unter dem Menüpunkt MY ACCOUNT/ Allgemeine Einstellungen im Abschnitt API gefunden werden. |
Antwortparameter:
success | boolean | Hat den Wert true, wenn der Bereit-Status erfolgreich gesetzt werden konnte, ansonsten false. | |||||||
user_states | array[user_states] | Ein array mit allen user states des accounts | |||||||
user | String | Die E-Mail Adresse des Cloud-PBX Benutzers (Agents) . | |||||||
states | states | Ein states-Objekt mit Ready-, InCall array mit allen user states des Cloud-PBX users | |||||||
ready | objekt | Ein Ready-Objekt mit Ready-, InCall array mit allen user states des Cloud-PBX users | |||||||
value | enum | Der Ready-Status des Agenten. Kann die Werte READY oder NOT_READY haben. | |||||||
ts | special timestamp | Ein Zeitstempel in einem speziellen Format, der angibt wann der Status begonnen hat. | |||||||
in_call | object | Ein InCall-Objekt | |||||||
value | enum | Der InCall-Status des Agenten. Kann die Werte IN_CALL oder NOT_IN_CALL haben. | |||||||
ts | special timestamp | Ein Zeitstempel in einem speziellen Format, der angibt wann der Status begonnen hat. | |||||||
wrap_up | object | Ein Wrapup-Objekt | |||||||
value | from / to attributes | Ein Wert mit den Attributen from und to mit Zeitstempeln wann der Wrapup-Status aktiv war. | |||||||
ts | special timestamp | Ein Zeitstempel in einem speziellen Format, der angibt wann der Status begonnen hat. |
Zeitstempel-Format
Der Zeitstempel besteht aus drei Teilen die durch einen Unterstrich ‚_‘ getrennt sind. Beispiel: 1526543964195_0000000021_cebccb2d3908ddbfe06922cd571de656ff7d1db0d2f567e5718522d891033a3a
- 1526543964195 – Millisekunden (UNIX timestamp)
- 0000000021 – 10-stelliger Zähler, der eine laufende Nummer der Nachricht während einer Verbindung angibt
- cebccb2d3908ddbfe06922cd571de656ff7d1db0d2f567e5718522d891033a3a – SHA256 hash von (1526543964195_0000000021_connectionId)
Beispiel für eine erfolgreiche Anfrage:
Request:
{ "access_key": "XXXXX-XXXX-XXXXXX" }
API Response:
HTTP Status Code: 200 (OK)
{ "success": true, "user_states": [ { "user": "michael2@test.com", "states": { "ready": { "value": "NOT_READY", "ts": "1643998017197_0000000000_d29b667b6cc6bf1e746845b8bad86a5b26148b5f3a6075738dbda864a18f96ad" }, "in_call": { "value": "NOT_IN_CALL", "ts": "1643998017210_0000000000_75434915172af89b392fbed918f20554600e3d565adb4b4cd1397b20fcb7297a" }, "wrap_up": { "value": "{from=1,to=1}", "ts": "1643998017213_0000000000_77b8406f16da083187e792d4b32f87206ead7f3fce9095e681f34bf620e44238" } } }, { "user": "michael@test.com", "states": { "ready": { "value": "READY", "ts": "1642771485759_0000000001_9faed22b74c48e1dcf77718cd25c3044a5b305b5f316aac3cc4af5a61053b987" }, "in_call": { "value": "IN_CALL", "ts": "1642771485779_0000000001_9faed22b74c48e1dcf77718cd25c3044a5b305b5f316aac3cc4af5a61053b987" }, "wrap_up": { "value": "{from=1642696809682,to=1642697267192}", "ts": "1642771485769_0000000001_9faed22b74c48e1dcf77718cd25c3044a5b305b5f316aac3cc4af5a61053b987" } } } ] }
Beispiele für fehlerhafte Anfragen:
Request:
{ "access_key": "XXXXX-XXXX-XXXXXX" }
API Response:
HTTP Status Code: 400 (Bad Request)
{ "error_code": "FIELD_IS_REQUIRED", "error_message": "Parameter" }