hold() method

If a Session object is created, this method can be run on it by a third participant. It is used to put a session on hold. The phone can be put back to IN_CALL state with an unHold() method. Can only be used if the connected webclient has the required privilege.

Method usage example

You can register to the onSessionCreated event. If a session is created then the sessionCreated function is called that will hold the sessions everytime. (Code example 1).

//registers to the onSessionCreated event
OzWebClient.onSessionCreated(sessionCreated);

function sessionCreated(session)  {  
	session.hold(); //hold all created sessions
}
	

More information

• Transfer(transferor, phoneNumber) method
• Close() method
• CloseWithHangup() method
• Forward(target) method
• Hangup() method
• Hold() method
• OnSessionStateChanged event
• SendDtmf(key, phoneNumber) method
• StartListen() method
• StopListen() method
• Unhold() method