- 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
getUserById(userId) method
Retrieves the user instance by the specified user ID, or null if the user does not exist. It can only be used after the webclient successfully connected.
Parameters
userId: It is a mandatory string parameter. The ID of the user.
Returns
user: Type: user. A User class instance or null if the user does not exist.
Method usage example
In this example we subscribe to the onConnectionStateChanged event. When it fires, the connectionStateChanged function is called, which gets the current status as a parameter. If this status is "ACCESS_GRANTED", we get the first assigned device of the admin user. Then create a call obbject and initiate the call. After it, we subscribe the onCallStateChanged event. When the state of the call changes to "ANSWERED", we send the "Hello World!" message to the admin's extension. (Code example 1).
OzWebClient.onConnectionStateChanged(connectionStateChanged); function connectionStateChanged(status) { console.log(status); if(status.State == ConnectionState.ACCESS_GRANTED) { var devices = OzWebClient.helper.getUserById('admin'); var firstDevice = devices.devices[0]; newCall = OzWebClient.createCall(firstDevice); newCall.start(); newCall.onCallStateChanged(callStateChanged); } } function callStateChanged(state){ if (newCall.getCallState() == CallState.ANSWERED){ newCall.sendMessage("Hello World!"); } }
More information
- GetExtensionById(id) method
- GetExtensions() method
- GetActiveCallsOfExtension(extensionId) method
- GetActiveCallsOfUser(userId) method
- GetActiveSessionById(sessionId) method
- GetActiveSessionsBySessionState method
- GetCallHistoryOfExtension(extensionId, properties) method
- GetExtensionsByType(extensionType) method
- GetOutsideLineById(id) method
- GetOutsideLines() method
- GetOutsideLinesByType(outsideLineType) method
- GetUserByExtension(extensionId) method