Skip to main content

Configuration

Meaning of parameters​

api: obj (v4.0.0)​

Websocket proxy address on UCS. If not set, it will be obtained from the current URL.

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

lang: str (v4.0.0)​

Default language (before the user logs in).

renderTo: str (v4.0.0)​

The ID of the html tag into which the application will be rendered (default “app”).

headless: bool (v4.0.0)​

If true, then the GUI will not start at all.

autologin: bool (v4.0.0)​

If the login action is used with the 3rd remember parameter set to true, the saving the login name and password in a cookie, the autologin parameter affects, whether the form is only filled out (autologin: false) or the login is also performed (autologin: true)

autologout: bool (v4.0.0)​

Automatically log out a user if the same user logs on another computer or in another browser window?

identifyURL: bool (v4.0.0)​

Will the identifier passed in the URL be used automatically?

identifyIP: bool (v4.0.0)​

Will the IP address obtained by querying the UCS server be used as an identifier?

identifyCookie: bool (v4.0.0)​

Will the identifier entered by the user during the previous login be used?

listDevices: bool (v4.0.0)​

Whether to get a list of available phones with their pro identifiers from UCS creating a dropdown menu with a selection of phones.

confirmDevice: bool (v4.0.0)​

If the parameter is true, the user is prompted to confirm the paired phone according to the specified identifier, when the parameter is set to false, is the application launched immediately after pairing the phone.

showDialControl: bool (v4.0.0)​

Should call controls appear in the top bar?

confirmUnload: bool (v4.0.0)​

Ask before closing browser tab/window?

notifyWaitingCallers: bool (v4.0.0)​

Should agents in ACW or AUX state see a system alert for callers who have entered the queue?

topMenuNameContent: str (v4.0.0)​

%name% - display agent name %icon% - show icon

showBottomMenu: bool (v4.0.0)​

Should the bottom bar be displayed in the application?

autoOpenAccountCode: bool (v4.0.0)​

Should the table for selecting the account code for the call be opened after the call is finished?

audioInputConstraints: AudioInputConstraints (v4.59.0)​

Allows you to turn off or on the modification of the sound from the microphone.

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

withoutDevice: bool (v4.0.0)​

If the parameter is true, then the application will not try to pair the phone after login.

legacyStartup: bool (v4.32.0)​

If the parameter is true, then the application does not wait for the browser event 'load', but immediately after loading operator.js it will be executed.

disableIntegratedAutoLogout: bool (v4.32.0)​

If the operator application is integrated in another system that performs the login using ucsOperator.sso('username', 'token', 'SomeSystem') method with set third argument, then when the browser tab/window is closed it will be automatic operator logout from UCS. Setting this parameter to true will automatically disables logout.

debounceRequests: bool (v4.34.0)​

If this parameter is enabled, the call history will not send a query immediately after changing the filter, but will wait 500 ms if it does not occur another change.

onError: fn (v4.0.0)​

A callback that is called by the application in case of an error, e.g. it fails to connect to the server, passing the argument:

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

onWarning: fn (v4.0.0)​

A callback that is called by the application in case of an unusual situation, e.g. if on an event or request processing error, passes the argument:

  • message: str - warning text

onInfo: fn (v4.0.0)​

A callback called by the application in the event of an information message, e.g. a result required changes, passes the argument:

  • message: str - information text

onDebug: fn (v4.0.0)​

A callback that the application calls in case of a debugging message, e.g. a call notification callback, passes an argument:

  • message: str - the text of the debugging message

onMessage: fn (v4.0.0)​

A callback called by the application to display a message to the agent, e.g. failed if the agent logs out due to a queue limit, it passes the argument:

  • message: obj
    • message: str - message
    • type: enum - message type
      • success
      • info
      • warning
      • error
    • group: str - message type
    • data: obj - other data related to the message

onConnect: fn (v4.0.0)​

The callback called by the application after a successful connection to the UCS server passes the argument:

  • version: str - application version

onCredentials: fn (v4.0.0)​

A callback that the application calls when it requests login data.

onLoginError: fn (v4.0.0)​

Callback called in case of login error (e.g. invalid credentials), passes arguments:

  • code: int - error code
  • message: str - error message

onUser: fn (v4.0.0)​

A callback that the application will call at the moment of successful login and loading of information about the logged in user, passes the argument:

  • user: obj - parameters of the currently logged in user

onIdentify: fn (v4.0.0)​

A callback that the application calls when it requests input from the user identifier for pairing the phone with the PC, passes the argument:

  • identifiers: obj - array of objects with a list of phones and their identifiers, if the listDevices parameter is set to true

onIdentifier: fn (v4.0.0)​

The callback that the application calls when the identifier is obtained passes the argument:

  • identifier: str - PC identifier specified in the URL, obtained from the detected cookie IP address provided by the UCS server or entered by the user

onDevice: fn (v4.0.0)​

Callback, which the application calls when the phone is paired with the PC, passes an argument:

  • device: obj - information about the currently paired phone

onReady: fn (v4.0.0)​

Callback to be called by the application after successful user login, argument passed:

  • state (volume)
    • status: enum - agent availability status, same as in onStateChange
    • reason: str - the reason for the agent's absence
    • call: obj - active call on the paired phone
    • user: obj - information about the logged in user
    • device: obj - information about the paired phone
    • auxReasons: obj - reasons for absence
    • callReasons: obj - call reasons (call reason set by the agent after the call ends)
    • queues: obj - available queues
    • groups: obj - list of groups (enum for group_id)
    • agents: obj - list of agents
    • waitingCallers: int - number of people waiting in queues
    • now: timestamp - current UCS time

onStateChange: fn (v4.0.0)​

The callback that the application calls when the agent's availability state changes, the argument passed:

  • status of order
    • status: enum - agent availability status
      • OFFLINE
      • READY
      • ACW
      • AUX
    • reason: str - reason for absence (AUX)

onCallNew: fn (v4.0.0)​

Callback to be called by the application when setting up an outgoing call, argument passed:

onCallRinging: fn (v4.0.0)​

Callback to be called by the application on an incoming or outgoing call, argument passed:

onCallConnect: fn (v4.0.0)​

Callback to be called by the application when the call is connected, argument passed:

onCallHold: fn (v4.0.0)​

Callback to be called by the application when the call is on hold, argument passed:

onCallResume: fn (v4.0.0)​

Callback to be called by the application when the held call is resumed, argument passed:

onCallHangup: fn (v4.0.0)​

A callback that the application will call when the call ends, the argument passed:

onCallMute: fn (v4.0.0)​

The callback that the app calls when the microphone is turned off by the agent, the argument passed:

onCallUnmute: fn (v4.0.0)​

Callback to be called by the application when the microphone is turned on by the agent, argument passed:

onAgentSuspend: fn (v4.0.0)​

A callback called by the application when the service of one of the queues is interrupted by the agent, primary argument:

  • queueId: int - ID of the queue from which the agent should be removed

onAgentResume: fn (v4.0.0)​

Callback, which will be called by the application when the service of one of the queues is resumed by the agent, primary argument:

  • queueId: int - ID of the queue to which the agent should be returned

onWaitingCallersChange: fn (v4.0.0)​

A callback that will be called by the application when the number of people waiting in queues whose member is agent, passed argument:

  • waitingCallers: int - number of people waiting in the queue