Guide aanpassen met behulp van API's

Guide gebruikt JavaScript-programmacode. U moet deze code toevoegen aan de pagina's op uw website waar Guide-betrokkenheidsinteracties beschikbaar moeten zijn. U kunt Guide aanpassen door APIGesloten Met API's kunt u bepaalde functies automatiseren door uw CXone-systeem te koppelen aan andere software die binnen uw organisatie wordt gebruikt.-aanroepen toe te voegen aan de JavaScript-code.

Test Guide-aanpassingen in een testomgeving voordat u ze vrijgeeft in uw productieomgeving. Zo voorkomt u dat uw websitebezoekers last hebben van storingen. Bovendien weet u dan zeker dat uw aanpassingen werken zoals bedoeld.

Aangepaste CSS API-aanroepen

Met de aanroep in dit gedeelte kunt u de CSS-elementen voor de Guide-widget wijzigen. Voorbeeld:

cxone('guide', 'setCustomCss', '[data-selector="GUIDE_ELEMENT"] {background: red !important;}');

Als u deze snippet wilt gebruiken, vervangt u GUIDE_ELEMENT door een waarde uit de volgende tabel en vervangt u de CSS-voorbeeldcode tussen accolades { } door uw aangepaste CSS-code:

Guide-interface

GUIDE_ELEMENT-waarden
Guide-widget en -knoppen

  • GUIDE_CHANNEL_BUTTON

  • GUIDE_CHANNEL_BACK_BUTTON

  • GUIDE_CHANNEL_CLOSE_BUTTON

  • GUIDE_FRAME_CONTENT

  • GUIDE_CHANNEL_ICON

  • GUIDE_CHANNEL_MENU_ICON
Portals

  • PORTAL_HEADER_iCON

  • PORTAL_HEADER

  • PORTAL_TITLE

  • PORTAL_SUBTITLE

  • GUIDE_CHANNEL_BUTTON_1

  • GUIDE_CHANNEL_BUTTON_2

  • GUIDE_CHANNEL_BUTTON_3

  • GUIDE_CHANNEL_BUTTON_4

  • GUIDE_MENU_BUTTON

  • KB_WIDGET_TITLE

  • KB_WIDGET_SEARCHBAR

  • KB_SEE_MORE_BUTTON

  • PORTAL_BODY

  • KB_WIDGET

  • CHANNELS_WIDGET
Artikelen

  • KB_HEADER

  • KB_BODY

Chats en e-mails

  • PRECONTACT_SURVEY

  • BEGIN_CHAT

  • SEND_EMAIL

  • INPUT

  • TEXTAREA

  • DROPDOWN

  • TREE

  • PRECONTACT_SURVEY_DESCRIPTION

  • PRECONTACT_SURVEY_ICON

  • TREE_POPUP_BACK_BUTTON

  • CLOSE_TREE_POPUP

  • CLOSE

Proactieve aanbiedingen

  • OFFER_CLOSE_BUTTON

  • OFFER_HEADER

  • OFFER_BODY

  • OFFER_BUTTON_1

  • OFFER_BUTTON_2

  • OFFER_BUTTON_3

API-aanroepen voor kanaalknoppen

Met de aanroepen in dit gedeelte kunt u de grootte en locatie van de kanaalknoppen op uw website aanpassen.

Knopgrootte aanpassen

Stelt de grootte voor kanaalknoppen in. Voer een waarde in ems of pixels in. De standaardgrootte voor knoppen is 3 em.

cxone('guide', 'setButtonSize', '80px');

Knop-offset aanpassen

Stelt de offsetwaarde voor kanaalknoppen in. Voer een waarde in ems of pixels in.

cxone('guide', 'setOffsetX', '48px');
cxone('guide', 'setOffsetY', '3em');

API-aanroepen voor menu openen/sluiten

Met de aanroepen in dit gedeelte kunt u het Handleiding-menu met kanaalknoppen openen en sluiten.

Guide-menu openen

Opent het Guide-knoppenmenu.

cxone('guide', 'openMenu');

Guide-menu sluiten

Sluit het Guide-knoppenmenu.

cxone('guide', 'closeMenu');

API-aanroep voor het wijzigen van de tekengrootte

Met de aanroep in dit gedeelte kunt u de tekengrootte voor de Guide-widget wijzigen.

Tekengrootte wijzigen

Stelt de standaardtekengrootte voor de Guide-widget in. Voer een waarde in pixels in. De standaardtekengrootte is 13 pixels. De hier ingestelde waarde bepaalt de em-grootte die overal in Guide wordt gebruikt.

cxone('guide','setFontSize',12);

API-aanroepen voor het wijzigen van de grootte van de Guide-widget

Met de aanroepen in dit gedeelte kunt u de hoogte en breedte van de Guide-widget wijzigen.

Hoogte van Guide-widget wijzigen

Stelt de hoogte van de Guide-widget in. Voer een waarde in ems of pixels in. De standaardhoogte is 40 em. De maximale hoogte is 40 rem.

cxone('guide','setDesiredGuideHeight','30em');

Breedte van Guide-widget wijzigen

Stelt de breedte van de Guide-widget in. Voer een waarde in ems of pixels in. De standaardbreedte is 23,125 em.

cxone('guide','setDesiredGuideWidth','608px');

Gedrag van API-aanroepen voor Handleiding-widget aanpassen

Met de aanroepen in dit gedeelte kunt u de weergave van Handleiding aanpassen.

Handleiding op volledige schermgrootte weergeven

U kunt Handleiding op volledige schermgrootte weergeven. Handleiding-inhoud verschijnt niet in de Handleiding-widget maar in een venster.

cxone('guide','setFullDisplay');

Een toegangspunt direct weergeven

U kunt een toegangspunt direct weergeven Handleiding zonder eerst een kanaalknop weer te geven. U kunt bijvoorbeeld een chatvenster, e-mailformulier of kennisbank-widget weergeven.

Voor deze API moet u de ID van de weer te geven toegangspunt doorgeven. U kunt de toegangspunt-ID ophalen door naast het toegangspunt op Bewerken te klikken en vervolgens het laatste gedeelte van de pagina-URL te kopiëren.

cxone('guide','openEntrypoint','e1348160-2016-4d91-958e-fd063c669fe6');

De pre-contact webvragenlijst voor chat weglaten

Met deze API kunt u Handleiding instrueren om een chat te beginnen zonder de pre-contact webvragenlijst weer te geven.

cxone('guide','hidePreSurvey');

Gebruik de chat-API's om waarden voor pre-contact webvragenlijsten vooraf in te stellen. U kunt ze ook opgeven als parameters voor de hidePreSurvey-API. Voorbeeld:

cxone('guide','hidePreSurvey', 'Dre', 'dre@classics.com');