Wrap-Up API - Tenios

Dokumentation

Wrap-Up erweitern

Diese Methode ermöglicht, den Wrap-Up-Status für den angegebenen Agenten zu erweitern. Die Anfrage sollte den richtigen Zugriffsschlüssel, die richtige E-Mail des Agenten und die richtige Endzeit enthalten, um die Wrap-Up Zeit zu verlängern. Die Endzeit sollte ein DateTime-Parameter sein, der eine Zeitzone enthält, z. 2020-01-01T09: 00: 00.000Z.

POST	https://api.tenios.com/wrap-up/extend

Anfrageparameter:

access_key String Obligatorisch	Der Zugriffsschlüssel für die API. Dieser kann im Kundenportal unter dem Menüpunkt MY ACCOUNT->Allgemeine Einstellungen im Abschnitt API gefunden werden.
agent_email String Obligatorisch	E-Mail des Agenten, dessen Wrap-Up-Status erweitert werden soll.
end_time String Obligatorisch	Zeitpunkt, bis zu dem der WrapUp-Status verlängert werden soll

Beispiel für eine erfolgreiche Anfrage:

Request:

{
   "access_key": "***************************",
   "agent_email": "agent@test.com",
   "end_time": "2020-01-01T09:00:00.000Z"
}

API Response:

HTTP Status Code: 200 (OK)

{
   "success": true,
   "wrap_up_end_time": "2020-01-01T09:00:00.000Z"
}

Beispiele für fehlerhafte Anfragen:

FIELD_IS_REQUIRED

Dieser Fehler wird zurückgegeben, wenn agent_email Parameter fehlt oder nicht angegeben wurde.

Request:

{
   "access_key": "***************************",
   "end_time": "2020-01-01T09:00:00.000Z"
}

oder

Request:

{
   "access_key": "***************************",
   "agent_email": "",
   "end_time": "2020-01-01T09:00:00.000Z"
}

API Response:

HTTP Status Code: 400 (Bad Request)

{
   "error_code": "FIELD_IS_REQUIRED",
   "error_message": "Parameter 'agent_email' is required",
   "fields": [
      "agent_email"
   ]
}

AGENT_NOT_FOUND

Dieser Fehler wird zurückgegeben, wenn eine ungültige Eingabe beim Parameter agent_email angegeben wurde.

Request:

{
   "access_key": "***************************",
   "agent_email": "notExistingEmail@test.com",
   "end_time": "2020-01-01T09:00:00.000Z"
}

API Response:

HTTP Status Code: 400 (Bad Request)

{
   "error_code": "AGENT_NOT_FOUND",
   "error_message": "Agent not found.",
   "fields": [
      "agent_email"
   ]
}

AGENT_NOT_IN_WRAP_UP

Der Agentbefindet sich derzeit nicht in einem Wrap-Up Status.

Request:

{
   "access_key": "***************************",
   "agent_email": "agent@test.com",
   "end_time": "2020-01-01T09:00:00.000Z"
}

API Response:

HTTP Status Code: 400 (Bad Request)

{
   "error_code": "AGENT_NOT_IN_WRAP_UP",
   "error_message": "Agent currently not in wrapUp state",
   "fields": []
}

WRAP_UP_DATE_PARSE_ERROR

Dieser Fehler wird zurückgegeben, wenn end_time in einem falschen Format vorliegt.

Request:

{
   "access_key": "***************************",
   "agent_email": "agent@test.com",
   "end_time": "01-01-20020T09:00:00.000"
}

API Response:

HTTP Status Code: 400 (Bad Request)

{
   "error_code": "WRAP_UP_DATE_PARSE_ERROR",
   "error_message": "Parameter 'end_time' value parsing error: format must be yyyy-MM-dd'T'HH:mm:ss.SSSZ. E.g. 2016-01-01T09:00:00.000Z",
   "fields": [
      "end_time"
   ]
}

WRAP_UP_INVALID_EXTEND_TIME_AMOUNT

Dieser Fehler wird zurückgegeben, wenn eine ungültige Verlängerungszeit vorliegt. Mindestwertfür die Verlängerung ist:5 Sekunden

Request:

{
   "access_key": "***************************",
   "agent_email": "agent@test.com",
   "end_time": "2020-01-01T09:00:00.000Z"
}

API Response:

HTTP Status Code: 400 (Bad Request)

{
   "error_code": "WRAP_UP_INVALID_EXTEND_TIME_AMOUNT",
   "error_message": "Invalid amount of time to extend. Minimum value to extend - 5 seconds",
   "fields": []
}

WRAP_UP_EXCEEDED_LIMIT

Dieser Fehler wird zurückgegeben, wenn eine Verlängerungszeit über15 Minuten vorliegt.

Request:

{
   "access_key": "***************************",
   "agent_email": "agent@test.com",
   "end_time": "2020-01-01T09:20:00.000Z"
}

API Response:

HTTP Status Code: 400 (Bad Request)

{
   "error_code": "Requested WrapUp Extension time is too high",
   "error_message": "WRAP_UP_EXCEEDED_LIMIT",
   "fields": []
}

Wrap-Up abbrechen:

Diese Methode ermöglicht, den Wrap-Up-Status für den angegebenen Agenten abzubrechen. Die Anfrage sollte den richtigen Zugriffsschlüssel und die richtige E-Mail-Adresse des Agenten enthalten.

POST	https://api.tenios.com/wrap-up/cancel

Anfrageparameter:

access_key String Obligatorisch	Der Zugriffsschlüssel für die API. Dieser kann im Kundenportal unter dem Menüpunkt MY ACCOUNT->Allgemeine Einstellungen im Abschnitt API gefunden werden.
agent_email String Obligatorisch	E-Mail des Agenten, dessen Wrap-Up-Status erweitert werden soll.

Beispiel für eine erfolgreiche Anfrage:

Request:

{
   "access_key": "***************************",
   "agent_email": "agent@test.com"
}

API Response:

HTTP Status Code: 200 (OK)

{
   "success": true
}

Beispiele für fehlerhafte Anfragen:

FIELD_IS_REQUIRED

Dieser Fehler wird zurückgegeben, wenn agent_email Parameter fehlt oder nicht angegeben wurde.

{
   "access_key": "***************************"
}

oder

{
   "access_key": "***************************",
   "agent_email": ""
}

API Response:

HTTP Status Code: 400 (Bad Request)

{
   "error_code": "FIELD_IS_REQUIRED",
   "error_message": "Parameter 'agent_email' is required",
   "fields": [
      "agent_email"
   ]
}

AGENT_NOT_FOUND

Dieser Fehler wird zurückgegeben, wenn eine ungültige Eingabe beim Parameter agent_email angegeben wurde.

Request:

{
   "access_key": "***************************",
   "agent_email": "notExistingEmail@test.com"
}

API Response:

HTTP Status Code: 400 (Bad Request)

{
   "error_code": "AGENT_NOT_FOUND",
   "error_message": "Agent not found.",
   "fields": [
      "agent_email"
   ]
}

AGENT_NOT_IN_WRAP_UP

Der Agentbefindet sich derzeit nicht in einem Wrap-Up Status.

Request:

{
   "access_key": "***************************",
   "agent_email": "agent@test.com"
}

API Response:

HTTP Status Code: 400 (Bad Request)

{
   "error_code": "AGENT_NOT_IN_WRAP_UP",
   "error_message": "Agent currently not in wrapUp state",
   "fields": []
}