getActiveSessionById(sessionId) method

Retrieves the session by the specified session ID, or null if the session does not exist. It can only be used after the webclient successfully connected.


sessionId: It is a mandatory string parameter. It is the ID of the session, which is present in the Ozeki Phone System.


session: Type: Session. A Session class instance or null if the session does not exist.

Method usage example

In this example we subscribe to the onSessionCreated event. When it fires, the sessionCreated function is called, which gets the session as a parameter. Then we select a specific session with its ID and put it on hold with the hold() method. (Code example 1).


function sessionCreated(session){
	var newSession = OzWebClient.helper.getActiveSessionById('sW1KF');
Code example 1 - getActiveSessionById(sessionId) method example

More information