Helpdesk Webservice

Weitergehende Informationen zum Helpdesk Webservice und der notwendigen Einstellungen im esoffice und esweb finden Sie im Bereich Informationen zur Nutzung des Helpdesk Webservice und unter esweb | Einstellungen | Allgemein | Service - Bereich 'Helpdesk Webservice'.

Sicherheit

 

Für den Helpdesk Webservice ist aus Sicherheitsgründen eine https-Verbindung erforderlich.

Webservice-Methoden

Login

Methodenname: login

Url: {esweb Url}/api/helpdesk/login

Parameter

keine

HTTP-Methode

POST

Benötigte HTTP-Header

ES-Req, Content-Length

Mögliche Antwort HTTP-Status

200, 401, 500

Beschreibung

Die Login-Methode generiert für die im ES-Req Header angegebenen Logindaten einen Token, der für die Verwendung der weiteren Methoden benötigt wird. Der ES-Req Header enthält base64-kodiert und durch : getrennt die Kennung, das Passwort und eine beliebige Bezeichnung für den Client.

 

Ab Version 11.0.7.0

Falls Passwort, Kennung oder Clientbezeichnung ein „:“ (Doppelpunkt) enthalten, können diese ab Version 11.0.7.0 folgendermaßen angegeben werden:

​Bei jedem „:“, dass nicht zur Trennung der Abschnitte verwendet wird, ist es erforderlich ein „\“ (Backslash) voranzustellen. Wenn ein „\“ im Text enthalten ist, ist ebenfalls ein vorangestelltes „\“ notwendig.

​Damit die Abwärtskompatibilität gewährleistet wird, ist es erforderlich, dass der gesamte Text mit „::“ beginnt.

 

Kennung: 1
Passwort: Gehe:im
Clientbezeichnung: Test\123
-> ::1:Gehe\:im:Test\\123
=> ES-Req: OjoxOkdlaGVcOmltOlRlc3RcXDEyMw==

Request-Header

ES-Req: MToxOkNsaWVudA==
Content-Length: 0

Response-Header

HTTP/1.1 200 OK
ES-Token: VqRptMpHKWmJgQHsik7FcPki4+mZWT5pYq7id2QYczQBAAAA
Content-Length: 0

Call anlegen

Methodenname: createservicecall

Url: {ES-Web Url}/api/helpdesk/createservicecall

Parameter

keine

HTTP-Methode

POST

Benötigte HTTP-Header

ES-Token, Content-Length, Content-Type

Benötigter Content

Servicecalldaten

Mögliche Antwort HTTP-Status

200, 400, 401, 500

Antwortdaten

Servicecallantwortdaten

Beschreibung

Die Methoden erstellt aus den übergebenen Daten einen Servicecall und gibt Servicecallnr und TicketId zurück.

 

Requestheader

ES-Token: VqRptMpHKWmJgQHsik7FcPki4+mZWT5pYq7id2QYczQBAAAA
Content-Length: 457
Content-Type: application/json

Requestcontent

{
 „TicketId“: „123“,
 „CustomerId“: „5“,
 „Text“: „Nichts \“funktioniert\“ mehr!“,
 „ProblemCategory“: 5,
 „ContactId“: 14,
 „ContactName“: „Herr Max Mustermann“,
 „ContactPhoneNumber“: „0123456789“,
 „ContactEmail“: „max.mustermann@mustermann.de“,
 „LocalContactName“: „Frau Erika Mustermann“,
 „LocalContactPhoneNumber“: „098765431“,
 „LocalContactEmail“: „erika.mustermann@mustermann.de“,
 „ProductCategory“: 5,
 „ProductSubcategory“: 10
}

Responsecontent

{“TicketId“:“123“,“ServicecallId“:621}

Call aktualisieren

(Ab Version 10.95.15.6)

Methodenname: UpdateServicecall

Url: {ES-Web Url}/api/helpdesk/updateservicecall/{servicecallid}

Parameter

keine

HTTP-Methode

POST

Benötigte HTTP-Header

ES-Token, Content-Length, Content-Type

Benötigter Content

ServicecallUpdatedaten

Mögliche Antwort HTTP-Status

200, 400, 401, 500

Antwortdaten

Keine (nur Status)

Beschreibung

Die Methoden aktualisiert einen Servicecall mit den übergebenen Daten.

 

Requestheader

ES-Token: VqRptMpHKWmJgQHsik7FcPki4+mZWT5pYq7id2QYczQBAAAA
Content-Length: 30
Content-Type: application/json

Requestcontent

{
„ProblemCategory“: 2
}
ServicecallData

Methodenname: servicecalldata

Url: {ES-Web Url}/api/helpdesk/servicecalldata/{servicecallid}

Parameter

from, to

HTTP-Methode

GET

Benötigte HTTP-Header

ES-Token

Mögliche Antwort HTTP-Status

200, 400, 401, 404, 500

Antwortdaten

Servicecallantwortdaten

Beschreibung

Die Methode ruft Informationen zum Servicecall mit den übergebenen Daten ab.

 

Requestheader

ES-Token: VqRptMpHKWmJgQHsik7FcPki4+mZWT5pYq7id2QYczQBAAAA

Responseheader

Content-Type: application/json; charset=utf-8

Responsecontent

Kopieren
{
 „StatusData“:[
 {
  „State“:“Started“,
  „Date“:“2016-03-14T14:11:12.101
 },
 {
  „State“:“Forwarded“,
  „Date“:“2016-03-14T14:11:27.522
 }],
 „Communication“:[
 {
  „MessageId“:600357,
  „Date“:“2016-03-14T14:09:39.451“,
  „Incoming“:false,
  „ContactName“:“Herr Max Mustermann“,
  „Text“:“Hallo Herr Mustermann,\r\n\r\ndie Lösung ihres Problems lautet:“,
  „Url“:“http://[ES-Web-Url]/service/helpdeskdetail.aspx?einzelaktnr=600357&servcallnr=621&tabcon=1
 }],
 „ServicecallId“:621
}

ServicecallAcceptState

Methodenname: servicecallacceptstate

Url: {ES-Web Url}/api/helpdesk/servicecallacceptstate/{servicecallid}

Parameter

keine

HTTP-Methode

POST

Benötigte HTTP-Header

ES-Token, Content-Length

Benötigter Content

Servicecallakzeptierendaten

Mögliche Antwort HTTP-Status

200, 400, 401, 404, 500

Antwortdaten

Statusdaten

Beschreibung

Mit der Methode kann übermittelt werden, ob der Kunden die Lösung für den Servicecall akzeptiert.

 

Request

Request-Header

POST https://[ES-Web-Url]/api/helpdesk/servicecallacceptstate/621 HTTP/1.1
Host: localhost:53920
ES-Token: VqRptMpHKWmJgQHsik7FcPki4+mZWT5pYq7id2QYczQBAAAA
Content-Length: 73
Content-Type: application/json

Requestcontent

{
 „Accept“: false,
 „RejectionMessage“: „Das geht alles nicht“
}
Response:
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Mon, 14 Mar 2016 13:50:37 GMT
Content-Length: 61
 
{“State“:“Sonderpriorität“,“Date“:“2016-03-14T14:50:36.731“}

Datenpakete

Servicecalldaten

Format: JSON

Felder

Feld

Format

Benötigt / Required

Beschreibung

TicketId

string

benötigt

Eindeutige ID im Client-System

CustomerId

string

benötigt, wenn keine ObjectId vorhanden

Kunden-ID im Client-System

 

Spalte KUNDENID aus der Tabelle KUNDEN

Text

string

benötigt

Servicecallmeldung

ProblemCategory

number

 

Nummer der Problemkategorie (esoffice), die im Servicecall eingetragen werden soll

ContactId

number

 

Ansprechpartnernummer (esoffice), die im Servicecall verwendet werden soll

ContactName

string

 

Name des Ansprechpartners

ContactPhoneNumber

string

 

Telefonnummer des Ansprechpartners

ContactEmail

string

 

E-Mail-Adresse des Ansprechpartners

LocalContactName

string

 

Name des Ansprechpartners vor Ort

LocalContactPhoneNumber

string

 

Telefonnummer des Ansprechpartners vor Ort

LocalContactEmail

string

 

E-Mail-Adresse des Ansprechpartners vor Ort

ProductCategory

number

 

Nummer der Produktkategorie im esoffice

ProductSubcategory

number

 

Nummer der Produktsubkategorie in esoffice

Maintenance

bool

 

Wenn true wird dem Meldungstext ein Hinweis hinzugefügt, dass es sich um eine Wartung handelt.

ObjectId

string

benötigt, wenn CustomerId nicht vorhanden

Anlagen-ID im Client-System

 

Es wird geprüft, ob die übergebene ObjectID in der Spalte LUUTAIDNR oder der Spalte CHIPNR der Tabelle ANLAGEN gefunden wird.

Für die ObjectID wird das Feld Referenznummer 3 auf dem Register Service | Anlagen | Details II - Bereich 'Referenznummern' verwendet.

(bei aktiven Aufzugstools wird das Feld als Chipnummer angezeigt.

 

Das Feld wird nur angezeigt, wenn unter Einstellungen | Allgemein | Service I die Option Gefahrenmelde Tools aktivieren aktiviert ist und die Felder über die Option Mit Referenznummern unter Einstellungen | Allgemein | Service I - Bereich 'Anlagenverwaltung' eingeschaltet wurden.

Subject

string

 

Matchcode des Servicecalls

ServiceLevelCode

number

 

Nummer des Servicelevel

ConversationType

Ab Version 10.95.15.13

number

 

Nummer der Gesprächsart

ConversationTopic

Ab Version 10.95.15.13

number

 

Nummer des Gesprächsthemas

Servicecallantwortdaten

Format: JSON

Felder

Feld

Format

Benötigt / Required

Beschreibung

TicketId

string

 

Eindeutige ID im Client-System

ServicecallId

number

 

Eindeutige Nummer im esoffice

Servicecallakzeptierendaten

Format: JSON

Felder

Feld

Format

Benötigt / Required

Beschreibung

Accept

bool

benötigt

Ob die Lösung akzeptiert wurde (Pflichtangabe)

RejectionMessage

string

 

Nachricht die beim Ablehnen der Lösung angegeben werden kann

Servicecallinformationen

Format: JSON

Felder

Feld

Format

Benötigt / Required

Beschreibung

Communication

Kommunikationsdaten Array

 

Die bisherigen Kontakte im esoffice

StatusData

Statusdaten Array

 

Die bisherigen Statusänderungen im esoffice

ServicecallId

number

 

Servicecallnummer im esoffice

Result

string

 

Ergebnis des Servicecalls (nur vorhanden, wenn das Ergebnis gemäß Webeinstellung für den Kunden sichtbar ist)

ErrorType

string

 

Bezeichnung des ausgewählten Fehlercodes des Servicecalls (im Sprachcodes des angemeldeten Benutzers)

ErrorCause

string

 

Bezeichnung der ausgewählten Ursachencodes (im Sprachcodes des angemeldeten Benutzers)

SubErrorCause

string

 

Bezeichnung des ausgewählten Ursachensubcodes (im Sprachcodes des angemeldeten Benutzers)

SolutionType

string

 

Bezeichnung des ausgewählten Lösungscodes (im Sprachcodes des angemeldeten Benutzers)

Priority

(ab Version 11.0.3.9)

string

 

Die Bezeichnung der ausgewählten Priorität

ProblemCategory

(ab Version 11.0.3.9)

string

 

Die Bezeichnung der ausgewählten Problemkategorie

DepartmentCode

(ab Version 12.0.23.1)

string

 

Abteilungskennzeichen

Datenbankfeld AbtKennz

Kommunikationsdaten

Format: JSON

Felder

Feld

Format

Benötigt / Required

Beschreibung

MessageId

number

 

Kontaktnummer

Date

string DateTime im Javascript-Format

 

Datum und Uhrzeit des Kontakts

Incoming

bool

 

Eingehender Kontakt

ContactName

string

 

Ansprechpartnername

ContactPhoneNumber

string

 

Ansprechpartnertelefonnummer

ContactEmail

string

 

Ansprechpartner E-Mailadresse

ActivityTyp

string

 

Bezeichnung der Aktivitätsart des Kontakts

Text

string

 

Inhalt des Kontaktes

Url

string

 

URL des Kontakts im esweb Helpdesk

Statusdaten

Format: JSON

Felder

Feld

Format

Benötigt / Required

Beschreibung

State

string

 

Bezeichnung des Status

Date

string DateTime im Javascript-Format

 

Datum und Uhrzeit der Statusänderung

ServicecallUpdatedaten

Format: JSON

Felder

Feld

Format

Benötigt / Required

Beschreibung

ProblemCategory

number

 

Die Nummer der Problemkategorie (esoffice) die im Servicecall eingetragen werden soll

Informationen zur Nutzung des Helpdesk Webservice

Immer mehr Unternehmensübergreifende Prozesse laufen Software-gestützt ab. Eine Fluggesellschaft beispielsweise setzt ein internes Trouble-Ticket-System ein, um den Überblick über die vielen Anlagen im Unternehmen zu behalten. Fallen zum Beispiel in einer Abteilung die Melder oder Telefone aus, melden dies die betroffenen Mitarbeiter der internen IT-Abteilung. Die Kollegen dort tragen die Störmeldung in das interne Trouble-Ticket-System ein.

Für eine schnelle Lösung ist es sinnvoll, das interne System mit externen Systemen zu verbinden. So wird in diesem Beispielfall bei der Ticket-Anlage vollautomatisch digital ein Störungsticket im esoffice-Helpdesk des Errichters angelegt, der die betroffene TK-Anlage betreut. Oder es wird automatisiert eine E-Mail an den Errichter versandt, die im esoffice-Helpdesk automatisch als neuer Servicecall interpretiert wird.

Der Errichter weiß sofort, wenn mit einer seiner Anlagen etwas nicht stimmt und welche Komponenten betroffen sind. Ein Techniker zur Störungsbehebung kann umgehend eingesetzt werden. Dank der automatischen Ticket-Anlage hat er Zugriff auf alle wichtigen Informationen wie Historiendaten oder Kontakteinträge. Vertraglich vereinbarte Reaktionszeiten können so viel einfacher mit weniger Aufwand eingehalten werden.

Ihre Vorteile im Überblick

Schnellere Prozessdurchlaufzeiten

Schnellere Reaktionszeiten

Schnellere Störungsverfolgung und Störungsbehebung

Für die Integration eines Ticket-Systems mit dem esHelpdesk werden über den Helpdesk Webservice folgende Möglichkeiten bereitgestellt:

1. Call anlegen

Der Servicecall wird anhand der übermittelten Daten angelegt.

Funktion: Anhand der Parameter wird im esHelpdesk ein neuer Servicecall angelegt und gestartet.

2. Calldaten abrufen

Dieser Webservice dient zum Updaten von Tickets im Ticket-System. Die Übertragung erfolgt auf Abruf (ein Zeitgesteuerter Webservice beim Kunden fragt die Daten an).

Funktion: Es werden Historiendaten und Kontakteinträge zum Servicecall geliefert.

3. Lösung für Servicecall akzeptieren oder ablehnen

Funktion: Der Servicecall wird auf den in den Grundeinstellungen (Einstellungen | Referenzen - Service | Helpdeskreferenzen - Servicecallstatus) hinterlegten Status für akzeptierte oder nicht akzeptierte Lösungen gesetzt.

Benötigte Einstellungen

esoffice

Einstellungen | Allgemein | Sicherheit - Bereich 'esweb' Basis-Url

Diese Einstellung wird benötigt, damit beim Abrufen der Kontakte die URL des Kontakts zurückgegeben werden kann.

esweb

esweb -> Einstellungen | Allgemein | Service | Helpdesk Webservice

Kundennr. Kunde unbekannt

Wählen Sie hier eine Kundennummer aus, die verwendet wird, wenn die übertragenen Customerid aus dem Ticketsystem in der esoffice Datenbank nicht gefunden werden kann.

 

Einen entsprechenden Kundendatensatz können Sie unter Office | Kunden anlegen.

Status Kunde unbekannt

Servicecallstatus, der verwendet wird, wenn die übertragenen CustomerId in der esoffice Datenbank nicht gefunden werden kann.

 

Servicecallstatus können im esoffice unter Einstellungen | Referenzen - Service | Helpdeskreferenzen | Servicecallstatus angelegt / bearbeitet werden.

Lösung akzeptiert Status

Servicecallstatus, der gesetzt wird, wenn die Lösung vom Kunden akzeptiert wird.

 

Servicecallstatus können im esoffice unter Einstellungen | Referenzen - Service | Helpdeskreferenzen | Servicecallstatus angelegt / bearbeitet werden.

Lösung abgelehnt Status

Servicecallstatus, der gesetzt wird, wenn die Lösung vom Kunden abgelehnt wird.

 

Servicecallstatus können im esoffice unter Einstellungen | Referenzen - Service | Helpdeskreferenzen | Servicecallstatus angelegt / bearbeitet werden.

Option 'Mit Servicelevel'

Diese Option legt fest, ob der Servicelevel über den Webservice gesetzt werden kann, wenn der Benutzer (zum Beispiel Kundenlogin) nicht die entsprechende Berechtigung hat. Ist die Option nicht aktiviert, kann der Servicelevel ohne entsprechende Berechtigung nicht gesetzt werden.

esweb -> Einstellungen | Allgemein | Service | Helpdesk

Ergebnis für Kunden sichtbar

Hier legen Sie fest bei welchem Servicecallstatus der Wert des Ergebnisfeldes an den Kunden übertragen wird. Aktivieren Sie die Option des entsprechenden Servicecallstatus damit dieser das Ergebnis für den Kunden sichtbar ist bzw. über den Webservice übertragen werden kann.

 

An dieser Stelle werden in den Helpdeskreferenzen angelegten Servicecallstatus zur Auswahl angezeigt. Sie können Servicecallstatus im esoffice unter Einstellungen | Referenzen - Service | Helpdeskreferenzen | Servicecallstatus angelegen / bearbeiten.