Hinzufügen benutzerdefinierter Funktionen zur Rainbow-Anwendung (custo-manifest)

language Dieser Artikel wurde automatisch übersetzt. Siehe die Referenzversion auf Englisch.

Mit diesem Artikel können Sie Rainbow-Anwendungen mithilfe einer Reihe von Aktionen, die aus einer custo-manifest.json Datei konfiguriert werden können, individuelle Funktionen hinzufügen.

Die verfügbaren Aktionen sind:

• Aktionen, die automatisch nach Ereignissen ausgelöst werden:
  • on-incoming-pbx-call-actions: um eine Aktion auszuführen, wenn ein Anruf eingeht
  • on-answering-incoming-pbx-call-actions: zum Ausführen einer Aktion, wenn ein eingehender Anruf angenommen wird
  • on-releasing-incoming-pbx-call-actions: um eine Aktion auszuführen, wenn ein eingehender Anruf beendet wird

Bei eingehenden Anrufen können die Aktionen ein Skript, eine Anwendung oder eine Webseite mit Informationen über den eingehenden Anruf starten.

• Aktionen, die über eine Schaltfläche ausgelöst werden:
  • on-incoming-pbx-call-button-actions: zum Ausführen einer Aktion durch Klicken auf eine Schaltfläche, die im Popup-Fenster für eingehende Anrufe hinzugefügt wurde
  • on-call-log-list-actions: um eine Aktion auszuführen, indem Sie auf eine Schaltfläche klicken, die in jedem Element des Anrufprotokolls eingefügt ist
  • on-contact-list-actions: um eine Aktion auszuführen, indem Sie auf eine Schaltfläche klicken, die in jedem Element der Kontakte eingefügt ist
  • on-contact-detail-actions: um eine Aktion auszuführen, indem Sie auf eine Schaltfläche klicken, die im Detailbereich der Kontakte eingefügt ist
  • on-communication-card-actions: um eine Aktion auszuführen, indem Sie auf ein Menü in der Leiste des Anrufmanagers klicken.

Durch Anklicken von Schaltflächen können Aktionen Popup-Fenster öffnen, in denen Sie Kontakten oder Diensten per E-Mail beitreten können.

• Aktionen mit automatischer Informationsanzeige:
  • on-incoming-pbx-call-display-actions: zum Einfügen von Informationen in das Popup-Fenster für eingehende Anrufe
  • on-contact-card-display-actions: zum Einfügen von Informationen in den Detailbereich des Kontakts

Diese Aktionen werden über die Datei custo-manifest.json konfiguriert, die in der Rainbow-Anwendung verfügbar ist.

Die Konfiguration besteht in:

1. Exportieren der Datei custo-manifest.json auf den Computer
2. Bearbeiten und Vervollständigen der Datei custo-manifest.json
3. Importieren der Datei custo-manifest.json in die Rainbow-Anwendung

Die Konfiguration gilt nur für Rainbow Anwendungen, die auf einem Computer laufen.

Die Konfiguration muss für jede Rainbow-Anwendung durchgeführt werden.

Voraussetzung

• Für die Konfiguration der Datei custo-manifest.json benötigen Sie mindestens eine Business-, Enterprise- oder Attendant-Lizenz.

Überblick über die Datei Custo-manifest

Die custo-manifest Datei besteht aus zwei Teilen:

• Der erste Teil listet alle verfügbaren Aktionen auf und bietet für jede Aktion eine Vorlage mit den wichtigsten Parametern zum Ausfüllen.
  Beispiel:
  
• Der zweite Teil enthält eine Hilfestellung, die für die Konfiguration zu lesen ist.

Eine Aktion wird durch die folgenden Parameter definiert:

• "Name": ist ein Text, der zur Identifizierung der Aktion verwendet wird, oder die Bezeichnung der Schaltfläche für Aktionen, die eine Schaltfläche verwenden
• Für Aktionen, die eine Schaltfläche verwenden:
  • "Symbol": ist der Zugriffspfad auf das Symbol der Schaltfläche
  • "tooltip": ist der Zugriffspfad auf den Tooltip, der angezeigt wird, wenn die Maus über die Schaltfläche bewegt wird
• "Befehl": definiert die Aktion, die ausgeführt werden soll
• "url": ist der Pfad oder die URL für den Zugriff auf die lokale Anwendung, die Webseite oder die REST-API
  Hinweis: Der Backslash muss im Zugriffspfad zur lokalen Anwendung (z.B. C:\\MicroCRM\\MicroCRM.exe) doppelt vorkommen.
• "params": ist ein String mit Variablen ${xx}, die bei der Ausführung der Aktion durch ihren Wert ersetzt werden
• "commandType": gibt den Typ der Aktion an:
  • "keine": startet eine lokale Anwendung oder eine Webseite (wenn die URL mit 'http' oder 'https' beginnt)
  • "rest": führt einen REST-API-Anruf aus
  • "Datei": holt den Inhalt der Datei, die geholt werden soll (hauptsächlich für die Debugger-Abstimmung)
• "responseType: definiert den Typ des Inhalts, der von der Aktion zurückgegeben wird: "markdown", "json" oder "adaptiveCard"

  Wenn auf "json" gesetzt, dann:

  • "displayJsonField": definiert das Feld, dessen Wert der anzuzeigende Inhalt ist
  • "firstNameJsonField": definiert das Feld, dessen Wert den Vornamen des Anrufers ersetzen muss
  • "lastNameJsonField"lastNameJsonField": Definiert das Feld, dessen Wert den Nachnamen des Anrufers ersetzen muss.
  • "companyJsonField": definiert das Feld, dessen Wert den Namen der Firma des Anrufers ersetzen soll

  Wenn auf "adaptiveCard" gesetzt, dann:

  • "adaptiveCardTemplateJsonField": definiert die Vorlage der adaptiven Karte, die angezeigt werden soll
  • "adaptiveCardContentJsonField": definiert den Inhalt der anzuzeigenden adaptiven Karte

Zusätzliche Parameter sind verfügbar:

• "AnswerOnClick": Wenn dieser Parameter auf true gesetzt ist, wird die Aktion ausgeführt und der eingehende Anruf gleichzeitig beantwortet (nur für die Aktion on-incoming-pbx-call-button actions )
• "filtern": bei Einstellung auf "NoShortNumber"wird das Ereignis nicht ausgelöst, wenn die Nummer des Anrufers eine kurze Nummer ist.
• "RaiseChangeCall": Hier können Sie das Verhalten bei einem weitergeleiteten Anruf konfigurieren:
  • false: nur direkte Anrufe an den Benutzer lösen das Ereignis aus
  • true: das Ereignis wird für direkte Anrufe an den Benutzer und auch für Anrufe, die an diesen Benutzer weitergeleitet wurden, ausgelöst
  • only: nur übertragene Anrufe an den Benutzer lösen das Ereignis aus

Die Aktionsvorlage kann Variablen ${xx} enthalten, die im Feld "url", "params" und "bodyParameter" (für REST API) Parameter. Sie werden durch ihren Wert ersetzt, wenn die Aktion ausgeführt wird.

Exportieren der Datei "custo-manifest" auf den Computer

1. Klicken Sie in der Rainbow Administrationsoberfläche auf den Avatar im linken Bereich und dann auf das Menü Einstellungen.
2. Wählen Sie im linken Menü die Option Telefonie.
   Das Fenster Einstellungen - Telefoniekonfiguration wird geöffnet.
3. Erweitern Sie das Fenster bis zum Abschnitt CUSTOMIZATION.
4. Klicken Sie auf Datei exportieren und verwenden Sie den Browser, um die Datei custo-manifest auf den Computer zu exportieren.
5. Klicken Sie auf Schließen, um das Fenster Telefonie-Einstellungen zu verlassen.

Lokale Konfiguration der custo-manifest Datei

1. Öffnen Sie die custo-manifest Datei mit einem Texteditor.
2. Konfigurieren Sie die Parameter der zu verwendenden Aktionen.
   Achtung: Löschen Sie nicht den Raum zwischen den doppelten Anführungszeichen für die nicht verwendeten Parameter ("name": " ", "url": " ", "params": " "), sonst wird die importierte Datei nicht berücksichtigt.
3. Entfernen Sie die Parameter aller nicht verwendeten Aktionen.
4. Speichern Sie die Datei custo-manifest.

Importieren der Datei custo-manifest in die Rainbow-Anwendung

1. Klicken Sie in der Rainbow-Verwaltungsoberfläche auf den Avatar im linken Bereich und dann auf das Menü Einstellungen.
2. Wählen Sie im linken Menü die Option Telefonie.
   Das Fenster Einstellungen - Telefoniekonfiguration wird geöffnet.
3. Erweitern Sie das Fenster bis zum Abschnitt CUSTOMIZATION.
4. Klicken Sie auf Datei importieren und verwenden Sie den Browser, um die Datei custo-manifest in der Rainbow Anwendung auszuwählen und zu importieren.
5. Klicken Sie auf Schließen, um das Fenster Telefonie-Einstellungen zu verlassen.

Beispiele für die Konfiguration

Führen Sie eine Anwendung oder ein Skript mit Parametern aus

Beispiel 1:

Die Aktion on-incoming-pbx-call-actions führt eine Anwendung (z.B. MicroCrm) mit einem Parameter aus 'params' aus (keine Rückgabe).

"Version": "2",
"extension-points": {
"on-incoming-pbx-call-actions": [ { "name": "Exec CRM", "Befehl": { "url": "C:\\MyApp\\CustoApp\\MicroCRM.exe", "params": "-number ${caller.phoneNumber}" } ],

Beispiel 2:

Die Aktion on-incoming-pbx-call-actions führt ein Skript (*.bat) mit Parametern aus 'params' aus (keine Rückgabe).

"version": "2",
"extension-points": {
"on-incoming-pbx-call-actions": [ { "name": "BatScript", "Befehl": { "url": "C:\\MyApp\\MyApp.bat", "params": "IN-COMING canNr:${localUser.canonicalNumber} userIntNr:$"{localUser.internalNumber} caller[Nr:${calle.phoneNumber} FN:${caller.firstName} LN:${caller.lastName} .... CorData:[${call.correlatorData Hex:${call.hexCorrelatorData]" }   
  } ],

Öffnen Sie eine Webseite mit Parametern

Beispiel 1:

Die Aktion on-incoming-pbx-call-actions öffnet eine Webseite mit Parametern aus 'params' (keine Rückgabe).

"Version": "2",
"extension-points": {
"on-incoming-pbx-call-actions": [ { "name": "Gelbe Seiten", "command": { "url":"https://www.pagesjaunes.fr/annuaireinverse/recherche",
 "params": "quoiqui=${caller.phoneNumber}&proximite=0"
 }
 }
],

Beispiel 2:

Die Aktion on-incoming-pbx-call-actions öffnet eine Webseite mit Parametern direkt in der URL (kein Return).

"Version": "2",
"extension-points": {
"on-incoming-pbx-call-actions": [ { "name": "Kontakt popup", "command": { "url":"http://localhost:3000/contactShow?phone=${caller.phoneNumber}",
 "params": " "
 }
 }
],

Ausführen eines REST API Anrufs mit Parametern

Beispiel 1:

Wenn ein eingehender Anruf freigegeben wird, erstellt die Aktion on-releasing-incoming-pbx-call-actions ein END-Anrufprotokoll in REST mit der GET-Methode und den Parametern aus "params" (keine Rückgabe).

"version": "2",
"extension-points": {
"on-releasing-incoming-pbx-call-actions": [ { "name": "GetRestApi", "command": {
 "commandType": "rest",
 "method": "GET", "url":"http://localhost:3000/IncidentManager/CreateCallLog",
 "params": "byEmail=${localUser.email}&CustomerContact=${caller.phonenumber}"
 }
 }
],

Beispiel 2:

Wenn ein eingehender Anruf freigegeben wird, erstellt die Aktion on-releasing-incoming-pbx-call-actions ein END-Anrufprotokoll in REST mit der POST-Methode und den Parametern von "bodyParameters" (keine Rückgabe).

"version": "2",
"extension-points": {
"on-releasing-incoming-pbx-call-actions": [
 {
 "name": "PostRestApi",
 "command": {
 "commandType": "rest",
 "method": "POST",
 "url":"http://localhost:3000/IncidentManager/EndCallLog",
 "params": " "
 },
 "bodyParameters": {
 "caller": "${contact.phoneNumber}",
 "Benutzer": "${localUser.email}",
 }
],