REST Query

Dieser Node Typ wird verwendet, um eine beliebige HTTP Anfrage an einen externen HTTP Server zu senden. Er kann z.B. verwendet werden, um Details aus einem externen CRM-System abzurufen oder um ein externes System zu informieren, dass ein Call eingegangen ist.

Dieser Node ermöglicht es beispielsweise, externen Systemen Informationen über Calls des Contact Centers zu übermitteln, wie z.B. einzelne Kundeninteraktionen, Statistiken usw. für Überwachungs-, Konfigurations- und Datenanalysezwecke.

Wenn der Replace Placeholders Parameter auf true eingestellt wird, ersetzt das System alle im Textkörper gefundenen Platzhalter durch die entsprechenden Werte, wenn die Anfrage gesendet wird. Unterstützte Platzhalter sind: ##agentExternalId##, ##agentUsername##, ##event##, ##queueName## und ##time##. Der Einfachheit halber kann ein Simple JSON Node verwendet werden, um einen JSON String zu erstellen, der diese Platzhalter als Werte enthält. Diese Platzhalter werden wie folgt ersetzt:

  • ##agentExternalId## – wird durch den Wert der External ID ersetzt, wie er für das Benutzerkonto eines Agenten im Administrator-Portal konfiguriert ist.
  • ##agentUsername## – wird durch den Benutzernamen des Agenten ersetzt, der angerufen wird.
  • ##event## – wird durch eine der folgenden Zeichenketten ersetzt: AGENT_RINGING, AGENT_ANSWERED, TRANSFER_RINGING, oder TRANSFER_ANSWERED
  • ##queueName## – ersetzt durch den Namen der Warteschleife, in der sich der aktuelle Call befindet, oder, im Falle einer Weiterleitung in einer Warteschleife, durch den Namen der Zielwarteschleife
  • ##time## – wird durch eine String im ISO 8601-kompatiblen Format ersetzt.


Bei Bedarf können Sie die Kopfzeile beim Senden einer HTTP Anfrage ändern (z.B. für Authentifizierungszwecke) und zusätzliche Kopfzeilen hinzufügen. Wenn die Antwort auf die REST Abfrage einen JSON Körper enthält, ermöglicht der Node Typ das Auslesen bestimmter Teile dieser Daten in bereitgestellte Variablen.

Hinweis: Im Gegensatz zum Node Prepare REST Request sendet dieser Node Typ die HTTP-Anfrage sofort.

Hinweis: Bei Bedarf können einige der Parameter für diesen Node Typ auf user configurable eingestellt werden, so dass sie von einem Unternehmensadministrator festgelegte Werte annehmen können.

Die folgenden Parameter können eingestellt werden:

ParameterWie viele?TypBeschreibung
URL1StringDie URL für die HTTP Anfrage.

Parameter als user configurable möglich.
Body1StringDer Körper der Outbound HTTP Anfrage.

Parameter als user configurable möglich.
Content Type1EnumEiner von JSON, TEXT/PLAIN oder TEXT/HTML
Replace Placeholders0 oder 1BooleanOb die Auswahl der Platzhalter beim Senden der HTTP Anfrage im Body der HTTP-Anfrage ersetzt werden oder nicht.

Die Platzhalter sind oben definiert.

Parameter als user configurable möglich.
Method1EnumDie HTTP Methode die für diese Anfrage verwendet wird. Einer der folgenden: POST, GET, DELETE or PUT.

Hinweis: Wenn die HTTP Methode auf GET eingestellt ist, wird der Body Parameter weggelassen.
Request Headers0 bis 50Optionale Kopfzeile für die HTTP Anfrage.
Name0 oder 1StringDer Name der Kopfzeile in der HTTP Anfrage.

Parameter als user configurable möglich.
Value0 oder 1StringDer Wert der der Kopfzeile zugeteilt wird.

Parameter als user configurable möglich.
Response DataOptionale Werte für verschiedene Parametertypen, die in einem JSON-Antwortkörper festgelegt werden können. Wenn die HTTP-Antwort einen JSON-Body enthält, können mit diesen optionalen Parametern Teile dieser JSON-Daten in die bereitgestellten Variablen eingelesen werden.
Integer Parameters0 bis 50
Variable0 oder 1IntegerDie Variable, in der der abgelesene Wert gepeichert werden soll.
Path0 oder 1StringDer Pfad des zu lesenden Wertes.

Parameter als user configurable möglich.
Default0 oder 1IntegerDer Wert, der in die Variable geschrieben werden soll, wenn unter dem angegebenen Pfad kein Wert gefunden wird.

Parameter als user configurable möglich.
Float Parameters0 bis 50
Variable0 oder 1FloatDie Variable, in der der abgelesene Wert gepeichert werden soll.
Path0 oder 1StringDer Pfad des zu lesenden Wertes.

Parameter als user configurable möglich.
Default0 oder 1FloatDer Wert, der in die Variable geschrieben werden soll, wenn unter dem angegebenen Pfad kein Wert gefunden wird.

Parameter als user configurable möglich.
String Parameters0 bis 50
Variable0 oder 1StringDie Variable, in der der abgelesene Wert gepeichert werden soll.
Path0 oder 1StringDer Pfad des zu lesenden Wertes.

Parameter als user configurable möglich.
Default0 oder 1StringDer Wert, der in die Variable geschrieben werden soll, wenn unter dem angegebenen Pfad kein Wert gefunden wird.

Parameter als user configurable möglich.
Boolean Parameters0 bis 50
Variable0 oder 1BooleanDie Variable, in der der abgelesene Wert gepeichert werden soll.
Path 0 oder 1StringDer Pfad des zu lesenden Wertes.

Parameter als user configurable möglich.
Default0 oder 1BooleanDer Wert, der in die Variable geschrieben werden soll, wenn unter dem angegebenen Pfad kein Wert gefunden wird.

Parameter als user configurable möglich.


Hinweis: Wenn der externe HTTP Server keinen Wert zurückgibt oder wenn der Typ des zurückgegebenen Wertes nicht mit dem Typ der Call-Flow-Variablen kompatibel ist (z.B. wenn der Server die Zeichenkette „Hallo“ im Antwortkörper in einem Pfad zurückgibt, der einem booleschen Parameter zugeordnet ist), wird der Wert des Standardparameters verwendet und der nächste Zweig genommen.

Die folgenden Verzweigungen können eingestellt werden:

VerzweigungWie viele?Beschreibung
Next1Die Verzweigung wird genoommen, wenn die HTTP Anfrage erfolgreich ist.
Failes1Die Verzweigung wird genoommen, wenn die HTTP Anfrage fehlschlägt. Dies wird durch einen Antwortcode angezeigt, welcher zwischen 400 und 599 liegt.


Beispiel für die Verwendung des JSON-Pfads

Eine HTTP REST Anfrage wird an einen externen HTTP-Server gesendet, der das folgende JSON zurückgibt:



Auf Grundlage der obigen Daten würden die folgenden Pfade dazu führen, dass die folgenden Werte in die angegebene Variable geschrieben werden:

PfadTypWert
result.successBooleantrue
result.details.messageStringSuccess
data.0.nameStringAlice
Data.1.ageInteger47

Diese Daten werden dann an einen Compare String Node weitergegeben, der den Call entsprechend weiterleitet.

War dieser Artikel hilfreich?

vorheriger Artikel

Simple JSON

nächster Artikel

Prepare REST Request