JSMCAPI Classes
This section lists the JSMCAPI classes in alphabetical order, along with the constructor, fields, methods, callback event methods, and returns associated with each class.
This section lists the constructor, fields, methods, callback event methods, and returns (if applicable) associated with this class.
Constructor
|
Constructor |
Returns |
|---|---|
|
_Address() |
_Address object |
Fields
|
Field |
Type |
|---|---|
|
caps |
Object |
|
id |
String |
Callback Event Methods
|
Callback Event Method |
Returns |
|---|---|
|
onError(event) |
None |
This section lists the constructor, fields, methods, callback event methods, and returns (if applicable) associated with this class.
The _UQAddress class extends the _Address class.
See _Address.
Constructor
|
Constructor |
Returns |
|---|---|
|
_UQAddress() |
_UQAddress object |
Fields
|
Field |
Type |
|---|---|
|
tasks |
Associative array |
Methods
|
Method |
Returns |
|---|---|
|
acceptTask(task, reason) |
None |
|
dequeueTask(task) |
Object |
Callback Event Methods
The _UQAddress class inherits the onError callback event method from the _Address class.
See _Address.
|
Callback Event Method |
Returns |
|---|---|
|
onAccepted(event) |
None |
|
onAcceptingTask(event) |
None |
|
onDequeueingTask(event) |
None |
|
onNotify(event) |
None |
|
onTaskAdded(event) |
None |
|
onTaskRemoved(event) |
None |
|
onUnassigned(event) |
None |
This section lists the constructor, fields, and returns (if applicable) associated with this class.
Constructor
|
Constructor |
Returns |
|---|---|
|
_User() |
_User object |
Fields
|
Field |
Type |
|---|---|
|
agentId |
String |
|
caps |
Associative array |
|
id |
String |
|
name |
String |
|
presences |
Associative array |
|
states |
Associative array of the constants beginning with ST_*. |
|
ST_LOGGEDIN |
String |
|
ST_LOGGEDOUT |
String |
|
ST_NOTREADY |
String |
|
ST_READY |
String |
|
ST_UNKNOWN |
String |
|
ST_WORKNOTREADY |
String |
|
ST_WORKREADY |
String |
|
statistics |
Object |
|
statistics1 |
Object |
|
statistics2 |
Object |
This section lists the constructor, fields, methods, callback event methods, and returns (if applicable) associated with this class.
The A2AChat class extends the _Address class.
See _Address.
Constructor
|
Constructor |
Returns |
|---|---|
|
A2AChat(event, address, chatType) |
A2AChat object |
Fields
|
Field |
Type |
|---|---|
|
address |
Object |
|
agentId |
String |
|
agentName |
String |
|
appData |
Object |
|
chatType |
String |
|
customerName |
Object |
|
id |
String |
|
isConference |
Object |
|
jr |
String of the PS_JR constant. |
|
type |
String of the following constants:
|
|
uniqueueId |
String |
Methods
|
Method |
Returns |
|---|---|
|
getUrl(defaultUrl) |
String |
This section lists the constructor, fields, methods, callback event methods, and returns (if applicable) associated with this class.
Constructor
|
Constructor |
Returns |
|---|---|
|
A2AChatAddress() |
A2AChatAddress object |
Fields
The A2AChatAddress class inherits the following fields from the _Address class:
id
caps
See _Address.
|
Field |
Type |
|---|---|
|
id |
String |
|
tasks |
Associative array |
Methods
|
Method |
Returns |
|---|---|
|
initiateChat(agentId) |
None |
Callback Event Methods
The A2AChatAddress class inherits the onError callback event method from the _Address class.
See _Address.
|
Callback Event Method |
Returns |
|---|---|
|
onChatEnded(event) |
None |
|
onInitiatingChat(event) |
None |
|
onNotify(event) |
None |
This section lists the constructor, fields, and returns (if applicable) associated with this class.
Constructor
|
Constructor |
Returns |
|---|---|
|
AgentStatistics() |
AgentStatistics object |
Fields
|
Field |
Type |
|---|---|
|
averageCallDuration |
Number |
|
averageHoldDuration |
Number |
|
callsHandled |
Number |
|
data |
Associative array |
|
percentIdleTime |
Number |
|
percentTimeAvailable |
Number |
|
percentTimeInCurrentState |
Number |
|
percentTimeUnavailable |
Number |
|
taskAcceptedCurrentLogin |
Number |
|
timeCurrentLogin |
Number |
|
timeWorking |
Number |
|
totalTaskAcceptedLogin |
Number |
|
totalTaskDoneLogin |
Number |
|
totalTaskDoneLogin |
Number |
|
unavailableDuration |
Number |
|
waitDuration |
Number |
This section lists the constructor, fields, methods, callback event methods, and returns (if applicable) associated with this class.
Constructor
|
Constructor |
Returns |
|---|---|
|
AppData() |
AppData object |
Fields
|
Field |
Type |
|---|---|
|
data |
Associative array |
|
groupId |
String |
|
jr |
String |
|
question |
String |
|
strData |
String |
|
subject |
String |
|
uniqueId |
String |
|
url |
String of the constant URL |
|
userId |
String |
|
username |
String |
|
wizUrl |
String |
Methods
|
Method |
Returns |
|---|---|
|
addKeyValue(key, value) |
None |
This section lists the constructor, methods, and callback event methods associated with this class.
The Buddy class extends the _User class.
See _User.
Constructor
|
Constructor |
Returns |
|---|---|
|
Buddy() |
Buddy object |
Fields
The Buddy class inherits the following fields from the _User class:
agentID
caps
id
name
presences
states
statistics
statistics1
statistics2
See _User.
Callback Event Methods
|
Callback Event Method |
Returns |
|---|---|
|
onStat1(event) |
None |
|
onStat2(event) |
None |
|
onState(event) |
None |
This section lists the constructor, fields, and returns (if applicable) associated with this class.
The Call class extends the Task class.
See Task.
Constructor
|
Constructor |
Returns |
|---|---|
|
Call(strCall) |
Call object |
Fields
The Call class inherits the following fields from the Task class:
caseid
cost
customerid
group
id
onStat
priority
type
urlAbs
urlRel
See Task.
|
Field |
Type |
|---|---|
|
line |
Object |
|
statistics |
Object |
|
userData |
String |
This section lists the constructor, fields, methods, and returns (if applicable) associated with this class.
Constructor
|
Constructor |
Returns |
|---|---|
|
CallData() |
CallData object |
Fields
|
Field |
Type |
|---|---|
|
ani |
String |
|
callId |
String |
|
callType |
String |
|
data |
String |
|
dnis |
String |
Methods
|
Method |
Returns |
|---|---|
|
addKeyValue(key , value) |
None |
This section lists the constructor, fields, and returns (if applicable) associated with this class.
Constructor
|
Constructor |
Returns |
|---|---|
|
CallStatistics() |
CallStatistics object |
Fields
|
Field |
Type |
|---|---|
|
data |
Associative array |
|
holdTime |
String |
|
queueTime |
String |
|
talkTime |
String |
This section lists the constructor, fields, methods, and returns (if applicable) associated with this class.
The Chat class extends the Task class.
See Task.
Constructor
|
Constructor |
Returns |
|---|---|
|
Chat(event, address) |
Chat object |
Fields
The Chat class inherits the following fields from the Task class:
caseid
cost
customerid
group
id
onStat
priority
type
urlAbs
urlRel
See Task.
|
Field |
Type |
|---|---|
|
address |
Object |
|
agentId |
String |
|
appData |
Object |
|
chatconnection |
Object |
|
chatType |
String |
|
customerName |
String |
|
groupId |
String |
|
question |
String |
|
statistics |
Object |
|
subject |
String |
|
userData |
Object |
Methods
|
Method |
Returns |
|---|---|
|
gettpUrl(defaultUrl) |
String |
|
getUrl(defaultUrl) |
String |
This section lists the constructor, fields, methods, callback event methods, and returns (if applicable) associated with this class.
The ChatAddress class extends the _UQAddress class.
See _UQAddress.
Constructor
|
Constructor |
Returns |
|---|---|
|
ChatAddress() |
ChatAddress object |
Fields
The ChatAddress class inherits the following fields from the _Address class:
id
caps
|
Field |
Type |
|---|---|
|
chatconnections |
Object |
|
tasks |
Object |
See _Address.
The ChatAddress class inherits the tasks field from the _UQAddress class.
See _UQAddress.
Methods
The ChatAddress class inherits the following methods from the _UQAddress class:
acceptTask
dequeueTask
|
Method |
Returns |
|---|---|
|
chat (agentId, buddyId, reason) |
None |
|
getChatconnectionByConnectionId (connectionId) |
Object |
|
getChatconnectionindexByConnectionId (connectionId) |
Index |
|
getFreeChatconnection |
Object |
|
getFreeChatconnectionIndex |
Object |
See _UQAddress.
Callback Event Methods
The ChatAddress class inherits the onError callback event method from the _Address class.
See _UQAddress.
The ChatAddress class inherits the following callback event methods from the _UQAddress class:
onAccepted
onAcceptingTask
onDequeueingTask
onNotify
onTaskAdded
onTaskRemoved
onUnassigned
See _UQAddress.
|
Callback Event Method |
Returns |
|---|---|
|
onCapabilitiesChanged (event) |
None |
This section lists the constructor, fields, methods, callback event methods, and returns (if applicable) associated with this class.
Constructor
|
Constructor |
Returns |
|---|---|
|
ChatConnection(event) |
ChatConnection object |
Fields
|
Field |
Returns |
|---|---|
|
caps |
Object |
|
chat |
String |
|
connectionId |
String |
|
id |
String |
|
state |
String |
Methods
|
Method |
Returns |
|---|---|
|
answer (agentid, reason) |
None |
|
conference (agentid, reason) |
None |
|
forward (fromagentid, toagentid, qid, userdata, chatdata, reason) |
None |
|
gethistory (agentid, noofLines, reason) |
None |
|
getUrl (deafultURL) |
String |
|
message (agentid, message, reason) |
None |
|
pushURL(URL) |
None |
|
reject(agentid, reason) |
None |
|
release(agentid, reason) |
None |
|
typing (agentid, reason) |
None |
Callback Event Methods
|
Callback Event Method |
Returns |
|---|---|
|
onAccepted (event) |
None |
|
onAnswering (event) |
None |
|
onCapabilitiesChanged (event) |
None |
|
onChatdataChanged (event) |
None |
|
onConferencing (event) |
None |
|
onDialing (event) |
None |
|
onDropped (event) |
None |
|
onError (event) |
None |
|
onForwarded (event) |
None |
|
onForwardError (event) |
None |
|
onForwarding (event) |
None |
|
onHistory (event) |
None |
|
onIncomingChat (event) |
None |
|
onMessage (event) |
None |
|
onPartyAdded (event) |
None |
|
onPartyChanged (event) |
None |
|
onPartyRemoved (event) |
None |
|
onProperties (event) |
None |
|
onPushURL (event) |
None |
|
onRejected (event) |
None |
|
onReleased (event) |
None |
|
onReleasing (event) |
None |
|
onRevoked (event) |
None |
|
onTalking (event) |
None |
|
onTyping (event) |
None |
|
onUserdataChanged (event) |
None |
This section lists the constructor, fields, methods, and returns (if applicable) associated with this class.
Constructor
|
Constructor |
Returns |
|---|---|
|
ChatConnectionCaps(event) |
ChatConnectionCaps object |
Fields
|
Field |
Type |
|---|---|
|
canAnswer |
Boolean |
|
canConference |
Boolean |
|
canConferenceSingle |
Boolean |
|
canForward |
Boolean |
|
canIndicateTyping |
Boolean |
|
canPushURL |
Boolean |
|
canReject |
Boolean |
|
canSendMessage |
Boolean |
This section lists the constructor, fields, methods, and returns (if applicable) associated with this class.
Constructor
|
Constructor |
Returns |
|---|---|
|
ChatData(event) |
ChatData object |
Fields
|
Field |
Type |
|---|---|
|
data |
Object |
Methods
|
Method |
Returns |
|---|---|
|
addKeyValue(key, value) |
None |
This section lists the constructor, methods, and returns (if applicable) associated with this class.
Constructor
|
Constructor |
Returns |
|---|---|
|
Connection (event) |
ConnectionEvent object |
Methods
|
Method |
Returns |
|---|---|
|
eventUserDataChanged(event) |
None |
This section lists the constructor, methods, and returns (if applicable) associated with this class.
Constructor
|
Constructor |
Returns |
|---|---|
|
ConnectionListener (event) |
ConnectionListener object |
Methods
|
Method |
Returns |
|---|---|
|
requestAttachUserdata(object, request) |
None |
This section lists the constructor, methods, and returns (if applicable) associated with this class.
Constructor
|
Constructor |
Returns |
|---|---|
|
ConnectionRequest (event) |
ConnectionRequest object |
Methods
|
Method |
Returns |
|---|---|
|
getUserData( ) |
UserData |
This section lists the constructor, fields, methods, and returns (if applicable) associated with this class.
The Email class extends the Task class.
See Task.
Constructor
|
Constructor |
Returns |
|---|---|
|
Email(event) |
Email object |
Fields
The Email class inherits the following fields from the Task class:
caseid
cost
customerid
group
id
onStat
priority
type
urlAbs
urlRel
See Task.
|
Field |
Type |
|---|---|
|
address |
Object |
|
agentId |
Object |
|
appData |
Object |
|
customerName |
String |
|
emailconnection |
Object |
|
emailId |
String |
|
groupId |
String |
|
question |
String |
|
statistics |
Object |
|
subject |
String |
|
userData |
Object |
Methods
|
Method |
Returns |
|---|---|
|
gettpUrl(defaultUrl) |
Object |
|
getUrl(defaultUrl) |
String |
This section lists the constructor, fields, methods, callback event methods, and returns (if applicable) associated with this class.
The EmailAddress class extends the _UQAddress class.
See _UQAddress.
Constructor
|
Constructor |
Returns |
|---|---|
|
EmailAddress() |
EmailAddress object |
Fields
The EmailAddress class inherits the following fields from the _Address class:
id
caps
See _Address.
The EmailAddress class inherits the tasks field from the _UQAddress class.
See _UQAddress.
|
Field |
Type |
|---|---|
|
agent |
Object |
|
emailconnections |
Object |
Methods
The EmailAddress class inherits the following methods from the _UQAddress class:
acceptTask
dequeueTask
See _UQAddress.
|
Method |
Returns |
|---|---|
|
getEmailconnectionByConnectionId (connectionId) |
Object |
|
getEmailconnectionindexByConnectionId (connectionId) |
Index |
|
getFreeEmailconnection |
Object |
Callback Event Methods
The EmailAddress class inherits the onError callback event method from the _Address class.
See _Address.
The EmailAddress class inherits the following callback event methods from the _UQAddress class:
onAccepted
onAcceptingTask
onDequeueingTask
onNotify
onTaskAdded
onTaskRemoved
onUnassigned
See _Address.
This section lists the constructor, fields, methods, callback event methods, and returns (if applicable) associated with this class.
Constructor
|
Constructor |
Returns |
|---|---|
|
EmailConnection(event) |
EmailConnection object |
Fields
|
Field |
Type |
|---|---|
|
caps |
Object |
|
connectionId |
String |
|
|
String |
|
id |
String |
|
state |
String |
Methods
|
Method |
Returns |
|---|---|
|
abandon ( reason) |
None |
|
answer ( reason) |
None |
|
complete (reason) |
None |
|
forward (fromagentid, toagentid, qid, userdata, Emaildata, reason) |
None |
|
reject(agentid, reason) |
None |
|
withdraw_RES ( reason) |
None |
Callback Event Methods
|
Callback Event Method |
Returns |
|---|---|
|
onAnswering (event) |
None |
|
onCapabilitiesChanged (event) |
None |
|
onCompleted (event) |
None |
|
onDropped (event) |
None |
|
onEmaildataChanged (event) |
None |
|
onError (event) |
None |
|
onForwarded (event) |
None |
|
onForwardError (event) |
None |
|
onForwarding (event) |
None |
|
onIncoming (event) |
None |
|
onProcessing (event) |
None |
|
onRejected (event) |
None |
|
onRevoked (event) |
None |
|
onUserdataChanged (event) |
None |
|
onWithdraw_REQ (event) |
None |
This section lists the constructor, fields, methods, and returns (if applicable) associated with this class.
Constructor
|
Constructor |
Returns |
|---|---|
|
EmailConnectionCaps(event) |
EmailConnectionCaps object |
Fields
|
Field |
Type |
|---|---|
|
canAnswer |
Boolean |
|
canComplete |
Boolean |
|
canForward |
Boolean |
|
canReject |
Boolean |
This section lists the constructor, fields, methods, and returns (if applicable) associated with this class.
Constructor
|
Constructor |
Returns |
|---|---|
|
EmailData(event) |
EmailData object |
Fields
|
Fields |
Type |
|---|---|
|
data |
Object |
Methods
|
Method |
Returns |
|---|---|
|
addKeyValue(key, value) |
None |
This section lists the constructor, fields, methods, callback event methods, and returns (if applicable) associated with this class.
The Extension class extends the _Address class.
See _Address.
Constructor
|
Constructor |
Returns |
|---|---|
|
Extension(numOfLines) |
Extension object |
Fields
The Extension class inherits the following fields from the _Address class:
id
caps
See _Address.
|
Field |
Type |
|---|---|
|
forwardMode |
Object |
|
isDnd |
Boolean |
|
lines |
Associative array |
|
numOfLines |
Number |
Methods
|
Method |
Returns |
|---|---|
|
cancelDnd(reason) |
None |
|
cancelForwardSet(reason) |
None |
|
forwardSet(number, mode, reason) |
None |
|
getDialingLine() |
Object |
|
getFreeLine() |
Object |
|
getLineByConnectionId(connectionId) |
Object |
|
getOffHookLine() |
Object |
|
setDnd(reason) |
None |
Callback Event Methods
The Extension class inherits the onError callback event method from the _Address class.
See _Address.
|
Callback Event Method |
Returns |
|---|---|
|
onCancelingDnd(event) |
None |
|
onCancelingForward(event) |
None |
|
onDnd(event) |
None |
|
onDndCanceled(event) |
None |
|
onForwardCanceled(event) |
None |
|
onForwarded(event) |
None |
|
onForwarding(event) |
None |
|
onSettingDnd(event) |
None |
This section lists the constructor, fields, and returns (if applicable) associated with this class.
Constructor
|
Constructor |
Returns |
|---|---|
|
ExtensionCaps(strCaps) |
ExtensionCaps object |
Fields
|
Field |
Type |
|---|---|
|
canCancelDnd |
Boolean |
|
canDial |
Boolean |
|
canFwdBusy |
Boolean |
|
canFwdBusyNoAnswer |
Boolean |
|
canFwdCancelForward |
Boolean |
|
canFwdDefault |
Boolean |
|
canFwdNoAnswer |
Boolean |
|
canFwdUnconditional |
Boolean |
|
canRefreshState |
Boolean |
|
canSetDnd |
Boolean |
This section lists the constructor, fields, and returns (if applicable) associated with this class.
Constructor
|
Constructor |
Returns |
|---|---|
|
ForwardMode() |
ForwardMode object |
Fields
|
Field |
Type |
|---|---|
|
mode |
String of the following constants:
|
This section lists the constructor, fields, methods, callback event methods, and returns (if applicable) associated with this class.
The GenericAddress class extends the _UQAddress class.
See _UQAddress.
Constructor
|
Constructor |
Returns |
|---|---|
|
GenericAddress() |
GenericAddress object |
Fields
The GenericAddress class inherits the following fields from the _Address class:
id
caps
See _Address.
The GenericAddress class inherits the tasks field from the _UQAddress class.
See _UQAddress.
|
Field |
Type |
|---|---|
|
agent |
Object |
|
genericconnections |
Object |
Methods
The GenericAddress class inherits the following methods from the _UQAddress class:
acceptTask
dequeueTask
See _UQAddress.
|
Method |
Returns |
|---|---|
|
getGenericconnectionByConnectionId (connectionId) |
Object |
|
getGenericconnectionindexByConnectionId (connectionId) |
Index |
|
getFreeGenericconnection |
Object |
Callback Event Methods
The GenericAddress class inherits the onError callback event method from the _Address class.
See _Address.
The GenericAddress class inherits the following callback event methods from the _UQAddress class:
onAccepted
onAcceptingTask
onDequeueingTask
onNotify
onTaskAdded
onTaskRemoved
onUnassigned
See _UQAddress.
This section lists the constructor, fields, methods, callback event methods, and returns (if applicable) associated with this class.
Constructor
|
Constructor |
Returns |
|---|---|
|
GenericConnection(event) |
GenericConnection object |
Fields
|
Field |
Type |
|---|---|
|
caps |
Object |
|
connectionId |
String |
|
generic |
String |
|
id |
String |
|
state |
String |
Methods
|
Method |
Returns |
|---|---|
|
abandon ( reason) |
None |
|
answer ( reason) |
None |
|
complete (reason) |
None |
|
forward (fromagentid, toagentid, qid, userdata, Genericdata, reason) |
None |
|
reject(agentid, reason) |
None |
|
withdraw_RES ( reason) |
None |
Callback Event Methods
|
Callback Event Method |
Returns |
|---|---|
|
onCapabilitiesChanged (event) |
None |
|
onCompleted (event) |
None |
|
onDropped (event) |
None |
|
onError (event) |
None |
|
onForwarded (event) |
None |
|
onForwardError (event) |
None |
|
onForwarding (event) |
None |
|
onGenericdataChanged (event) |
None |
|
onIncoming (event) |
None |
|
onProcessing (event) |
None |
|
onRejected (event) |
None |
|
onRevoked (event) |
None |
|
onUserdataChanged (event) |
None |
|
onWithdraw_REQ (event) |
This section lists the constructor, fields, methods, and returns (if applicable) associated with this class.
Constructor
|
Constructor |
Returns |
|---|---|
|
GenericConnectionCaps(event) |
GenericConnectionCaps object |
Fields
|
Field |
Type |
|---|---|
|
canAnswer |
Boolean |
|
canComplete |
Boolean |
|
canForward |
Boolean |
|
canReject |
Boolean |
This section lists the constructor, fields, methods, and returns (if applicable) associated with this class.
Constructor
|
Constructor |
Returns |
|---|---|
|
GenericData(event) |
GenericData object |
Fields
|
Field |
Type |
|---|---|
|
data |
Object |
Methods
|
Method |
Returns |
|---|---|
|
addKeyValue(key, value) |
None |
This section lists the constructor, fields, methods, callback event methods, and returns (if applicable) associated with this class.
The GenericTask class extends the Task class.
See Task.
Constructor
|
Constructor |
Returns |
|---|---|
|
GenericTask(event) |
GenericTask object |
Fields
The GenericTask class inherits the following fields from the Task class:
caseid
cost
customerid
group
id
onStat
priority
type
urlAbs
urlRel
See Task.
|
Field |
Type |
|---|---|
|
address |
String |
|
agentId |
String |
|
appData |
Object |
|
customerName |
String |
|
genericconnection |
Object |
|
genericId |
String |
|
groupId |
String |
|
question |
String |
|
subject |
String |
|
userData |
Object |
Methods
|
Method |
Returns |
|---|---|
|
gettpUrl(defaultUrl) |
Object |
|
getUrl(defaultUrl) |
String |
This section lists the fields and methods associated with this class.
Fields
|
Field |
Type |
|---|---|
|
A2AChat.PS_JR |
Constant |
|
A2AChat.TYPE_ANSWER |
Constant |
|
A2AChat.TYPE_CONSULT |
Constant |
|
Server.TYPE.CTI |
Constant |
|
Server.TYPE_UQ |
Constant |
|
Task.TYPE_A2ACHAT |
Constant |
|
Task.TYPE_CHAT |
Constant |
|
Task.TYPE_CTI |
Constant |
|
Task.TYPE_EMAIL |
Constant |
|
Task.TYPE_GENERIC |
Constant |
Methods
|
Method |
Returns |
|---|---|
|
initJSMCAPI() |
None |
|
isValid(obj) |
Boolean |
|
MCFBroadcast(cluster, cluster, cluster, cluster, cluster, cluster, cluster, cluster, cluster, cluster) |
None |
This section lists the constructor, fields, callback event methods, and returns (if applicable) associated with this class.
Constructor
|
Constructor |
Returns |
|---|---|
|
Group() |
Group object |
Fields
|
Field |
Type |
|---|---|
|
id |
String |
|
name |
String |
|
registered |
Boolean |
|
statistics |
Object |
|
statistics1 |
Object |
|
statistics2 |
Object |
Callback Event Methods
|
Callback Event Methods |
Returns |
|---|---|
|
onStat(event) |
None |
|
onStat1(event) |
None |
|
onStat2(event) |
None |
|
onTaskAdded(event) |
None |
|
onTaskRemoved(event) |
None |
This section lists the constructor, fields, and returns (if applicable) associated with this class.
Constructor
|
Constructor |
Returns |
|---|---|
|
GroupStatistics() |
GroupStatistics object |
Fields
|
Field |
Type |
|---|---|
|
data |
Associative array |
|
listOfTasksInTheQueueByTaskType |
Number |
|
maxTaskCompletionTime |
Number |
|
newestTask |
Number |
|
newestTaskCompletionTime |
Number |
|
numberOfAbandoned Note: This field is only updated for voice tasks, and only if the CTI adapter supports this calculation. |
String |
|
numberOfLoggedIn |
String |
|
numberOfQueued |
String |
|
numUnassignedTasks |
Number |
|
queuedWaitTime |
String |
|
queueUpTime |
Number |
|
relativeQueueLoad |
String |
|
timeElapsedOldestTask |
Number |
This section lists the constructor, fields, and returns (if applicable) associated with this class.
Constructor
|
Constructor |
Returns |
|---|---|
|
GroupStatistics1(data) |
GroupStatistics1 object |
Fields
|
Field |
Type |
|---|---|
|
mostRecentTaskDone |
String |
|
mostRecentTaskDoneData |
String |
|
mostRecentTaskEnqueued |
String |
|
mostRecentTaskEnqueuedData |
String |
|
numAgentsAvailable |
String |
|
numAgentsLoggedIn |
String |
|
numEscalation |
String |
|
numOverflow |
String |
|
numTaskAccepted |
String |
|
numTaskDone |
String |
|
numTaskQueued |
String |
|
reasonFlag |
String |
|
taskTotalTimeInSystem |
String |
|
timeSinceStart |
String |
This section lists the constructor, fields, and returns (if applicable) associated with this class.
Constructor
|
Constructor |
Returns |
|---|---|
|
GroupStatistics2(data) |
GroupStatistics2 object |
Fields
|
Field |
Type |
|---|---|
|
averageTaskDuration |
String |
|
averageWaitTime |
String |
|
oldestTask |
String |
|
recentTask |
String |
|
timeElapsedOldestTask |
String |
|
timeElapsedRecentTask |
String |
This section lists the constructor, fields, methods, callback event methods, and returns (if applicable) associated with this class.
Constructor
|
Constructor |
Returns |
|---|---|
|
Line() |
Line object |
Fields
|
Field |
Type |
|---|---|
|
call |
Object |
|
caps |
Object |
|
connectionId |
String |
|
id |
String |
|
isMuted |
Boolean |
|
state |
String of the following constants:
|
Methods
|
Method |
Returns |
|---|---|
|
alternate(reason) |
None |
|
answer(reason) |
None |
|
attachUserData(userdata, reason) |
None |
|
clear(reason) |
None |
|
complete(reason) |
None |
|
conference(destination, reason, userdata, calldata) |
None |
|
conferenceSingle(destination, reason, userdata, calldata) |
None |
|
dial(number, reason, userdata) |
None |
|
dropParty(destination, reason) |
None |
|
getAni() |
String |
|
getDescr() |
String |
|
getDnis() |
String |
|
getReferenceId() |
String |
|
getUrl(defaultUrl) |
String |
|
grabCall(destination, reason) |
String |
|
hold(reason) |
String |
|
join (reason, conferenceId ) |
None |
|
mute (reason) |
None |
|
park(destination, reason) |
None |
|
reconnect(reason) |
None |
|
reject(reason) |
None |
|
release(reason) |
None |
|
retrieve(reason) |
None |
|
sendDTMF(reason, stringDTMF) |
None |
|
setcallresult(result) |
None |
|
setcallresultDNC(reason, number) |
None |
|
setcallresultReschedule(hours, minutes,day, month,year) |
None |
|
transfer(destination, reason, userdata, calldata) |
None |
|
transferMute(destination, reason, userdata, calldata) |
None |
|
unmute(reason) |
None |
|
updateCallData(calldata, reason) |
None |
Callback Event Methods
|
Callback Event Method |
Returns |
|---|---|
|
onAlternating(event) |
None |
|
onAnswering(event) |
None |
|
onAttachingUD(event) |
None |
|
onCallDataChanged(event) |
None |
|
onCapabilitiesChanged(event) |
None |
|
onClearing(event) |
None |
|
onCompleting(event) |
None |
|
onConferencing(event) |
None |
|
onDialing(event) |
None |
|
onDropped(event) |
None |
|
onError(event) |
None |
|
onGrabbing(event) |
None |
|
onHeld(event) |
None |
|
onHolding(event) |
None |
|
onJoining(event) |
None |
|
onMuted(event) |
None |
|
onOffHook(event) |
None |
|
onOnHook(event) |
None |
|
onParking(event) |
None |
|
onPartyAdded(event) |
None |
|
onPartyChanged(event) |
None |
|
onPartyRemoved(event) |
None |
|
onReconnecting(event) |
None |
|
onRejected(event) |
None |
|
onRejecting(event) |
None |
|
onReleasing(event) |
None |
|
onRetrieving(event) |
None |
|
onRinging(event) |
None |
|
onSetcallresult(event) |
None |
|
onSetcallresultDNC(event) |
None |
|
onSetcallresultReschedule(event) |
None |
|
onTalking(event) |
None |
|
onTransfering(event) |
None |
|
onUnmuted(event) |
None |
|
onUpdatingCD(event) |
None |
|
onUserDataChanged(event) |
None |
This section lists the constructor, fields, and returns (if applicable) associated with this class.
Constructor
|
Constructor |
Returns |
|---|---|
|
LineCaps(strCaps) |
LineCaps object |
Fields
|
Field |
Type |
|---|---|
|
canAlternate |
Boolean |
|
canAnswer |
Boolean |
|
canAttachUserData |
Boolean |
|
canClear |
Boolean |
|
canComplete |
Boolean |
|
canConference |
Boolean |
|
canConferenceSingle |
Boolean |
|
canDropParty |
Boolean |
|
canHold |
Boolean |
|
canMute |
Boolean |
|
canPark |
Boolean |
|
canReconnect |
Boolean |
|
canReject |
Boolean |
|
canRelease |
Boolean |
|
canRetrieve |
Boolean |
|
canSendDTMF |
Boolean |
|
canSetcallresult |
Boolean |
|
canSetcallresultDNC |
Boolean |
|
canSetcallresultReschedule |
Boolean |
|
canTransfer |
Boolean |
|
canTransferMute |
Boolean |
|
canUnmute |
Boolean |
|
canUpdateCallData |
Boolean |
This section lists the constructor, fields, and returns (if applicable) associated with this class.
Constructor
|
Constructor |
Returns |
|---|---|
|
MCEvent() |
MCEvent object |
Fields
|
Field |
Type |
|---|---|
|
extension |
Object |
|
group |
Object |
|
reason |
Object |
|
user |
Object |
This section lists the constructor, fields, methods, callback event methods, and returns (if applicable) associated with this class.
Constructor
|
Constructor |
Returns |
|---|---|
|
MediaType() |
MediaType object |
Fields
|
Field |
Type |
|---|---|
|
type |
String of the following constants:
|
This section lists the constructor, fields, methods, and returns (if applicable) associated with this class.
Constructor
|
Constructor |
Returns |
|---|---|
|
PSMC() |
PSMC object |
Fields
|
Field |
Type |
|---|---|
|
renServer |
Object |
|
servers |
Associative array |
|
sessions |
Associative array |
Methods
|
Method |
Returns |
|---|---|
|
closeSession(serverId) |
None |
|
getCallById(id) |
Object |
|
getChatById(id) |
Object |
|
getEmailById(id) |
Object |
|
getGenericTaskById(id) |
Object |
|
getLineById(id) |
Object |
|
openSession(serverId) |
None |
|
start() |
None |
|
stop() |
None |
This section lists the constructor, fields, and returns (if applicable) associated with this class.
Constructor
|
Constructor |
Returns |
|---|---|
|
Reason(code, desc) |
Reason object |
Fields
|
Field |
Type |
|---|---|
|
code |
String |
|
description |
String |
|
reasonData1 |
String |
|
reasonData2 |
String |
|
reasonData3 |
String |
This section lists the constructor, fields, callback event methods, and returns (if applicable) associated with this class.
Constructor
|
Constructor |
Returns |
|---|---|
|
RenServer() |
RenServer object |
Fields
|
Field |
Type |
|---|---|
|
isRunning |
Boolean |
|
url |
String |
Callback Event Methods
|
Callback Event Method |
Returns |
|---|---|
|
onDown(event) |
None |
|
onUp(event) |
None |
This section lists the constructor, fields, methods, callback event methods, and returns (if applicable) associated with this class.
Constructor
|
Constructor |
Returns |
|---|---|
|
Server(serverID) |
Server object |
Fields
|
Field |
Type |
|---|---|
|
id |
String |
|
info |
String |
|
state |
String of the following constants:
|
|
type |
String of the following constants:
|
Callback Event Methods
|
Callback Event Method |
Returns |
|---|---|
|
onBroadcast(event) |
None |
|
onHbLost(event) |
None |
|
onHbRecovered(event) |
None |
|
onInService(event) |
None |
|
onOutOfService(event) |
None |
|
onRestart(event) |
None |
This section lists the constructor, fields, methods, callback event methods, and returns (if applicable) associated with this class.
Constructor
|
Constructor |
Returns |
|---|---|
|
Session(serverID) |
Session object |
Fields
|
Field |
Type |
|---|---|
|
addresses |
Associative array |
|
buddies |
Associative array |
|
groups |
Associative array |
|
id |
String |
|
intervalBetweenReqs |
Number |
|
numberRegsPerBulkReq |
Number |
|
serverID |
String |
|
state |
String of the following constants:
|
|
user |
User object |
Methods
|
Method |
Returns |
|---|---|
|
broadcastSubscribe(cluster, queue, task, state, presence, method) |
None |
|
broadcastUnsubscribe(type) |
None |
|
close() |
None |
|
open() |
None |
|
registerAddress(address) |
None |
|
registerBuddy(buddy) |
None |
|
registerBuddiesBulk(buddies, numRegsPerBulkReq, intervalBetweenReqs) |
None |
|
registerGroup(group) |
None |
|
registerGroupsBulk(groups, numRegsPerBulkReq, intervalBetweenReqs) |
None |
|
registerUser(user) |
None |
|
setAutoRecovery(autoRecover) |
None |
|
statPublish(userStat, userStat) |
None |
|
unregisterAddress(address) |
None |
|
unregisterBuddy(buddy) |
None |
|
unregisterGroup(group) |
None |
|
unregisterUser(user) |
None |
Callback Event Methods
|
Callback Event Method |
Returns |
|---|---|
|
onAddressRegistered(event) |
None |
|
onAddressUnregistered(event) |
None |
|
onBuddyRegistered(event) |
None |
|
onBuddyUnregistered(event) |
None |
|
onClosed(event) |
None |
|
onError(event) |
None |
|
onGroupRegistered(event) |
None |
|
onGroupUnregistered(event) |
None |
|
onInfo(event) |
None |
|
onOpened(event) |
None |
|
onUserRegistered(event) |
None |
|
onUserUnregistered(event) |
None |
This section lists the constructor, fields, and returns (if applicable) associated with this class.
Constructor
|
Constructor |
Returns |
|---|---|
|
Task() |
Task object |
Fields
|
Field |
Type |
|---|---|
|
caseid |
String |
|
cost |
String |
|
customerid |
String |
|
group |
String |
|
id |
String |
|
onStat |
String |
|
priority |
String |
|
type |
String; one of the following:
|
|
urlAbs |
Object |
|
urlRel |
Object |
Methods
|
Method |
Returns |
|---|---|
|
setUserData(UserData data) |
None |
|
getUserData( ) |
UserData |
This section lists the constructor, fields, and returns (if applicable) associated with this class.
Constructor
|
Constructor |
Returns |
|---|---|
|
TaskStatistics() |
TaskStatistics object |
Fields
|
Field |
Type |
|---|---|
|
data |
Associative array |
|
holdTime |
String |
|
queueTime |
String |
|
talkTime |
String |
This section lists the constructor, fields, methods, callback event methods, and returns (if applicable) associated with this class.
The User class extends the _User class.
See _User.
Constructor
|
Constructor |
Returns |
|---|---|
|
User(id, name, agentId, agentPassword) |
User object |
Fields
The User class inherits the following fields from the _User class:
agentId
caps
id
name
presences
states
statistics
statistics1
statistics2
See _User.
|
Field |
Type |
|---|---|
|
addresses |
Associative array |
|
agentPassword |
String |
|
language |
String |
|
registeredAddresses |
Associative array |
|
statesUq |
Object |
Methods
|
Method |
Returns |
|---|---|
|
disableMedia(group, mediaType, extension, reason) |
None |
|
enableMedia(group, mediaType, extension, reason) |
None |
|
isMediaEnabled(mediaType group) |
None |
|
login(group, extension, reason) |
None |
|
loginUq(group) |
None |
|
logout(group, extension, reason) |
None |
|
logoutUq(group) |
None |
|
register(extension, reason) |
None |
|
setNotReady(group, presence, extension, reason) |
None |
|
setPresence(group, presence, extension, reason) |
None |
|
setPresenceUq(group, presenceText, reason) |
None |
|
setReady(group, presence, extension, reason) |
None |
|
setWorkNotReady(group, presence, extension, reason) |
None |
|
setWorkReady(group, presence, extension, reason) |
None |
|
unRegister(extension, reason) |
None |
Callback Event Methods
|
Callback Event Method |
Returns |
|---|---|
|
onCapabilitiesChanged(event) |
None |
|
onCtiBusy(event) |
None |
|
onCtiClear(event) |
None |
|
onDropped(event) |
None |
|
onError(event) |
None |
|
onInfo(event) |
None |
|
onLoggedIn(event) |
None |
|
onLoggedOut(event) |
None |
|
onLoggingIn(event) |
None |
|
onLoggingOut(event) |
None |
|
onMediaDisabled(event) |
None |
|
onMediaEnabled(event) |
None |
|
onNotReady(event) |
None |
|
onPresenceChanged(event) |
None |
|
onReady(event) |
None |
|
onRegistered(event) |
None |
|
onRegistering(event) |
None |
|
onSettingNotReady(event) |
None |
|
onSettingPresence(event) |
None |
|
onSettingReady(event) |
None |
|
onSettingWorkNotReady(event) |
None |
|
onSettingWorkReady(event) |
None |
|
onStat(event) |
None |
|
onStat1(event) |
None |
|
onStat2(event) |
None |
|
onUnkown(event) |
None |
|
onUnregistered(event) |
None |
|
onUnregistering(event) |
None |
|
onWorkNotReady(event) |
None |
|
onWorkReady(event) |
None |
This section lists the constructor, fields, method, and returns (if applicable) associated with this class.
Constructor
|
Constructor |
Returns |
|---|---|
|
UserCaps() |
UserCaps object |
Fields
|
Field |
Type |
|---|---|
|
canHandleChat |
Boolean |
|
canHandleEmail |
Boolean |
|
canHandleGeneric |
Boolean |
|
canHandleVoice |
Boolean |
|
canLogin |
Boolean |
|
canLogout |
Boolean |
|
canRefreshState |
Boolean |
|
canSetNotReady |
Boolean |
|
canSetPresence |
Boolean |
|
canSetReady |
Boolean |
|
canSetWorkNotReady |
Boolean |
|
canSetWorkReady |
Boolean |
This section lists the constructor, constants, methods, and returns (if applicable) associated with this class.
Constructor
|
Constructor |
Returns |
|---|---|
|
UserData() |
UserData object |
Constants
The UserData class uses the following constants:
COMPONENT
DESCR
ISCRIPTPROGRAMNAME
ICTYPE
MARKET
MENU
REFERENCEID
TARGET
URLABS
URLREL
Methods
|
Method |
Returns |
|---|---|
|
add(key, value) |
None |
|
addKeyValue(key, value) |
None |
|
getValue(String key) |
String |
|
remove(key) |
None |
|
getKeys( ) |
String array |
This section lists the constructor, fields, and returns (if applicable) associated with this class.
Constructor
|
Constructor |
Returns |
|---|---|
|
UserStatistics1() |
UserStatistics1 object |
Fields
|
Field |
Type |
|---|---|
|
availableCost |
String |
|
ctiBusy |
String |
|
currentQueue |
String |
|
mostRecentTaskData |
String |
|
mostRecentTaskId |
String |
|
numTaskAccepted |
String |
|
numTasksDone |
String |
|
numTasksUnassigned |
String |
|
presenceText |
String |
|
reasonFlag |
String |
|
state |
String |
|
timeInCurrentState |
String |
|
timeSinceLoggedIn |
String |
This section lists the constructor, fields, methods, callback event methods, and returns (if applicable) associated with this class.
Constructor
|
Constructor |
Returns |
|---|---|
|
UserStatistics2() |
UserStatistics2 object |
Fields
|
Field |
Type |
|---|---|
|
currentQueue |
String |
|
timeIdle |
String |
|
timeInCurrentState |
String |
|
timeNotReady |
String |
|
timeSinceLogin |
String |
|
totalTimeAvailable |
String |
|
totalTimeUnavailable |
String |