Rest Api Action

This help page is for Desktop Studio. This information is also available for CXone Studio.

Rest Api Action icon

Verarbeitet RESTful-API-Aufrufe synchron. Diese Aktion ermöglicht es dem System, höhere Lasten zu verarbeiten. Sie gibt sowohl den Text als auch die Kopfzeilen für den API-Aufruf zurück. Dies erleichtert Tests und Fehlerbehebung von Skripten.

Sie können ein Skript testen, das eine REST API-Aktion enthält, und Antwortinformationen anzeigen. Führen Sie das Skript dazu mit der Option Mit Trace starten aus.

Sie können synchrone RESTful-API-Aufrufe auch mithilfe der GetRestProxy()-Funktion in einer SNIPPET-Aktion durchführen. Diese Option verarbeitet hohe Lasten nicht so gut wie die REST API-Aktion. Sie ist daher nicht die bevorzugte Methode.

Diese Aktion ist eine der unterstützten Methoden zum Verbinden mit Webdiensten in einem Studio-Skript.

Dependencies

Für die Verwendung dieser Aktion gelten Einschränkungen, die auf Ebene der GeschäftseinheitGeschlossen Eine übergeordnete organisatorische Gruppierung, die Sie für die technische Unterstützung und Abrechnung und außerdem zur Bearbeitung von globalen Einstellungen in Ihrer CXone Umgebung einsetzen können. auferlegt werden. Damit sollen gegenseitige Auswirkungen vermieden werden. Die Einschränkungen innerhalb der Plattform sind:

  • Antwortformat: Nur das JSON-Antwortformat wird unterstützt.
  • Neuversuche bei Fehler: Der Aktionshandler unternimmt automatisch zwei Versuche, wenn eine Fehlermeldung empfangen wird, bevor die Antwort zurückgegeben wird.
  • Zeitüberschreitung: Sie geben den Zeitüberschreitungswert in der Anfrage an. Der Wert kann nicht mehr als 90 Sekunden betragen.
  • Max. Antwortgröße: Die maximale Antwortgröße beträgt 32 KB. Dies entspricht der bestehenden Snippet-Funktion. Wenn dieser Grenzwert erreicht wird, müssen Sie die Größe der zurückgegebenen Daten reduzieren.
  • Drosselungsgrenzwert: Der Drosselungsgrenzwert wird durch zwei Parameter definiert:
    • Max. gleichzeitige Anfragen: Standardmäßig sind bis zu 100 Anfragen gleichzeitig erlaubt. Dieser Grenzwert gilt für alle CXone-Kunden. Dies bedeutet, dass 100 gleichzeitige Anfragen zu einem viel höheren Durchsatz führen als API-Aufrufe von einer Snippet-Aktion. Wenn Sie mehr als 100 gleichzeitige Anfragen benötigen, sprechen Sie mit Ihrem CXone Account Representative über eine Erhöhung des Grenzwerts für Ihre Geschäftseinheit. Es sind Sondergenehmigungen erforderlich.
    • Anzahl in Warteschleife: Wenn Anfragen den Grenzwert übersteigen, werden die überzähligen Anfragen in eine Verarbeitungswarteschleife gestellt. Sobald Anfragen unter den Grenzwert sinken, werden Anfragen in der Warteschleife wieder verarbeitet.
  • Sicherung: Wenn Ihre angegebene URL ausgefallen oder nicht erreichbar ist, erhalten Sie möglicherweise zu viele Fehler bei Ihren Anfragen. In diesem Fall reduziert CXone vorübergehend die Ausführung aller Anfragen für ALLE URLs von der REST API-Aktion. So kann Ihre angegebene URL aus dem Fehlerzustand wiederhergestellt werden. Die Grenzwerte sind unten angegeben:
    • Back-Off-Zeit oder Pausenzeit: Wenn die Fehlerrate erreicht ist, werden 30 Sekunden lang keine Anfragen mehr von der REST API-Aktion ausgeführt.
    • Mindestdurchsatz: 100 Anfragen pro Sekunde. Wenn Ihre Geschäftseinheit die Mindestanzahl an Anfragen nicht ausführt, werden Ihre Anfragen weiter ausgeführt, obwohl die Anfragen fehlschlagen.
    • Fehlerrate: Wenn 50 % der Anfragen innerhalb von 30 Sekunden fehlschlagen, werden Ihre Anfragen in den folgenden 30 Sekunden nicht ausgeführt. 30 Sekunden ist ein rollendes Fenster.

Für diese Aktion gelten die folgenden weiteren Abhängigkeiten:

  • Nur JSON wird als Antwortformat unterstützt. Die Aktion erfordert, dass sich der gesamte JSON-Code auf einer einzelnen Zeile befindet. Bei Verwendung von JSON in dieser Aktion haben Sie folgende Möglichkeiten:

    • Führen Sie eine Variablenersetzung für einen String aus, der JSON enthält.
    • Das Konvertieren eines dynamischen Datenobjekts in JSON wird mit der Funktion asjson() unterstützt. Beachten Sie, dass asjson() alles als String handhabt. Deshalb sind einige Änderungen erforderlich, wenn Sie mit booleschen oder numerischen Werten arbeiten.
    • Übergeben Sie auch die Ausgabevariable resultSet(out) von einer früheren REST-API-Aktion an diese Eigenschaft.
  • Antworten werden als jtoken-Objekte zurückgegeben. Sie können sie in Ihrem Skript genauso verwenden wie dynamische Datenobjekte.
  • Antworten enthalten Kopfzeilen und den Haupttext der Antwort. Sie können auch HTTP-Statuscodes enthalten. Nicht alle Antworten enthalten Statuscodes. Wenn kein Fehler auftritt, wenn die REST API-Aktion keine gültige Antwort generieren kann oder wenn der zurückgegebene Fehler nicht als gültige Antwort geparst werden kann, wird kein Status eingeschlossen.
  • Sie können mehr als eine REST API-Aktion in einem Skript verwenden, aber sie können nicht beide auf dieselben Objekte verweisen.

Input Properties

Diese Eigenschaften definieren Daten, die von der Aktion bei der Ausführung verwendet werden.

Eigenschaft

Beschreibung

Caption

Geben Sie eine kurze Phrase ein, mit der diese Aktion im Skript eindeutig identifiziert wird. Die Beschriftung wird im Skript-Arbeitsbereich unter dem Symbol der Aktion angezeigt. The default is the action name.

Verb

Unterstützt grundlegende REST-Aktionen wie GET, PUT, POST, DELETE und PATCH.

Parameters

Hiermit können Sie Abfrageparameter angeben oder beliebige Daten senden. Viele JSON-Elemente werden akzeptiert, wie Jobject, Jarray oder Jtoken.

Headers

Bietet Ihnen die Möglichkeit, benutzerdefinierte Kopfzeilen hinzuzufügen, um die Kundenauthentifizierung zu ermöglichen, z. B. Bearertoken. In diesem Feld können Sie JSON verwenden.

Wichtig Wenn für Ihren benutzerdefinierten URL-Endpunkt unterschiedliche Header erforderlich sind, muss er in dieser Eigenschaft angegeben werden. Um die Funktionsparität mit der vorhandenen Snippet-Aktion beizubehalten, fügt CXone die folgenden Kopfzeilen hinzu:

{"Accept":"application/json", "Content-Type" :"application/x-www-form-urlencoded"}

Command

Derzeit ist die einzige Option MakeRestRequest. Dies funktioniert genauso wie die Funktion MakeRestRequest(), die bei einem REST-API-Aufruf in einer Snippet-Aktion verwendet wird.

TimeOutInMilliSeconds

Ermöglicht die Angabe und Berücksichtigung eines Timeouts des REST-Aufrufs. Muss kleiner als 90 Sekunden (90.000 Millisekunden) sein. Wenn kein Timeout angegeben ist, ist die Standardeinstellung 10 Sekunden (10.000 Millisekunden).

Service Address

Die URL der REST-API, die die Aktion aufrufen soll. Mit dieser Eigenschaft können Sie die Variablenersetzung verwenden.

Ausgabeeigenschaften

Diese Eigenschaften enthalten Variablen mit Daten, die bei der Ausführung der Aktion zurückgegeben werden. Sie stehen zu Referenzzwecken und zur Verwendung nach Abschluss der Aktion zur Verfügung.

Eigenschaft

Beschreibung

resultSet(out)

Eine Variable, die Informationen enthält, die von der in Dienstadresse angegebenen API zurückgegeben wurden. Sie können den Inhalt dieser Variablen unverändert an die Kopfzeile und die Parameter übergeben, sofern erforderlich. Die Antwort wird als Jtoken-Objekt zurückgegeben. Sie können sie aber auch als dynamisches Objekt deklarieren und wie jedes andere dynamische Objekt in Ihrem Skript verwenden.

errorArgList(out)

Ein dynamisches Datenobjekt, das Informationen über aufgetretene Fehler enthält. Wenn ein Fehler auftritt, enthält das Objekt den HTTP-Statuscode, die Statusbeschreibung und eine Fehlermeldung. Wenn kein Fehler vorliegt, ist das Objekt leer.

HTTP-Statuscodes und Beschreibungen werden nur im Fehler zurückgegeben, wenn sie als gültige Antwort geparst werden können. Das bedeutet, dass nicht alle Fehler einen HTTP-Antwortcode enthalten.

Bedingungen für Ergebnisverzweigungen

Mit Bedingungen für Ergebnisverzweigungen können Sie in Ihrem Skript Verzweigungen erstellen, die für unterschiedliche Ergebnisse bei der Ausführung einer Aktion vorgesehen sind.

Bedingung

Beschreibung

Throttle

Genommener Pfad, wenn zu viele Anforderungen innerhalb kurzer Zeit ausgeführt werden. Weitere Informationen finden Sie in den folgenden Einschränkungen.

InvalidInput

Genommener Pfad, wenn eine ungültige Eingabe gefunden wird oder ein Timeout-Fehler auftritt. Jeder Parameter wird beim Speichern des Skripts überprüft.

Failure

Genommener Pfad, wenn ein Fehler oder eine Ausnahme innerhalb der NICE CXone auftritt, die die Anforderung ausführt.Anwendung

Error

Genommener Pfad, wenn der Remote-Kundenendpunkt einen http-Fehlercode zurückgibt.

Default

Genommener Pfad, wenn die Antwort nicht innerhalb von 90 Sekunden empfangen wird.

Success

Verwendeter Pfad, wenn die Aktion ohne Fehler abgeschlossen wurde und alle API-Aufrufe oder Datenrückgaben erfolgreich waren (2xx Antwortcodes).

Other Options

Sie können externe RESTful API-Anfragen ersetzen, die derzeit in der Snippetaction- ausgeführt werden.