Inhalt

Einführung

Voraussetzungen

Anforderungen

Verwendete Komponenten

Hintergrundinformationen

Konfigurieren

Abschnitt "Anfrage"

Antwortabschnitt

Überprüfen

Fehlerbehebung

Zugehörige Informationen

Einführung

In diesem Dokument werden die Schritte zum Senden von API-Anfragen (Application Programming Interface) über das Befehlsausführungsfenster SPOG (Package Contact Center Enterprise (PCCE) Single Pane of Glass) beschrieben.

Unterstützt von Ramiro Amaya und Anuj Bhatia, Cisco TAC Engineer und Shilpa Jayashekar, Cisco Engeneering.

Voraussetzungen

Anforderungen

Cisco empfiehlt, dass Sie über Kenntnisse im Bereich Cisco Paket Contact Center Enterprise

Verwendete Komponenten

Die in diesem Dokument verwendeten Informationen basieren auf der PCCE 12.5(1)-Version.

Die Informationen in diesem Dokument wurden von den Geräten in einer bestimmten Laborumgebung erstellt. Alle in diesem Dokument verwendeten Geräte haben mit einer leeren (Standard-)Konfiguration begonnen. Wenn Ihr Netzwerk in Betrieb ist, stellen Sie sicher, dass Sie die potenziellen Auswirkungen aller Schritte verstehen.

Hintergrundinformationen

Das Befehlsausführungsfenster bietet eine REST-Client-Schnittstelle in der Unified Contact Center Enterprise (CCE)-Verwaltung. In diesem Bereich können Systemadministratoren:

- Führen Sie REST-API-Anrufe beim Unified Customer Voice Portal (CVP), beim Unified CVP Reporting und beim Cisco Virtualized Voice Browser (CVVB) über die zentrale Oberfläche der Unified CCE Administration aus.

- Konfigurieren Sie Funktionen wie Customer Virtual Assistant (CVA), die in den neuesten Versionen von Packaged CCE verfügbar sind, ohne dass Packaged CCE-Komponenten aktualisiert werden müssen. Beispielsweise kann die CVA-Funktion (verfügbar in 12.5) mithilfe des Befehls Execution Pane von Packaged CCE 12.0 ES 37 konfiguriert werden, vorausgesetzt, die VVBs werden auf 12.5 aktualisiert.

Konfigurieren

Nur Systemadministrator hat Zugriff auf das Befehlsausführungsfenster.

Wenn Sie sich als Systemadministrator anmelden, können Sie über Infrastruktureinstellungen (Karte) > Befehlsausführungsfenster auf das Befehlsausführungsfenster zugreifen.

Hinweis: Systemadministrator ist eine Rolle, die Zugriff auf alle Funktionen hat. Wählen Sie in CCE Administration (CCE-Verwaltung) Benutzer > Roles > SystemAdmin (Die Administratoren, denen diese Rolle zugewiesen ist, können auf alle Funktionen und Unterfunktionen zugreifen).

Diese Seite enthält zwei Abschnitte: Anfrage und Antwort.

Abschnitt "Anfrage"

Der Abschnitt Request enthält folgende Eigenschaften:

1. Maschinentyp: Der Computertyp, für den der Benutzer die API-Anforderung ausführen möchte.

2. Website: Die Site, für die die API ausgeführt werden muss. Wenn Sie Computertyp auswählen, werden standardmäßig Alle Standorte ausgewählt.

3. Hosts: Der Host, für den API ausgeführt werden muss. Alle Hosts sind standardmäßig ausgewählt.  Wenn keine Hosts verfügbar sind, wird die entsprechende Meldung angezeigt.

4. Methode: Ausgewählte Methode: GET, POST, PUT und LÖSCHEN sind die Optionen.

5. Pfad: Der relative Pfad der auszuführenden API.

6. Anforderungstext: Die Nutzlast für die API-Anfrage ist hier verfügbar. Der unterstützte Inhaltstyp ist ab sofort JSON.

Hinweis: Für POST und PUT ist der Request Body obligatorisch.

7. Inhaltstyp: JSON- und XML-Inhaltstyp werden unterstützt.

8. Antworttyp: Wählen Sie den Typ der erwarteten Antwort aus. Der Standardwert ist JSON. XML ist die andere Option.

9. Ausführung: Führt die Anforderung aus. Sie wird aktiviert, sobald alle Pflichtfelder ausgefüllt sind.

Antwortabschnitt

Der Abschnitt Response enthält folgende Eigenschaften:

1. Ergebnisfilter: Filtern Sie die Ergebnisse, um entweder Erfolgs- oder Fehlerantworten anzuzeigen.

2. Ergebnisdetails: Sie enthält die Liste der Hostnamen und die Antwort des ausgewählten Hostnamens.

3. Zurücksetzen: Dadurch werden alle Eigenschaften auf dem Bildschirm auf ihre Standardwerte zurückgesetzt.

Überprüfen

Sie können diese Beispiele verwenden, um die Ergebnisse des Befehlsausführungsbereichs zu überprüfen.

Beispiel 1: Erstellen eines Servicekontos auf Cisco VVB

Füllen Sie die Anforderungsparameter wie im Bild gezeigt aus, und klicken Sie auf Ausführen.

Beispiel 2: Abrufen eines Servicekontos für Cisco VVB, erstellt in Beispiel 1

Füllen Sie die Anforderungsparameter wie im Bild gezeigt aus. und klicke auf "Ausführen". Sie sollten eine Erfolgsantwort erhalten, wie im Bild gezeigt.

Pfad: speechconfig/rest/config/tts/serviceaccount/newServiceAccount.

Beispiel 3: Aktualisieren eines Dienstkontos auf Cisco VVB, erstellt in Beispiel 1

Füllen Sie die Request-Parameter wie im Bild gezeigt aus. und klicke auf "Ausführen".

Pfad: speechconfig/rest/config/tts/serviceaccount/newServiceAccount.

Hinweis: Die Beschreibung wird in dieser API-PUT-Anforderung aktualisiert.

Beispiel 4: Löschen Sie ein Dienstkonto auf Cisco VVB, erstellt in Beispiel 1

Füllen Sie die Request-Parameter wie im Bild gezeigt aus. und klicke auf "Ausführen".

Pfad: speechconfig/rest/config/tts/serviceaccount/newServiceAccount.

Fehlerbehebung

Tomcat protokolliert c:\icm\tomcat\logs\CCBU.<timestamp> werden zur Fehlerbehebung bei allen API-Anfragen aus dem Befehlsausführungsbereich in SPOG benötigt.

Zugehörige Informationen

PCCE-Administrationsleitfaden

Technischer Support und Dokumentation - Cisco Systems