OzWebClient class

The OzWebClient class contains methods for connecting the webclient to the Ozeki Phone System and disconnecting from it. The webclient class is the main communication interface between Ozeki Phone System and Javascript. It has a method for creating a call. There are also several events in it.

Properties

PropertyDescription
isReadyTells whether the flash object and the WebClient is ready.
helperA Helper class instance.
activeCallsContains the active calls the WebClient currently handles.
activeSessionsContains the active sessions in Ozeki Phone System.
extensionsContains information about the extensions and outside lines configured in Ozeki Phone System.
usersContains information about the users configured in Ozeki Phone System.

Methods

MethodDescription
OzWebClient.connect(serverAddress, token, properties)Connects the webclient to Ozeki Phone System.
OzWebClient.createCall(dialedNumber, callType)This is the constructor of a call object.
OzWebClient.checkWebphoneState(serverAddress, webphoneId, callback)It is used to check if the webphone is available.
OzWebClient.disconnect()Disconnects the webclient from Ozeki Phone System.
OzWebClient.getCallHistory(filters)Initiates a call history query request to Ozeki Phone System. *
OzWebClient.setupCall(caller, callee)Creates a call between two extensions configured in Ozeki Phone System.

* Can only be used if the connected webclient has the required privilege.

Events

EventDescription
OzWebClient.onCallHistoryInfoReceivedThis event occurs when the result of the query initiated from the getCallHistory function has been received.
OzWebClient.onClientStateChangedThis event occurs when the state of the webclient changes.
OzWebClient.onConnectionStateChangedThis event occurs when the state of the connection changes.
OzWebClient.onErrorOccuredThis event occurs if an error message has been received from Ozeki Phone System.
OzWebClient.onExtensionInfoReceivedThis event occurs when the webclient receives information about an extension.
OzWebClient.onExtensionRemovedThis event occurs when the webclient receives information about an extension which has been removed.
OzWebClient.onIncomingCallThis event occurs when the webclient receives an incoming call.
OzWebClient.onSessionCreatedThis event occurs if a new Session has been created e.g. a new session has started in Ozeki Phone System.
OzWebClient.onSessionClosedThis event occurs when an active session has been closed.
OzWebClient.onUserInfoReceivedThis event occurs when the webclient receives information about a user.
OzWebClient.onUserRemovedThis event occurs when the webclient receives information about a user being removed from Ozeki Phone Sytem XE.
OzWebClient.onWebphoneStateReceivedThis event occurs when the state of the webphone is received.

Enumerations

ConnectionState:

  • CONNECTION_CLOSED: "CONNECTION_CLOSED"
  • CONNECTION_FAILED: "CONNECTION_FAILED"
  • ACCESS_GRANTED: "ACCESS_GRANTED",
  • ACCESS_DENIED: "ACCESS_DENIED"

If you have any questions or need assistance, please contact us at  info@ozekiphone.com

More information