getActiveSessionsBySessionState method

Retrieves the sessions by the specified session state. It can only be used after the webclient successfully connected.

Parameters

sessionState: It is a mandatory string parameter. It is the current state of the session, which is present in the Ozeki Phone System. This state can be: RINGING, INCALL, CALLEEONHOLD, CALLERONHOLD, ONHOLD, ONHOLDINACTIVE, TRANSFERREQUESTED, TRANSFERRING, TRANSFERCOMPLETED, TRANSFERFAILED, CALLERHUNGUP, CALLEEHUNGUP, REDIRECTED, NOTFOUND, BUSY, CANCELLED, NOTANSWERED, ERROR and ABORTED.

Returns

sessions: Type: {string,Extension}. An object containing session class instances.

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 inCallSessions = OzWebClient.helper.getActiveSessionsBySessionState(CallState.IN_CALL)

	for(var i in inCallSessions){ 
		inCallSessions[i].hold();
	}
}
Code example 1 - getActiveSessionsBySessionState(sessionState) method example

More information