- Benefits
- Overview
- Installation guide
- Developers guide
- Quick start
- Ozeki PBX Architecture
- .Net API
- HTTP API
- JavaScript API
- Examples
- Documentations
- Call class
- Extension class
- Helper class
- getExtensionById
- getExtensions
- getActiveCallsOfExtension
- getActiveCallsOfUser
- getActiveSessionById
- getActiveSessionsBySessionState
- getCallHistoryOfExtension
- getExtensionsByType
- getOutsideLineById
- getOutsideLines
- getOutsideLinesByType
- getUserByExtension
- getUserById
- OzCamera class
- OzWebClient class
- Session class
- User class
- Interceptor classes reference
- SQL API
- OZML
- Install API extension
- SMS API
- Database servers
- Video tutorials
- Appendix
- Featured articles
- Technology
Ozeki brings you outstanding
SMS Gateway technology. Use our SMS Server products on Windows,Linux, or Android
C# SMS API
Developers can use our C# SMS API to send SMS from C#.Net. The C# SMS API comes with full source code
PHP SMS API
The ozeki PHP SMS gateway software can be used to send SMS from PHP and to receive SMS usig PHP on your website
SMPP SMS Gateway
SMS service providers use our SMPP gateway solution, that offers a high performance SMPP server and SMPP client gateway with amazing routing capabilities
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(); } }
More information
- GetExtensionById(id) method
- GetExtensions() method
- GetActiveCallsOfExtension(extensionId) method
- GetActiveCallsOfUser(userId) method
- GetActiveSessionById(sessionId) method
- GetCallHistoryOfExtension(extensionId, properties) method
- GetExtensionsByType(extensionType) method
- GetOutsideLineById(id) method
- GetOutsideLines() method
- GetOutsideLinesByType(outsideLineType) method
- GetUserByExtension(extensionId) method
- GetUserById(userId) method