API-Framework-Aktionen

API-Framework-Aktionen sind Studio-Aktionen, die es Ihnen ermöglichen, CXone-APIs in Ihren Skripten zu verwenden. Sie können die Aktion verwenden, anstatt die API mit traditionellen Integrationsmethoden aufzurufen, beispielsweise mit einem Snippet oder mit der RestAPI -Aktion. Alle API-Aktionen befinden sich auf der Registerkarte "Framework" in Studio.

Die API-Aktionen unterscheiden sich von den standardmäßigen Studio-Aktionen. Sie sind derzeit nicht in der Online-Hilfe dokumentiert. Die APIs, die den API-Aktionen entsprechen, sind jedoch im Entwickler-Portal von CXone dokumentiert. Sie können diese Dokumentation verwenden, wenn Sie mit API-Aktionen in Ihren Skripten arbeiten.

Nicht für jede CXone-API ist eine entsprechende API-Aktion in Studio verfügbar.

Versionen der API-Aktionen

Wenn neue Versionen der CXone-APIs veröffentlicht werden, werden möglicherweise auch neue Versionen der entsprechenden Aktionen in Studio veröffentlicht. Allgemein empfiehlt es sich, immer die neueste Version der Aktion zu verwenden. In den meisten Fällen funktionieren auch noch die älteren Versionen. Sie können die verschiedenen Versionen ausprobieren, um festzustellen, welche funktionieren und die benötigte Funktionalität bieten.

Bei einigen API-Aktionen ist die Version im Namen der Aktion enthalten. Sie ist in der hierarchischen Aktionsstruktur auf der Registerkarte "Framework" zu sehen. Nicht alle API-Aktionen enthalten die Versionsnummer. Bei diesen Aktionen finden Sie die Version in den erweiterten Eigenschaften der Aktion. Die erweiterten Eigenschaften werden nur auf der Registerkarte "Eigenschaften" angezeigt, wenn die Aktion auf der Registerkarte "Framework" ausgewählt ist.

Nicht für jede Version jeder API ist eine entsprechende Aktion in Studio verfügbar.

Erweiterte Eigenschaften für API-Aktionen anzeigen

1. Zunächst müssen Sie die Registerkarten in Studioso neu anordnen, dass die Registerkarte "Eigenschaften" und die Registerkarte "Framework" beide gleichzeitig sichtbar sind.
2. Klicken Sie auf der Registerkarte "Framework" auf eine API-Aktion.
3. Auf der Registerkarte "Eigenschaften" werden nun die erweiterten Eigenschaften der Aktion angezeigt. Insbesondere die folgenden Eigenschaften geben Aufschluss über eine API-Aktion:
   • Verschiedenes > Parameter > Verb: Diese Eigenschaft zeigt die Methode, die zur Aktion gehört (das Verb).
   • Verschiedenes > Parameter > Version: Diese Eigenschaft zeigt die Version der API.
   • Verschiedenes > Web > URI: Diese Eigenschaft hilft Ihnen, die API-Dokumentation im Entwicklerportal zu finden.

   • Verschiedenes > Parameter: Im Bereich "Parameter" können Sie die Eigenschaften erweitern, um zusätzliche Informationen über die einzelnen Eigenschaften der Aktion anzuzeigen.

     Bild anzeigen

     

Auffinden der API-Dokumentation

CXone-APIs sind im CXone-Entwicklerportal dokumentiert. API-Aktionen in Studio haben keinen Direktlink zur Dokumention der entsprechenden APIs. In den erweiterten Eigenschaften der Aktion finden Sie jedoch Informationen, die beim Auffinden der Dokumentation hilfreich sind.

Zum Verwenden des URI sind allgemeine Kenntnisse des CXone-Systems insgesamt und der einzelnen CXone-APIs erforderlich. Diese Kenntnisse sind erforderlich, da nicht immer einfach ersichtlich ist, welche API zu einer Aktion in Studio gehört. Wenn Sie den allgemeinen Verlauf eines Kontakts in CXone kennen, können Sie den URI einer Aktion korrekt interpretieren und die entsprechenden Hinweise auf die Struktur der API-Dokumentation im Entwicklerportal anwenden. Die Beispiele in diesem Abschnitt zeigen, welche Elemente möglicherweise interpretiert werden müssen.

Auf der Startseite des API-Bereichs im Entwicklerportal finden Sie eine Übersicht über jede CXone-API.

Beispiel 1

In manchen Fällen besteht eine direkte Beziehung zwischen einer Aktion und der zugehörigen API:

• Aktion: Agent Assignments for given Skills
• URI: /services/$VERSION$/skills/agents
• API-Dokumentation : /API/AdminAPI#/Skills/getAgentsAllSkills

Der Name und der URI der Aktion weisen darauf hin, dass die ersten beiden APIs, die in Betracht gezogen werden sollten, die Agenten-API und die Admin-API sind. Wenn Sie sich die Liste der API-Aufrufe der beiden APIs ansehen, können Sie die Agenten-API ausschließen. Aus der Beschreibung geht hervor, dass diese API zum Verwalten von Agentensitzungen dient. Sie scheint keine Aufrufe in Bezug auf Skills zu haben, wie im folgenden Bild ersichtlich.

Bei der Admin-API wird gezeigt, dass sie für Systemobjekte wie Skills vorgesehen ist. Die Liste der für diese API verfügbaren API-Aufrufe umfasst Skills, wie im folgenden Bild ersichtlich.

Wenn Sie den Bereich "Skills" erweitern, ist einer der Endpunkte GET /skills/agents. Die Kurzbeschreibung für diesen Endpunkt lautet "Returns skills assignments" (Gibt Skillzuweisungen zurück).

Beispiel 2

In manchen Fällen ist der Bezug nicht offensichtlich, wie im folgenden Beispiel. In solchen Fällen müssen Sie Ihre Kenntnisse der CXone-APIs und der Plattform selbst heranziehen, um den entsprechenden API-Endpunkt zu finden. –

• Aktion: Active Contact Details
• URI: /services/$VERSION$/contacts/active
• API-Dokumentation:  /API/RealTimeDataAPI#/RealTime/ActiveContacts

Aus dem Namen und dem URI dieser Aktion geht nicht unmittelbar hervor, welche API zuerst in Betracht gezogen werden sollte. Wenn Sie nicht wissen, wo Sie beginnen sollten, können Sie die Dokumentation für jede API durchgehen und sich die Abschnitte genauer ansehen, die sich auf Kontakte beziehen. Die Admin-API ist die einzige API, die einen übergeordneten Abschnitt mit Kontakten enthält. Aber diese API enthält keine Endpunkte in Bezug auf aktive Kontakte.

Jetzt kann Ihnen das Wort active im Namen und im URI der Aktion einen Anhaltspunkt bieten. Anhand Ihrer CXone-Kenntnisse wissen Sie, dass "active" sich auf Kontakte bezieht, die derzeit bearbeitet werden. Deshalb sehen Sie sich die API "Echtzeitdaten" genauer an. Diese API hat nur einen Bereich. Wenn Sie diesen erweitern, sehen Sie, dass einer der Endpunkte GET /contacts/active lautet. Die Kurzbeschreibung für diesen Endpunkt lautet "Returns active contacts" (Gibt aktive Kontakte zurück).