API Frameworkacties

API Frameworkacties zijn Studio-acties die u toestaan CXone-API's te gebruiken in uw scripts. U kunt de actie gebruiken in plaats van de API op te roepen met de traditionele integratiemethoden, zoals het gebruik van een fragment of de RestAPI -actie. API-acties bevinden zich allemaal op het tabblad Framework in Studio.

De API-acties verschillen van de standaard Studio-acties. Ze zin momenteel niet gedocumenteerd in de online help. De API's die overeenkomen met de API-acties, zijn echter wel gedocumenteerd in de CXone developer portal Een vierkant met een pijl die uit het midden naar de rechterbovenhoek wijst.. U kunt deze documentatie gebruiken wanneer u werkt met API-acties in uw scripts.

Niet elke CXone API heeft een overeenkomende API-actie in Studio.

API-actieversies

Wanneer nieuwe versies van CXone API's worden uitgegeven, kunnen nieuwe versies van de overeenkomende acties worden uitgegeven in Studio. Het is doorgaans het beste om de nieuwste versie van de actie te gebruiken. Oudere versies werken nog steeds in de meeste gevallen. U kunt de verschillende versies proberen om te zien welke werken en de benodigde functionaliteit bieden.

Sommige API-acties hebben de versie in de actienaam. U kunt dit zien wanneer u kijkt naar de boomstructuur van acties op het tabblad Framework. Niet alle API-acties bevatten het versienummer. Voor deze acties kunt u de versie vinden in de uitgebreide eigenschappen van de actie. U kunt de uitgebreide eigenschappen alleen zien in het tabblad Eigenschappen wanneer de actie is geselecteerd in het tabblad Framework.

Niet elke versie van elke API heeft een overeenkomende actie in Studio.

Uitgebreide eigenschappen van de API-actie weergeven

Een actie wordt geselecteerd op het tabblad Framework en de uitgebreide eigenschappen worden weergegeven op het tabblad Eigenschappen.

  1. Schik in Studio de tabbladen opnieuw zodat u het tabblad Eigenschappen en het tabblad Framework tegelijk kunt zien.
  2. Klik op het tabblad Framework op een API-actie.
  3. Op het tabblad Eigenschappen kunt u nu de uitgebreide eigenschappen van de actie zien. De volgende eigenschappen zijn in het bijzonder handig wanneer u leert over een API-actie: 
    • Diversen > Parameters > Werkwoord: deze eigenschap toont u de methode of het werkwoord, gekoppeld met de actie.
    • Diversen > Parameters > Versie: deze eigenschap toont u de versie van de API.
    • Diversen > Web > URI: deze eigenschap kan handig zijn wanneer u de API-documentatie in het developer portal zoekt.

    • Diversen > Parameters: in de sectie Parameters kunt u de eigenschappen uitvouwen om meer informatie te zien over elk van de eigenschappen van de actie.

API-documentatie zoeken

CXone API's zijn gedocumenteerd in de CXone Developer Portal. API acties in Studio hebben geen directe koppeling met de documentatie die overeenkomt met hun API's. U kunt deze informatie die beschikbaar is in de uitgebreide eigenschappen, echter gebruiken om de documentatie te zoeken.

Het gebruik van de URI vereist een algemene kennis van het CXone-systeem als een geheel en van de verschillende CXone API's. Dit is omdat het niet altijd zo eenvoudig is om vast te stellen welke API overeenkomt met een actie in Studio Als u de algemene flow van een contact kent via CXone, helpt dit u om de URI van een actie correct te interpreteren en de daar gevonden sleutels toe te passen op de structuur van de API-documentatie in het Developers Portal. De voorbeelden in deze sectie tonen de interpretatie die kan vereist zijn.

De startpagina van de API-sectie van de developer portal biedt een overzicht van elke CXone API.

Voorbeeld 1

Er is soms een duidelijke correlatie tussen een actie en de API ervan:

Op basis van de naam en URI van de actie, zijn de eerste twee API's die moeten worden overwogen, de Agent API en de Admin API. Door te kijken naar de lijst van API-oproepen voor elke agent, kunt u de Agent API elimineren. De beschrijving ervan geeft aan dat deze wordt gebruikt voor het beheren van agentsessies en verschijnt niet om oproepen te hebben die verwant zijn met skills, zoals weergegeven in de volgende afbeelding.

De lijst van API-oproepen voor de Agent API op de Developer Portal.

De Admin API geeft aan dat deze werkt met systeemobjecten zoals skills. De lijst van beschikbare API-oproepen voor deze API omvat skills, zoals weergegeven in de volgende afbeelding.

De lijst van oproepen die beschikbaar zijn in de Admin API in de Developer Portal-documentatie.

Wanneer u de sectie Skills uitvouwt, is een van de eindpunten GET /skills/agents. De kleine beschrijving voor dit eindpunt zegt dat het "Toewijzingen van skills retourneert".

De overeenkomende API voor de actie Agenttoewijzingen per skill.

Voorbeeld 2

De correlatie is soms niet voor de hand liggend, zoals weergegeven in het volgende voorbeeld. In dergelijke gevallen moet u uw kennis van CXone API's en het platform zelf toepassen om het overeenkomende API-eindpunt te zoeken. —

Op basis van de naam en URI van de actie, is het niet meteen duidelijk welke API u eerst moet bekijken. Als u niet zeker bent waar u wilt starten, kunt u de documentatie bekijken voor elke API en elke sectie die betrekking heeft met contacten, onderzoeken. De Admin API is de enige met een contactsectie op topniveau. Deze API bevat echter helaas geen eindpunten die betrekking hebben op actieve contacten.

De lijst van oproepen die beschikbaar zijn in de Digital Engagement API in de Developer Portal-documentatie.

De lijst van beschikbare eindpunten in de sectie Contacten van de Admin API.

Op dit punt kunt u het woord actief invoeren in de actienaam en de URI. Op basis van uw kennis van CXone, weet u dat actief wijst op contacten die momenteel worden afgehandeld. Hierdoor gaat u Realtime data-API van dichterbij gaan bekijken. Deze API heeft slechts één sectie en wanneer u deze uitvouwt, ziet u dat een van de eindpunten GET /contacts/active is. De kleine beschrijving voor dit eindpunt zegt dat het "Actieve contacten retourneert".

De lijst van beschikbare eindpunten die beschikbaar zijn in de Realtime sectie van de Realtime data-API.