API's en scripts

In uw Studio-scripts kunt u verbinden met webservices die SOAP- of RESTful API-normen gebruiken.

Ondersteunde opties

Studio ondersteunt de volgende manieren om te verbinden met webservices.

Optie Details
REST API Studio-actie

Met de REST API Studio-actie kunt u RESTful API-oproepen plaatsen vanaf uw scripts. Deze methode:

  • Kan omgaan met hogere lasten dan het plaatsen van RESTful-oproepen in een SNIPPET-actie, vooral op schaal.
  • Is de voorkeursmethode om API-oproepen te plaatsen in scripts.
  • Is de te gebruiken optie als uw oproepen JSON omvatten.
CXone APIStudio-acties Studio Heeft talrijke API-acties waarmee u oproepen plaatste naar CXone API's vanaf uw scripts. Niet elke CXone API is beschikbaar als een actie, maar wanneer er een beschikbaar is, moet u deze gebruiken in plaats van een andere methode. U kunt de API-acties vinden in de API-sectie van het tabblad Framework in Desktop Studio en het palet API-acties in CXone Studio.
SNIPPET-acties

U kunt een code schrijven in een SNIPPET-actie om te verbinden met RESTful- of SOAP-webservices van uw script. Dit is niet de aanbevolen methode voor het maken van REST-oproepen omdat het de contactafhandeling kan vertragen. U moet deze methode echter gebruiken als:

  • Uw oproepen omvatten XML
  • U maakt verbinding met een SOAP-service.

Beperkingen op geretourneerde gegevensgrootte

De CXone platform laat REST API's tot 32 KB gegevens retourneren. Deze limiet voorkomt instabiele clusters en uitval. Dit is strikt afgedwongen.

Deze limiet is van toepassing op elke methode van verbindingen met webservices, met inbegrip van de REST API -actie en het plaatsen van oproepen met de SNIPPET-actie. Gebruik, indien mogelijk, de actie REST API in plaats van de actie SNIPPET voor uw REST API's. REST API heeft een retourlimiet van 32 KB, maar kan omgaan met een zwaardere belasting dan de SNIPPET-methode.

De grootte van uw geretourneerde data verminderen:

  • Filter de data in de API-respons. Wanneer u bijvoorbeeld de NICE rapportage-API gebruikt om contacten op te halen, kunt u de resultaten filteren op de startDate en de endDate van het contact. Met deze API-oproep kunt u een maximaal aantal items retourneren en limiteren. Raadpleeg de documentatie voor de API die u oproept om te bepalen welke filters u kunt gebruiken.
  • Werk het API-verzoek bij om alleen de benodigde gegevens te retourneren. Wanneer u bijvoorbeeld de NICE rapportage-API gebruikt om contacten op te halen, kunt u de velden contactId of agentId gebruiken om alleen relevante data te retourneren. Raadpleeg de documentatie voor de API die u oproepen om te bepalen welke datalimieten u kunt gebruiken.

Wanneer de vorige oplossingen het probleem niet verhelpen, kunt u middleware bouwen.

-1 foutcode

De -1 foutcode is een interne code die wordt gebruikt voor het identificeren of een fout werd aangetroffen met een API-oproep. Deze code geeft specifiek aan dat het een situatie is waar een HTTP-statuscode niet wordt geretourneerd, of waar deze is geretourneerd, maar niet kan worden doorgegeven op het script.

De statusbeschrijving die de -1 foutcode vergezelt, kan u helpen het probleem vast te stellen. De statusbeschrijvingen die deze code kunnen vergezellen, omvatten:

  • Het verzoek is afgebroken. Er is een time-out van de bewerking opgetreden. Het verzoek is al dan niet verwerkt. Er moet een validatie gebeuren voordat u een loop instelt als reactie op een -1 statuscode. U moet mogelijk de time-outinstelling in de oproep wijzigen met de eigenschap ProxyTimeoutSeconds.

  • Ongeldige JSON Primitive. De JSON-parser was verward door de respons. De respons bevat mogelijk ongeldige tekens of was geen JSON. Deze fout treedt vaak op wanneer de respons is verzonden in HTML. U kunt de respons testen in de snippet-debugger. De REST API-respons is geen geldige JSON of XMLEen vierkant met een pijl die uit het midden naar de rechterbovenhoek wijst. kennisbankartikels kunnen helpen.

  • Data op rootniveau is ongeldig. De XML-parser was verward door de respons. De respons bevat mogelijk ongeldige tekens of was geen XML. Deze fout treedt vaak op wanneer de respons is verzonden in HTML. De REST API-respons is geen geldige JSON of XML  Een vierkant met een pijl die uit het midden naar de rechterbovenhoek wijst. kennisbankartikel kan helpen.

  • 'doctype' is een onverwachte token. De verwachte token is 'DOCTYPE'. Zie Data op rootniveau is ongeldig in deze lijst.

  • De 'br' starttag op lijn x position x komt niet overeen met de eindtag van de inhoud. Zie Data op rootniveau is ongeldig in deze lijst.

  • De onderliggende verbinding is gesloten: er is een onverwachte fout opgetreden bij een verzending. Dit betekent vaak dat er een probleem is met de TLS-handshake. Dit kan ook worden veroorzaakt door een IP of poort die niet open is op een firewall, het gebruik van een oude, niet-ondersteunde versie van TLS, ongeldige of verlopen certificaten, het gebruik van een IP-adres in combinatie met HTTPS of soortgelijke problemen Los het probleem met deze respons op met de firewall-logboeken aan de zijde van de ontvangende server.

  • De onderliggende verbinding is gesloten. Er kan geen vertrouwensrelatie worden gebouwd voor het beveiligde SSL/TLS-kanaal. Zie De onderliggende verbinding is gesloten: er is een onverwachte fout opgetreden bij een verzending in deze lijst.

  • Het verzoek is afgebroken. Kan geen beveiligd SSL/TLS-kanaal maken. Zie De onderliggende verbinding is gesloten: er is een onverwachte fout opgetreden bij een verzending in deze lijst.

  • Respons te groot. (> 32 KB). De respons bevat meer dan 32 KB gegevens. Wanneer dit zich voordoet, wordt de respons verwijderd omdat het systeem niet meer dan 32 KB kan opslaan in één variabele. De respons moet worden gewijzigd of gefilterd om de hoeveelheid geretourneerde gegevens te verminderen.