Ozeki Phone System

getActiveCallsOfUser | getActiveSessionsBySessionState

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.

Parameters

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

Returns

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).

OzWebClient.onSessionCreated(sessionCreated);

function sessionCreated(session){
	var newSession = OzWebClient.helper.getActiveSessionById('sW1KF');
	
	newSession.hold();
}
	

More information

• GetExtensionById(id) method
• GetExtensions() method
• GetActiveCallsOfExtension(extensionId) method
• GetActiveCallsOfUser(userId) method
• GetActiveSessionsBySessionState method
• GetCallHistoryOfExtension(extensionId, properties) method
• GetExtensionsByType(extensionType) method
• GetOutsideLineById(id) method
• GetOutsideLines() method
• GetOutsideLinesByType(outsideLineType) method
• GetUserByExtension(extensionId) method
• GetUserById(userId) method

getActiveCallsOfUser | getActiveSessionsBySessionState