Přeskočit na hlavní obsah

Konfigurace

Význam parametrů​

api: obj (v4.0.0)​

Adresa websocket proxy na UCS. Pokud není nastaven, tak se získá z aktuální URL.

window.ucsOperator.api = {
  hostname: string,
  port: string,
  path?: string,
  secure?: boolean,
  ws: {
    hostname?: string,
    port?: string,
    path?: string,
    secure?: boolean
  },
  recording: {...}, // stejné jako ws
  report: {...}, // stejné jako ws
  email: {...}, // stejné jako ws
  template: {...}, // stejné jako ws
}

lang: str (v4.0.0)​

Výchozí jazyk (před tím, než se uživatel přihlásí).

renderTo: str (v4.0.0)​

ID html tagu, do kterého se aplikace vyrenderuje (default “app”).

headless: bool (v4.0.0)​

Pokud je true, pak se vůbec nespustí GUI.

autologin: bool (v4.0.0)​

V případě použití akce login s 3. parametrem remeber nastaveným na true dojde k uložení přihlašovacího jména a hesla do cookie, parametr autologin ovlivňuje, zda se pouze vyplní formulář (autologin: false) nebo se provede i přihlášení (autologin: true)

autologout: bool (v4.0.0)​

Automaticky odhlásit uživatele pokud dojde k přihlášení stejného uživatele na jiném počítači nebo v jiném okně prohlížeče?

identifyURL: bool (v4.0.0)​

Bude automaticky použit identifikátor předaný v URL?

identifyIP: bool (v4.0.0)​

Bude použita IP adresa získaná dotazem na server UCS jako identifikátor?

identifyCookie: bool (v4.0.0)​

Bude použit identifikátor zadaný uživatelem při předchozím přihlášení?

listDevices: bool (v4.0.0)​

Zda se má z UCS získat seznam dostupných telefonů s jejich identifikátory pro vytvoření dropdown menu s výběrem telefonů.

confirmDevice: bool (v4.0.0)​

Pokud je parametr true, tak je uživatel vyzván k potvrzení spárovaného telefonu podle zadaného identifikátoru, při nastavení parametru na false, je aplikace spuštěna okamžitě po spárování telefonu.

showDialControl: bool (v4.0.0)​

Mají se v horní liště zobrazit ovládací prvky pro ovládání hovorů?

confirmUnload: bool (v4.0.0)​

Dotázat se před uzavřením záložky/okna prohlížeče?

notifyWaitingCallers: bool (v4.0.0)​

Má se agentům ve stavu ACW nebo AUX zobrazovat systémové upozornění na volající, kteří vstoupili do fronty?

topMenuNameContent: str (v4.0.0)​

%name% - zobrazovat jméno agenta
%icon% - zobrazovat ikonu

showBottomMenu: bool (v4.0.0)​

Má se zobrazovat spodní lišta v aplikaci?

autoOpenAccountCode: bool (v4.0.0)​

Má se po dokončení hovoru otevřít tabulka pro výběr account kódu k hovoru?

audioInputConstraints: AudioInputConstraints (v4.59.0)​

Umožňuje vypnout či zapnout modifikaci zvuku z mikrofonu.

interface AudioInputConstraints {
  echoCancellation?: boolean;
  noiseSuppression?: boolean;
  autoGainControl?: boolean;
};

withoutDevice: bool (v4.0.0)​

Pokud je parametr true, pak se aplikace se po přihlášení nepokusí párovat telefon.

legacyStartup: bool (v4.32.0)​

Pokud je parametr true, pak aplikace nečeká na browser event 'load', ale okamžitě po načtení operator.js dojde k jeho spuštění.

disableIntegratedAutoLogout: bool (v4.32.0)​

Pokud je operátorská aplikace integrovaná v jiném systému, který provádí přihlášení pomocí metody ucsOperator.sso('username', 'token', 'SomeSystem') s nastaveným třetím argumentem, pak při zavření záložky/okna prohlížeče dojde k automatickému odhlášení operátora z UCS. Nastavením tohoto parametru na true se automatické odhlašování vypne.

debounceRequests: bool (v4.34.0)​

Pokud je tento parametr zapnutý, historie hovorů neodešle dotaz hned po změně filtru, ale vyčká 500 ms jestli nenastane další změna.

onError: fn (v4.0.0)​

Callback, který zavolá aplikace v případě chyby, např. nepodaří se připojit k serveru, předá argument:

  • message: str - text chyby
window.ucsOperator.onError = function(message) {
  console.log('Something went wrong:', message);
}

onWarning: fn (v4.0.0)​

Callback, který zavolá aplikace v případě neobvyklé situace, např. dojde-li k chybě při zpracování události nebo požadavku, předá argument:

  • message: str - text varování

onInfo: fn (v4.0.0)​

Callback, který zavolá aplikace v případě informační hlášky, např. výsledek požadované změny, předá argument:

  • message: str - text informace

onDebug: fn (v4.0.0)​

Callback, který zavolá aplikace v případě ladící hlášky, např. oznámení o volání callbacku, předá argument:

  • message: str - text ladící hlášky

onMessage: fn (v4.0.0)​

Callback, který zavolá aplikace pro zobrazení hlášky agentovi, např. nepodařilo se odhlášení agenta z důvodu limitu ve frontě, předá argument:

  • message: obj
    • message: str - zpráva
    • type: enum - typ zprávy
      • success
      • info
      • warning
      • error
    • group: str - druh zprávy
    • data: obj - další data vztahující se ke zprávě

onConnect: fn (v4.0.0)​

Callback, který zavolá aplikace po úspěšném připojení k serveru UCS, předá argument:

  • version: str - verze aplikace

onCredentials: fn (v4.0.0)​

Callback, který zavolá aplikace po v okamžiku kdy požaduje přihlašovací údaje.

onLoginError: fn (v4.0.0)​

Callback volaný v případě chyby při přihlášení (např. invalid credentials), předává argumenty:

  • code: int - kód chyby
  • message: str - chybová hláška

onUser: fn (v4.0.0)​

Callback, který aplikace zavolá ve chvíli úspěšného přihlášení a načtení informací o přihlášeném uživateli, předá argument:

  • user: obj - parametry právě přihlášeného uživatele

onIdentify: fn (v4.0.0)​

Callback, který aplikace zavolá v okamžiku kdy od uživatele požaduje zadání identifikátoru pro spárování telefonu s PC, předá argument:

  • identificators: obj - pole objektů se seznamem telefonů a jejich identifikátorů, pokud je parametr listDevices nastaven na true

onIdentifier: fn (v4.0.0)​

Callback, který aplikace zavolá v okamžiku získání identifikátoru, předá argument:

  • identificator: str - identifikátor PC zadaný v URL, získaný z cookie, zjištěnou IP adresu pomocí serveru UCS nebo zadaný uživatelem

onDevice: fn (v4.0.0)​

Callback, který aplikace zavolá v okamžiku kdy dojde ke spárování telefonu s PC, předá argument:

  • device: obj - informace o aktuálně spárovaném telefonu

onReady: fn (v4.0.0)​

Callback, který zavolá aplikace po úspěšném přihlášení uživatele, předaný argument:

  • state (obj)
    • status: enum - stav dostupnosti agenta, stejný jako v onStateChange
    • reason: str - důvod nepřítomnosti agenta
    • call: obj - aktivní hovor na spárovaném telefonu
    • user: obj - informace o přihlášeném uživateli
    • device: obj - informace o spárovaném telefonu
    • auxReasons: obj - důvody nepřítomnosti
    • callReasons: obj - důvody volání (call reason nastavený agentem po ukončení hovoru)
    • queues: obj - dostupné fronty
    • groups: obj - seznam skupin (enum pro group_id)
    • agents: obj - seznam agentů
    • waitingCallers: int - počet čekajících ve frontách
    • now: timestamp - aktuální čas UCS

onStateChange: fn (v4.0.0)​

Callback, který zavolá aplikace při změně stavu dostupnosti agenta, předaný argument:

  • staus obj
    • status: enum - stav dostupnosti agenta
      • OFFLINE
      • READY
      • ACW
      • AUX
    • reason: str - důvod nepřítomnosti (AUX)

onCallNew: fn (v4.0.0)​

Callback, který zavolá aplikace při sestavování odchozího hovoru, předaný argument:

onCallRinging: fn (v4.0.0)​

Callback, který zavolá aplikace při příchozím nebo odchozím hovoru, předaný argument:

onCallConnect: fn (v4.0.0)​

Callback, který zavolá aplikace při spojení hovoru, předaný argument:

onCallHold: fn (v4.0.0)​

Callback, který zavolá aplikace při přidržení hovoru, předaný argument:

onCallResume: fn (v4.0.0)​

Callback, který zavolá aplikace při obnovení přidrženého hovoru, předaný argument:

onCallHangup: fn (v4.0.0)​

Callback, který zavolá aplikace při ukončení hovoru, předaný argument:

onCallMute: fn (v4.0.0)​

Callback, který zavolá aplikace při vypnutí mikrofonu agentem, předaný argument:

onCallUnmute: fn (v4.0.0)​

Callback, který zavolá aplikace při zapnutí mikrofonu agentem, předaný argument:

onAgentSuspend: fn (v4.0.0)​

Callback, který zavolá aplikace při přerušení obsluhy jedné z front agentem, přeadný argument:

  • queueId: int - ID fronty ze které má být agent vyjmut

onAgentResume: fn (v4.0.0)​

Callback, který zavolá aplikace při obnovení obsluhy jedné z front agentem, přeadný argument:

  • queueId: int - ID fronty do které má být agent vrácen

onWaitingCallersChange: fn (v4.0.0)​

Callback, který zavolá aplikace při změně počtu čekajících ve frontách, jejichž členem je agent, předaný argument:

  • waitingCallers: int - počet čekajících ve frontě