Installation
|
Installationsaufwand (PT) |
0,25 PT |
|---|
Die Einrichtung des Voicebots muss in Zusammenarbeit mit der A/V/E und CURSOR erfolgen, da ein Zugriff auf die Telefonanlage notwendig ist und ggf. Firewall-Regeln angepasst werden müssen.
Voraussetzungen für die Verwendung des Moduls
-
Das Modul EVI-BASIS muss lizenziert sein.
-
In EVI muss ein dedizierter User für den Voicebot eingerichtet werden
Technische Dokumentation
Komponentenübersicht
Skriptbibliothek
-
SC12AVEUtils
Übersteuerungsmöglichkeiten
Grundsätzlich können die mit dem Modul bereitgestellten Komponenten wie BPM-Prozesse, -teilprozesse, Suchen und Skriptbibliotheksmethoden übersteuert werden, um diese an individuelle Anforderungen und Bedürfnisse anzupassen.
Nach dem Einspielen eines Moduls sollte geprüft werden, ob bereits Methoden im Projekt übersteuert wurden und ob die Methodenänderung aus dem Standard im Projekt übernommen werden sollte.
Suchen
Folgende Suchen ermitteln die Daten, die an den Voicebot geliefert werden. Sollten die Daten kundenspezifisch über andere Wege ermittelt werden, sind die Suchen zu übersteuern und anzupassen.
-
C12AVE_ContractAccount: Ermittelt Daten zum Vertragskonstrukt eines Geschäftspartners und einer Produktart
-
C12AVE_ContractAccount_Water: Ermittelt Daten zum Vertragskonstrukt eines Geschäftspartners und der Produktart Wasser
-
C12AVE_MeterRead: Ermittelt Zählerstände zu einem Geschäftspartner und einer Zählernummer
-
C12AVE_MeterRead_Water: Ermittelt Zählerstände zu einem Geschäftspartner und einer Zählernummer von Wasserzählern
-
C12AVE_C12BILLPLAN: Ermittelt einen Abschlagsplan zu einem Geschäftspartner und einem Abrechnungsvertrag
-
C12AVE_C12ADVPAY: Ermittelt Einzelabschläge zu einem Geschäftspartner
-
C12AVE_C12INSTACC: Ermittelt Daten zu Lieferstellen eines Geschäftspartners und einer Produktart
-
C12AVE_C12OPCOUNTER: Ermittelt Zählwerke zu einer Messeinrichtung über die Zählernummer
-
C12AVE_EventArchiveDeletionRule: Legt die Kriterien für die Löschregel der Zeitereignis-Datensätze fest, die durch die Kommunikation zwischen Voicebot und CRM angelegt werden.
Skriptbibliotheksmethoden
Skriptklasse: SC12AVEUtils
|
Methodenname |
Funktionalität |
|---|---|
|
readCustomer |
Liest Daten zum Geschäftspartner aus. Dies beinhaltet zum einen dessen Stammdaten, aber auch Informationen, die der Voicebot zur Authentifizierung nutzt. |
|
readMeterReading |
Liest Zählerstandsinformationen aus. |
|
readBudgetBillingPlan |
Liest Abschlagsinformationen aus. |
|
writeCustomer |
Wird genutzt, um Informationen des Geschäftspartners zu ergänzen. Der Bot kann beispielsweise nach einer Telefonnummer oder dem Geburtsdatum fragen und hierüber im CRM ablegen. |
|
writeMeterReading |
Erfasst eine Zählerstandsmeldung im CRM. |
|
writeBudgetBillingPlan |
Erfasst eine Abschlagsänderung im CRM. |
|
getMediums |
Liefert die Produktarten zurück, die der Voicebot verarbeiten können soll. |
|
getFieldMapping… |
Diese Methoden enthalten das Mapping von CRM-Feldern auf Voicebot-Felder. Weitere Felder können hier aufgenommen werden, um sie dem Bot zur Verfügung zu stellen. Diese Felder müssen ggf. in Suchen ergänzt werden. |
|
getDataQualityFields |
Liefert eine Feldliste der Datenqualitätsfelder, die durch den Voicebot abgefragt und angereichert werden sollen. |
|
getAuthenticationFieldsV2 |
Liefert alle Felder und deren Werte des übergebenen IContainers zurück, die für die Authentifizierung des Voicebots genutzt werden sollen. |
API Beispiele
readCustomer
POST https://server:port/rest/api/event/v1/events
{
"eventType": "de.ave.readCustomer",
"payload": {
"Kundennummer": ""
}
}
Response:
{
"id": "16u01r11k4v4ieahEvAr",
"status": "DONE",
"payload": {
"customerValue": 5.0,
"duration": 481,
"Kundennummer": "20220328",
"Typ": "Frau",
"churnscore": 44.0,
"dataQualityFields": {
"AcademicTitle.Customer": {
"i18n": "Namenstitel",
"dataType": "String",
"currentValue": null
},
"Email.Customer": {
"i18n": "E-Mail",
"dataType": "String",
"currentValue": "anla_demo@cursor.de"
},
"ComposedMobilePhone.Customer": {
"i18n": "Mobiltelefon",
"dataType": "String",
"currentValue": null
},
"Website.Customer": {
"i18n": "Webseite",
"dataType": "String",
"currentValue": null
},
"Name3.Customer": {
"i18n": "Zusatz 2",
"dataType": "String",
"currentValue": null
},
"DateOfOrigin.Customer": {
"i18n": "Gründung am",
"dataType": "Timestamp",
"currentValue": "1980-07-31T22:00:00+00:00"
}
},
"authenticationFields": {
"IBAN.Customer": {
"i18n": "IBAN",
"dataType": "String",
"currentValue": "DE51513500250082400323"
},
"Birth.Customer": {
"i18n": "Geburtsdatum",
"dataType": "Timestamp",
"currentValue": "1980-08-01"
},
"Mobilphone.Customer": {
"i18n": "Mobilfunknummer",
"dataType": "String",
"currentValue": null
},
"Anticipated.Customer": {
"i18n": "Abschlag",
"dataType": "Double",
"currentValue": 47.9
},
"Invoice.Customer": {
"i18n": "Rechnung",
"dataType": "String",
"currentValue": "150,99"
},
"MeterNumber.Customer": {
"i18n": "Zählernummer",
"dataType": "String",
"currentValue": "202203020814"
},
"ContractNo.Customer": {
"i18n": "Vertragsnummer",
"dataType": "String",
"currentValue": "202203020826"
}
},
"Name": "Latrop",
"Vorname": "Petra"
}
}
readMeterReading
POST https://server:port/rest/api/event/v1/events
{
"eventType": "de.ave.readMeterReading",
"payload": {
"customerNo": "20220328",
"meterNo": "202203020814"
}
}
Response:
{
"id": "fvvvvvu2luam51k4v4n3ebEvAr",
"status": "DONE",
"payload": {
"duration": 11,
"lastMeterValues": [
{
"value": 15873.73,
"readingDate": "2026-03-30",
"obis": "1-1:1.8.1"
},
{
"value": 2694.55,
"readingDate": "2026-03-30",
"obis": "1-1:1.8.2"
}
]
}
}
readBudgetBillingPlan
POST https://server:port/rest/api/event/v1/events
{
"eventType": "de.ave.readBudgetBillingPlan",
"payload": {
"customerNo": "20220328",
"contractNo": "202203020828"
}
}
Response:
{
"id": "g9ccpa1k4v6tpq8EvAr",
"status": "DONE",
"payload": {
"duration": 20,
"amount": 47.9,
"planNo": "202510101347",
"billingCycle": 12,
"contractNo": "202203020828"
}
}
writeCustomer
POST https://server:port/rest/api/event/v1/events
{
"eventType" : "de.ave.writeCustomer",
"payload" : {
"customerNo": "20220328",
"Website.Customer" : "www.online2.de", // Die Feldnamen können aus den DataQualityFields (readCustomer) entnommen werden
"ComposedMobilePhone.Customer" : "01234567890",
"DateOfOrigin.Customer" : "2000-01-01"
}
}
Response:
{
"id": "tosf6f1k4v53pr1EvAr",
"status": "DONE",
"payload": {
"customerValue": 5.0,
"duration": 923,
"lastName": "Latrop",
"firstName": "Petra",
"dataQualityFields": {
"CustTypeKey.Customer": {
"i18n": "Geschäftsbeziehung",
"dataType": "String",
"currentValue": "KUNDE"
},
"ComposedMobilePhone.Customer": {
"i18n": "Mobiltelefon",
"dataType": "String",
"currentValue": "01234567890"
},
"DateOfOrigin.Customer": {
"i18n": "Gründung am",
"dataType": "Timestamp",
"currentValue": "2000-01-01"
},
"KeyAccountManager.Customer": {
"i18n": "Key-Account-Manager",
"dataType": "String",
"currentValue": "ANLA@CURSOR"
},
"EmployeeOffice.Customer": {
"i18n": "Mitarb. Innendienst",
"dataType": "String",
"currentValue": "ANLA@CURSOR"
}
},
"churnscore": 44.0,
"type": "F",
"contracts": {
"202203020826": [
{
"contractNo": "202203020828",
"meterNo": "202203020814",
"medium": "Electricity"
}
]
},
"authenticationFields": {},
"customerNo": "20220328"
}
}
writeMeterReading
POST https://server:port/rest/api/event/v1/events
{
"eventType": "de.ave.writeMeterReading",
"payload": {
"customerNo": "20220328",
"meterNo": "202203020814",
"readingDate": "2026-10-15",
"meterValues" : [
{
"value": 16800.12,
"readingDate": "2026-10-15",
"obis": "1-1:1.8.1"
},
{
"value": 3443.32,
"readingDate": "2026-10-15",
"obis": "1-1:1.8.2"
}
]
}
}
Response:
{
"id": "fvvvvvu6fq8pl1k4v66e79EvAr",
"status": "DONE",
"payload": {
"duration": 690,
"meterValues": [
{
"value": 16800.12,
"readingDate": "2026-10-15",
"obis": "1-1:1.8.1"
},
{
"value": 3443.32,
"readingDate": "2026-10-15",
"obis": "1-1:1.8.2"
}
]
}
}
writeBudgetBillingPlan
POST https://server:port/rest/api/event/v1/events
{
"eventType": "de.ave.writeBudgetBillingPlan",
"payload": {
"amount": 50.32,
"planNo": "202510101347",
"contractNo": "202203020828"
}
}
Response:
{
"id": "fvvvvvuek2mbv1k4v6bnfhEvAr",
"status": "DONE",
"payload": {
"duration": 66
}
}
Liste der Fehlermeldungen (errorCodes)
|
Meldung DE |
|---|
|
Keine Kundennummer übergeben |
|
Kunde konnte nicht identifiziert werden |
|
Keine Vertragsnummer übergeben |
|
Keine Zählernummer übergeben |
|
Zählerdaten konnten nicht identifiziert werden |
|
Zählwerke nicht gefunden |
|
Keine Zählerstände übergeben |
|
Kein Abschlagsplan übergeben |
|
Abschlagsplan konnte nicht identifiziert werden |
|
Kein Betrag übergeben |
|
Die Abweichung des Abschlages zum ursprünglichen Abschlag ist zu groß. Bitte wählen Sie einen Abschlag zwischen {0} und {1} Euro. |
|
Ungültige Message-ID übergeben |
Interner Ablauf
Der Voicebot während des Gesprächs Daten aus EVI ab. Dafür werden die read… Methoden genutzt. Um Daten ins CRM zu schreiben, werden die write… Methoden verwendet. Geschriebene Daten sorgen, wie jeder andere Privatkunden-Prozess auch, dafür, dass Events gestartet werden, um die erfassten Daten ggf. in Drittsysteme zu verteilen.