Events
The events that are triggered by Client instance. See the getInstance method.
Constants
ACDError
Triggered when the Web SDK detects incorrect usage of the ACD module, e.g., usage of the same credentials in the different browsers or multiple browser windows. This event can also trigger when you make a request, reload the page and receive response after the page reloads.
Parameters
code:
number
message:
string
ACDStatusUpdated
Triggered when a contact center agent's status changes via SDK or within the contact center. Works both for SmartQueue and ACD v1.
Parameters
description:
string
Optionalid:
string
status:
AuthResult
Triggered after the Client.login, Client.loginWithOneTimeKey and Client.loginWithToken methods call.
Parameters
code:
number
OptionalRefresh token error code, possible values are:
Code Description 401 invalid token 404 invalid username 500 internal error 701 refresh token expired displayName:
string
OptionalAuthorized user's display na8me
key:
string
OptionalThis parameter is used to calculate hash parameter for Client.loginWithOneTimeKey method. AuthResult with the key dispatched after Client.requestOneTimeLoginKey method was called
result:
boolean
True in case of successful refresh, false - otherwise
tokens:
OptionalNew tokens structure
ConnectionClosed
Triggered if a connection to VoxImplant Cloud was closed because of network problems or the Client.disconnect function call.
ConnectionEstablished
Triggered after connection to VoxImplant Cloud was established successfully.
See: Client.connect
ConnectionFailed
Triggered if a connection to the VoxImplant cloud could not be established.
See: Client.connect
Parameters
message:
string
Failure reason description
IncomingCall
Triggered when there is a new incoming call to current user
MicAccessResult
Parameters
fallback:
boolean
Optionalresult:
boolean
True is access was allowed, false - otherwise
stream:
MediaStream
MediaStream object
PlaybackError
PlaybackFinished
Triggered after sound playback was stopped.
Reconnected
Event is triggered when reconnection to the server is successful.
Reconnecting
Event is triggered when the SDK client loses connection with the Voximplant cloud and tries to reconnect, for example, when a customer's internet connection fails.
RefreshTokenResult
Triggered after the LoginTokens.refreshToken call
Parameters
code:
number
OptionalRefresh token error code, possible values are:
Code Description 401 invalid token 404 invalid username 500 internal error 701 refresh token expired result:
boolean
True in case of successful refresh, false - otherwise
tokens:
OptionalNew tokens structure
SDKReady
Triggered after SDK was successfully initialized after the Client.init function call
Parameters
version:
string
SDK version
SQError
Triggered when the Web SDK detects incorrect use of the SmartQueue module, e.g., using the same credentials in the different browsers or multiple browser's windows.
Parameters
code:
number
message:
string
SQMessagingStatusUpdated
Triggered when SmartQueue messaging status of current user changed from SDK or from inside the SmartQueue messaging service.
Parameters
description:
string
Optionalid:
string
status: