Global

Members

<readonly> CallState :string

Enum for call states
Type:
  • string
Properties:
Name Type Default Description
RINGING string RINGING
NOT_FOUND string NOT_FOUND
REJECTED string REJECTED
HOLD string HOLD
IN_CALL string IN_CALL
COMPLETED string COMPLETED
BUSY string BUSY
Source:

<readonly> CallType :string

Enum for call types
Type:
  • string
Properties:
Name Type Default Description
TEXT string TEXT
AUDIO string AUDIO
VIDEO string VIDEO
Source:

<readonly> ConnectionState :string

Enum for connection states
Type:
  • string
Properties:
Name Type Default Description
CONNECTION_CLOSED string CONNECTION_CLOSED
CONNECTION_FAILED string CONNECTION_FAILED
ACCESS_GRANTED string ACCESS_GRANTED
ACCESS_DENIED string ACCESS_DENIED
Source:

<readonly> ExtensionType :string

Enum for extension types
Type:
  • string
Properties:
Name Type Default Description
SIPEXTENSION string SIP extension
CALLQUEUE string Call queue
RINGGROUP string Ring group
SMSEXTENSION string SMS extension
WEBPHONEEXTENSION string Webphone extension
OZMLEXTENSION string OzML extension
APIEXTENSION string API extension
DIALEREXTENSION string Dialer extension
SQLSMS string SQL SMS
VOICEMAIL string Voicemail
CONFERENCEROOM string Conference room
SQLOZML string SQL OzML
ECHOSOUNDTEST string Echo / sound test
EXELAUNCHER string Exe launcher
Source:

<readonly> OutsideLineType :string

Enum for outside line types
Type:
  • string
Properties:
Name Type Default Description
VOIPPROVIDER string VoIP provider
ISDNPHONELINE string ISDN phone line
PSTNDEVICE string PSTN device
EMAILPROVIDER string Email provider
SMPPCONNECTION string SMPP connection
SMSMODEM string SMS Modem
WEBPHONE string Webphone
Source:

OzCamera :Object

Static instance to create Camera objects
Type:
  • Object
Source:
See:

OzUtil :Util

Static Util instance
Type:
Source:

OzWebClient :WebClient

Static WebClient instance
Type:
Source:

<readonly> SessionState :string

Enum for session states
Type:
  • string
Properties:
Name Type Default Description
CREATED string Created
SETUP string Setup
TRANSFERSETUP string TransferSetup
RINGING string Ringing
INCALL string InCall
CALLEEONHOLD string CalleeOnHold
CALLERONHOLD string CallerOnHold
ONHOLD string OnHold
ONHOLDINACTIVE string OnHoldInactive
TRANSFERREQUESTED string TransferRequested
TRANSFERRING string Transferring
TRANSFERCOMPLETED string TransferCompleted
TRANSFERFAILED string TransferFailed
CALLERHUNGUP string CallerHungUp
CALLEEHUNGUP string CalleeHungUp
REDIRECTED string Redirected
NOTFOUND string NotFound
BUSY string Busy
CANCELLED string Cancelled
NOTANSWERED string NotAnswered
ERROR string Error
ABORTED string Aborted
Source:

{boolean} :boolean

Tells whether the flash object and the WebClient is ready.
Type:
  • boolean
Source:

{ExtensionType|OutsideLineType} :ExtensionType|OutsideLineType

The type of the extension (e.g SIP Extension, ring group, etc.).
Type:
Source:

{Helper} :Helper

A Helper class instance.
Type:
Source:

{string} :string

The username of the user.
Type:
  • string
Source:

{string} :string

The full name of the user.
Type:
  • string
Source:

{string} :string

The phone number of the user.
Type:
  • string
Source:

{string} :string

The mobile number of the user.
Type:
  • string
Source:

{string} :string

The email address of the user.
Type:
  • string
Source:

{string} :string

The ID of the extension.
Type:
  • string
Source:

{string} :string

The name of the extension.
Type:
  • string
Source:

{string} :string

The connection type of the extension (e.g extension or outside line)
Type:
  • string
Source:

{string} :string

The current status of the extension
Type:
  • string
Source:

{string} :string

Information of the client connected to the extension (if there is any)
Type:
  • string
Source:

{string} :string

The master session ID of the session
Type:
  • string
Source:

{string} :string

The session ID of the session
Type:
  • string
Source:

{string} :string

The current state of the session
Type:
  • string
Source:

{string} :string

The start time of the session represented by a string
Type:
  • string
Source:

{string} :string

The talk duration of the session represented by a string
Type:
  • string
Source:

{string} :string

The state duration of the session represented by a string
Type:
  • string
Source:

{string} :string

The ID of the caller
Type:
  • string
Source:

{string} :string

The ID of the callee
Type:
  • string
Source:

{string} :string

The display name of the caller
Type:
  • string
Source:

{string} :string

The display name of the callee
Type:
  • string
Source:

{string} :string

The source ID of the session
Type:
  • string
Source:

{string} :string

The source type of the session
Type:
  • string
Source:

{string} :string

The destination ID of the session
Type:
  • string
Source:

{string} :string

The destination type of the session
Type:
  • string
Source:

{string} :string

The dialed number of the session.
Type:
  • string
Source:

Type Definitions

checkWebPhoneStateCallback(state)

The callback which handles the response initated from checkWebphoneState.
Parameters:
Name Type Description
state string The state of the webphone.
Source:

onCallHistoryReceivedCallback(info)

The callback which handles callHistoryInfoReceived events.
Parameters:
Name Type Description
info Object.<Object> Object containing call history records.
Source:

onClientStateChangedCallback(clientState)

The callback which handles the clientStateChanged events.
Parameters:
Name Type Description
clientState string The new state of the client.
Source:

onConnectionStateChangedCallback(connectionState)

The callback which handles connectionStateChanged events.
Parameters:
Name Type Description
connectionState ConnectionState The new state of the connection.
Source:

onErrorOccuredCallback(error)

The callback which handles errorOccured events.
Parameters:
Name Type Description
error string The error received.
Source:

onExtensionInfoReceivedCallback(extension)

The callback which handles extensionInfoReceived events.
Parameters:
Name Type Description
extension Extension The extension class instance created from the info of the extension.
Source:

onExtensionRemovedCallback(extensionId)

The callback which handles extensionRemoved events.
Parameters:
Name Type Description
extensionId string The ID of the extension which has been removed.
Source:

onExtensionStatusChangedCallback(extensionId, status)

The callback which handles extensionStatusChanged events.
Parameters:
Name Type Description
extensionId string The id of the extension whose status has changed.
status string The new status of the extension
Source:

onIncomingCallCallback(call)

The callback which handles incomingCall events.
Parameters:
Name Type Description
call Call The Call object created for the incoming call.
Source:

onSessionClosedCallback(sessionId)

The callback which handles sessionClosed events.
Parameters:
Name Type Description
sessionId string The ID of the closed session.
Source:

onSessionCreatedCallback(session)

The callback which handles sessionCreated events.
Parameters:
Name Type Description
session Session The created session.
Source:

onSessionStateChangedCallback(session, sessionState)

The callback which handles sessionStateChanged events.
Parameters:
Name Type Description
session string The changed session.
sessionState string The new state of the session.
Source:

onUserInfoReceivedCallback(username, user)

The callback which handles userInfoReceived events.
Parameters:
Name Type Description
username string The username of the user.
user User The User class instance.
Source:

onUserRemovedCallback(username)

The callback which handles userRemoved events.
Parameters:
Name Type Description
username string The username of the removed user.
Source:

onWebphoneStateReceivedCallback(webphoneState)

The callback which handles the webphoneStateReceived events.
Parameters:
Name Type Description
webphoneState string The state of the webphone.
Source:

sendRequestCallback(request)

The callback which handles the request callback.
Parameters:
Name Type Description
request Object The request object.
Source: