Programming Guide
Copyright © NEXUS COMMUNITY
Contents
Ch.1 Specifications 6
1.1 What is NXCAPI? 6
Ch.2 Function Specifications 7
2.1 Switching Functions 7
2.1.1 nxcapiAgentReadyGet 8
2.1.2 nxcapiAgentReadyGetCount 10
2.1.3 nxcapiAgentReadyGetValue 12
2.1.4 nxcapiAlternateCall 14
2.1.5 nxcapiAnswerCall 16
2.1.6 nxcapiAssociateData 18
2.1.7 nxcapiCallCompletion 20
2.1.8 nxcapiCampaignInfo 22
2.1.9 nxcapiClearCall 24
2.1.10 nxcapiClearConnection 26
2.1.11 nxcapiConferenceCall 28
2.1.12 nxcapiConsultationCall 31
2.1.13 nxcapiHoldCall 35
2.1.14 nxcapiMakeCall 37
2.1.15 nxcapiMakePredictiveCall 40
2.1.16 nxcapiObservationCall 43
2.1.17 nxcapiObservationTallkCall 46
2.1.18 nxcapiOneStepTransfer 49
2.1.19 nxcapiQueryAgentStatus 52
2.1.20 nxcapiQueryAgentStatusEx 54
2.1.21 nxcapiQueryAutoAnswer 57
2.1.22 nxcapiQueryDeviceDND 59
2.1.23 nxcapiQueryDeviceInfo 61
2.1.24 nxcapiQueryDeviceMessageWaiting 64
2.1.25 nxcapiQueryEnableRouting 66
2.1.26 nxcapiQueryLastNumber 68
2.1.27 nxcapiQueryMicrophoneMute 70
2.1.28 nxcapiQuerySpeakerMute 72
2.1.29 nxcapiQuerySpeakerVolume 74
2.1.30 nxcapiReconnectCall 76
2.1.31 nxcapiRetrieveCall 79
2.1.32 nxcapiSendDTMF 81
2.1.33 nxcapiSetAgentFlag 83
2.1.34 nxcapiSetFeatureAgentStatus 85
2.1.35 nxcapiSetFeatureAutoAnswer 88
2.1.36 nxcapiSetFeatureDND 90
2.1.37 nxcapiSetFeatureEnableRouting 92
2.1.38 nxcapiSetFeatureForward 94
2.1.39 nxcapiSetFeatureMessageWaiting 97
2.1.40 nxcapiSetFeatureMicrophoneMute 99
2.1.41 nxcapiSetFeatureSpeakerMute 101
2.1.42 nxcapiSetFeatureSpeakerVolume 103
2.1.43 nxcapiSingleStepConference 105
2.1.44 nxcapiSingleStepTransfer 107
2.1.45 nxcapiTransferCall 110
2.1.46 nxcapiUserExInfoData 113
2.1.47 nxcapiDivertDeflect 115
2.1.48 nxcapiDivertDirect 117
2.1.49 nxcapiDivertPickup 119
2.1.50 nxcapiGetAgentMaster 121
2.1.51 nxcapiGetEmployeeMaster 123
2.2 Status Reporting Functions 125
2.2.1 nxcapiGetEvent 126
2.2.2 nxcapiChangeMonitorFilter 128
2.2.3 nxcapiGetAPICaps 130
2.2.4 nxcapiGetDeviceList 131
2.2.1 nxcapiGetMonitor 132
2.2.2 nxcapiMonitorCall 134
2.2.3 nxcapiMonitorCallsViaDevice 136
2.2.4 nxcapiMonitorStart 138
2.2.5 nxcapiMonitorStop 139
2.2.6 nxcapiQueryCallMonitor 140
2.2.7 nxcapiSnapshotCall 141
2.2.8 nxcapiSnapshotDevice 143
2.3 Private Functions 145
2.3.1 nxcapiAbortStream 146
2.3.2 nxcapiAddDevice 147
2.3.3 nxcapiCallToCNID 148
2.3.4 nxcapiCloseServer 150
2.3.5 nxcapiCloseServerHA 151
2.3.6 nxcapiCurrentDN 152
2.3.7 nxcapiErrMsg 153
2.3.8 nxcapiEventNotify 155
2.3.9 nxcapiGetEventPoll 156
2.3.10 nxcapiMultiAddDevice 157
2.3.11 nxcapiOpenServer 159
2.3.12 nxcapiOpenServerHA 162
2.3.13 nxcapiPwdConfirm 166
2.3.14 nxcapiRemoveDevice 168
2.3.15 nxcapiSetUEIData 169
2.3.16 nxcapiWaitTimeGet 171
ch.3 Conditions and Erroes efinitions 173
3.1 Conditions Definition 174
3.1.1 ctmpMaxAccountInfoLen 174
3.1.2 ctmpMaxApplLen 174
3.1.3 ctmpMaxAgentId 174
3.1.4 ctmpMaxDeviceLen 174
3.1.5 ctmpMaxErrorMSGLen 174
3.1.6 ctmpMaxIPAddrLen 174
3.1.7 ctmpInvokeID 174
3.1.8 ctmpMonitorCrossID 174
3.1.9 ctmpCrossID 174
3.1.10 ctmpMaxAccountInfoLen 174
3.1.11 ctmpMaxApplLen 174
3.1.12 ctmpMaxAgentId 174
3.1.13 ctmpMaxDeviceLen 174
3.1.14 ctmpMaxErrorMSGLen 174
3.1.15 ctmpMaxIPAddrLen 175
3.1.16 ctmpMaxDeviceLen 175
3.1.17 ctmpMaxErrorMSGLen 175
3.1.18 ctmpINT 175
3.1.19 ctmpSHORT 175
3.1.20 ctmpCHAR 175
3.1.21 ctmpFLOAT 175
3.1.22 ctmpGateID 175
3.1.23 ctmpCallID 175
3.1.24 ctmpInvokeID 175
3.1.25 ctmpMonitorCrossID 175
3.1.26 ctmpRoutingCrossID 175
3.1.27 ctmpError 175
3.1.28 ctmpIoRefID 175
3.1.29 ctmpMessageID 176
3.1.30 ctmpAccountInfo 176
3.1.31 ctmpApplString 176
3.1.32 ctmpDeviceString 176
3.1.33 ctmpErrorMSG 176
3.1.34 ctmpIpAddr 176
3.1.35 ctmpLogIdString 176
3.1.36 ctmpManufacturerString 176
3.1.37 ctmpNetString 176
3.1.38 ctmpPrivateString 176
3.1.39 ctmpIOData 176
3.1.40 ctmpDataString 176
3.1.41 ctmpEventData 177
3.1.42 ctmpReadyAgent 188
3.1.43 ctmpConnectionID 189
3.1.44 ctmpPrivateData 189
3.1.45 ctmpConnectionList 189
3.1.46 ctmpUEI 190
3.1.47 ctmpCI 190
3.1.48 ctmpOpenData 190
3.1.49 ctmpQuery 191
3.1.50 nxcapiAgentReadyGet_rtn 192
3.1.51 ctmpCallList_rtn 192
3.1.52 ctmpCall_rtn 192
3.1.53 nxcapiQueryAgentStatus_rtn 192
3.1.54 nxcapiQueryAgentStatusEx_rtn 193
3.1.55 ctmpMode_rtn 193
3.1.56 ctmpQueryDeviceForward_rtn 194
3.1.57 ctmpQueryDeviceForward_rtn 194
3.1.58 nxcapiQueryLastNumber_rtn 196
3.1.59 nxcapiQuerySpeakerVolume_rtn 196
3.1.60 ctmpCallID_rtn 196
3.1.61 nxcapiCallToCNID_rtn 196
3.1.62 nxcapiErrMsg_rtn 196
3.1.63 nxcapiWaitTimeGet_rtn 196
3.2 Errors Definition 197
3.2.1 Error Code 198
Ch.1. Specifications
1.1 What is NXCAPI?
u What is NXCAPI?
NXCAI, an acronym of NEXUSCUBE APPLICATION PROGRAM INTERFACE is in charge of communication between NEXUSCUBE server and the application. In other words, it calls each function of NEXUSCUBE server into the application to be used.
u Main Functions
With NEXUSCUBE API, you can manage the basic data necessary for PBX operation using as following items.
페이지 1 / 192
Ch.2. Function Specifications
2.1Switching Functions
Through the switching function, you can manage of Make Call or Receive Call, Call Transfer, Conference Call and Agent Status change, etc.
Description of the Status AbbreviationAbbreviation / Status / Description
a / Alerting / The state of rining of a phone
c / Connected / The call between the Agent and the customer is connected
f / Failed / The call which is not connected
h / Held / The call which is held
i / Initiated / In the process of initialization
q / Queued / In the state of a call entering the Queue
a/h / Alerting or Held / In the state of the phone ringing or being held
* / Undefined / No matter which state it is
2.1.1. nxcapiAgentReadyGet
To Search for the Number and Name of the Agent in the state of Ready
Prototype
ctmpAPI
nxcapiAgentReadyGet ( ctmpGateID gate,
ctmpInvokeID invokeID,
ctmpSHORT AgentGroup,
ctmpSHORT AgentPart,
ctmpSHORT maxCount,
ctmpReadyAgent *readyAgent,
ctmpINT *readCount)
Description
It checks the number and name of the Agent among the Group or Part in the state of Ready. Also, it provides the information necessary for selection of the Agent who wants to transfer a call through taking in the number and the name of the Agent who is in the status of Ready when it is needed to transfer the call to specific Group or Part.
Parameters
gate
type: ctmpGateID
access: read only
use: mandatory
the handle necessary for conneting with CCSE. It is enabled to be obtained while nxcapiOpenServer.
invokeID
type: ctmpInvokeID
access: read only
use: option
It is used when it is tried to open with AsyncMode on nxcapiOpenServer. It is identified which causes the certain result with invokeID. It is enabled to be looped within 1 to 65535. If it is not AsyncMode, it is enabled to fix and use a certain number within 1 to 65535.
AgentGroup
type: ctmpSHORT
access: read only
use: option
Input the Agent Group you want to search. If you input 0, you can search all Agent Group.
AgentPart
type: ctmpSHORT
access: read only
use: option
Input the Agent Part you want to search. If you input 0, you can search the Agent Part of the Group you chose.
maxCount
type: ctmpSHORT
access: read only
use: mandatory
Input the largest number you want to search for the Agent in the status of Ready.
*readyAgent
type: ctmpReadyAgent
access: write only
use: mandatory
<Sync> It brings the list of Agent information as many as the number of readCount.
<ASync> It doen’t bring the value.
It brings the structure of readyAgent as much as that of readyCount in the structure of nxcapiAgentReadyGet_rtn.
*readCount
type: ctmpINT
access: write only
use: mandatory
<Sync> This is the number of the Agent which was identified as Ready in the status.
<ASync> It doesn’t bring the value.
It is brought into readCount in the structure of nxcapiAgentReadyGet_rtn.
Return Value
<Sync> Refer to Erro Code
<ASync> This is the result value transmitted into CCSE. Refer to Error Code.
All result of the function is identified by the result of nxcapiGetEventPoll. Refer to Error Code.
See Also
nxcapiOpenServer, nxcapiAgentReadyGetCount, nxcapiAgentReadyGetValue, nxcapiGetEventPoll
ctmpReadyAgent, nxcapiAgentReadyGet_rtn
Sample
Refer to nxcapiAgentReadyGet Sample
nxcapiAgentReadyGetCount
To Fine the Number of the Agent of a Group in the status of Ready
Prototype
ctmpAPI
nxcapiAgentReadyGetCount ( ctmpGateID gate,
ctmpInvokeID invokeID,
ctmpSHORT AgentGroup,
ctmpSHORT AgentPart,
ctmpSHORT maxCount,
ctmpINT *readCount)
Description
Fine the number of the Agent in the status of Ready among the Group or Part of the Agent.
Parameters
gate
type: ctmpGateID
access: read only
use: mandatory
the handle necessary for conneting with CCSE. It is enabled to be obtained while nxcapiOpenServer.
invokeID
type: ctmpInvokeID
access: read only
use: option
It is used when it is tried to open with AsyncMode on nxcapiOpenServer. It is identified which causes the certain result with invokeID. It is enabled to be looped within 1 to 65535. If it is not AsyncMode, it is enabled to fix and use a certain number within 1 to 65535.
AgentGroup
type: ctmpSHORT
access: read only
use: option
Input the Agent Group you want to search. If you input 0, you can search all Agent Group.
AgentPart
type: ctmpSHORT
access: read only
use: option
Input the Agent Part you want to search. If you input 0, you can search the Agent Part you chose.
maxCount
type: ctmpSHORT
access: read only
use: mandatory
Input the largest number you want to search for the Agent in the status of Ready.
*readCount
type: ctmpINT
access: write only
use: mandatory
<Sync> This is the number of the Agent which was identified as Ready in the status.
<ASync> It doesn’t bring the value.
It is brought into readCount in the structure of nxcapiAgentReadyGet_rtn.
Return Value
<Sync> Refer to Erro Code
<ASync> This is the result value transmitted into CCSE. Refer to Error Code.
All result of the function is identified by the result of nxcapiGetEventPoll. Refer to Error Code.
See Also
nxcapiOpenServer, nxcapiAgentReadyGet, nxcapiAgentReadyGetValue, nxcapiGetEventPoll
nxcapiAgentReadyGet_rtn
Sample
Refer to nxcapiAgentReadyGetCount
1.1.1 nxcapiAgentReadyGetValue
To Find the Information on the searched Agent from nxcapiAgentReadyGetValue
Prototype
ctmpAPI
nxcapiAgentReadyGetValue ( ctmpGateID gate,
ctmpInvokeID invokeID,
ctmpSHORT count,
ctmpINT *agentId,
ctmpINT *deviceDN,
ctmpMode_Def *blendMode,
ctmpSHORT *continueTime)
Description
It brings the Agent list relevant for the researched count from nxcapiAgentReadyGetCount. If you want to bring all data of the researched Agent, it is enabled to be you can do it with loop format from 0 to count.
* This function is used regardless of Sync/ASync.
Parameters
type: ctmpGateID
access: read only
use: mandatory
the handle necessary for conneting with CCSE. It is enabled to be obtained while nxcapiOpenServer.
invokeID
type: ctmpInvokeID
access: read only
use: option
It is used when it is tried to open with AsyncMode on nxcapiOpenServer. It is identified which causes the certain result with invokeID. It is enabled to be looped within 1 to 65535. If it is not AsyncMode, it is enabled to fix and use a certain number within 1 to 65535.
count
type: ctmpSHORT
access: read only
use: mandatory
Input the order of Count Number you want to search. If it is required to call all information of searched Agents, input 0 to Count orderly with loop processing.
*agentId
type: ctmpINT
access: write only
use: mandatory
Call the ID of searched Agents
*deviceDN
type: ctmpINT
access: write only
use: mandatory
Call the DN of searched Agents
*blendMode
type: ctmpMode_Def
access: write only
use: mandatory
Call the Blend Mode of searched Agents
Table.ctmpMode_Def
Value / DescriptionctmpV_Off
ctmpV_On / the state of operation setup cancelled
the state of operation setup
*continueTime
type: ctmpSHORT
access: write only
use: mandatory
Call the Wait Time of searched Agents
Return Value
Refer to Error Code
See Also
nxcapiOpenServer, nxcapiAgentReadyGet, nxcapiAgentReadyGetCount
ctmpMode_Def
Sample
Refer to nxcapiAgentReadyGetValue Sample
1.1.2 nxcapiAlternateCall
To Interconvert the Call which is the Subject of Consultation with the Held Call
Prototype
ctmpAPI
nxcapiAlternateCall (ctmpGateID gate,
ctmpInvokeID invokeID,
const ctmpConnectionID &heldCall,
const ctmpConnectionID &activeCall,
ctmpPrivateData *privateData=NULL)
Description
Before After
When you hold a call from a customer in order to transmit it to another Agent with the process of Consultation Call and have a Talk with the Agent you want to invite for the Consultation Call, having additional request for the customer, it is required to hold the call with the Agent, thus the state of the call with the held customer is changed to in the state of Wokring and the vice versa.
Parameters
gate
type: ctmpGateID
access: read only
use: mandatory
the handle necessary for conneting with CCSE. It is enabled to be obtained while nxcapiOpenServer.
invokeID
type: ctmpInvokeID
access: read only
use: option
It is used when it is tried to open with AsyncMode on nxcapiOpenServer. It is identified which causes the certain result with invokeID. It is enabled to be looped within 1 to 65535. If it is not AsyncMode, it is enabled to fix and use a certain number within 1 to 65535.
heldCall
type: ctmpConnectionID
access: read only
use: mandatory
Set up the call ID/DN, which is of the Agent who is trying ctmpAltemateCall, of the held one
activeCall
type: ctmpConnectionID
access: read only
use: mandatory
Set up the call ID/DN, which is of the Agnet who is in the state of Working, of that in the state of Working
privateData
type: ctmpPrivateData
access: read only
use: option
Input other information. It is presently not used
Return Value
<Sync> Refer to Erro Code
<ASync> This is the result value transmitted into CCSE. Refer to Error Code.
All result of the function is identified by the result of nxcapiGetEventPoll. Refer to Error Code.
See Also
nxcapiOpenServer, nxcapiConsultationCall, nxcapiGetEventPoll, nxcapiGetEvent
ctmpConnectionID, ctmpPrivateData, ctmpEventData
Sample
Refer to ctmpAlternateCall Sample
1.1.3 nxcapiAnswerCall
Prototype
ctmpAPI
nxcapiAnswerCall (ctmpGateID gate,
ctmpInvokeID invokeID,
const ctmpConnectionID &alertingCall,
ctmpPrivateData *privateData=NULL)
OCX
Long nxcapiAnswerCall (long gate,
short invokeID,
long alertingCallID,
LPCTSTR alertingDN)
Description
Before After
It is enabled to have a Talk with the customers without the operation of a receiver or a headset.
Precausions :
1. It is not possible to use the phone in the analog type. Only available phone is the digital type which is provided by the PBX supplier,.
2. It is required to know the call ID(C1)/DN(D2) to answer the call which is ringing.
- After nxcapiMonitorStart, it is required to monitor the state of the phone through nxcapiGetEvent all the time
Parameters
gate
type: ctmpGateID
access: read only
use: mandatory
the handle necessary for conneting with CCSE. It is enabled to be obtained while nxcapiOpenServer.
invokeID
type: ctmpInvokeID
access: read only
use: option
It is used when it is tried to open with AsyncMode on nxcapiOpenServer. It is identified which causes the certain result with invokeID. It is enabled to be looped within 1 to 65535. If it is not AsyncMode, it is enabled to fix and use a certain number within 1 to 65535.
alertingCall
type: ctmpConnectionID
access: read only
use: mandatory
Set up the call ID(C1)/DN(D2) of that which is ringing.
privateData
type: ctmpPrivateData
access: read only
use: option
Input other information. It is presently not used
OCX
alertingCallID
Set up the call ID(C1) of that which is ringing.
alertingDN
Set up the call DN(D2) of that which is ringing.
Return Value
<Sync> Refer to Erro Code
<ASync> This is the result value transmitted into CCSE. Refer to Error Code.
All result of the function is identified by the result of nxcapiGetEventPoll. Refer to Error Code.
See Also
nxcapiOpenServer, nxcapiGetEventPoll, nxcapiGetEvent
ctmpConnectionID, ctmpPrivateData, ctmpEventData
Sample
Refer to nxcapiAnswerCall Sample
1.1.4 nxcapiAssociateData
To Chagne of UUI of Call