Welltech SIPIVR 6800GS V.2.1 - Manual (Page 120)

119
Appendix H Job OCX API
1) Use Microsoft MSMQ 3.0 TCP connection for transportation
2) Single thread for Job result call back.
Functions:
long Init()
Job OCX initialization
Parameters: no parameter
Return Values:
0: success
Others: failure
l ong NewJobParamContainer()
Create a Job parameter container ID for sending to SIPIVR 6800.
You need to use SetJobParam to setup the value to be send.
Each container ID can have multiple parameters set by
SetJobParam.
Parameters: no parameter
Return Values:
>0: returned parameter container ID
<0: error
long DelJobParamContainer(long nParamContainerId)
Delete a job parameter container ID and free resource allocated.
Parameters:
nParamContainer: Parameter container ID created by
NewJobParamSection.
Return Values:
0: success
<0: failure
long SetJobParam(long nParamContainerId, LPCTSTR sName,
LPCTSTR sValue)
Set a job variable and value into a parameter container. If the
variable name is not existed in the container, add the variable.
Parameters:
nParamContainerId(long): Parameter container ID created by
NewJobParamSection.
sName(LPCTSTR): job variable name
sValue(LPCTSTR): job variable value
Return Values:
0: success
<0: failure
long PushJob(long nSequence, LPCTSTR sIvrIP, long nJobId, long
nParamContainerId, long nMaxRetryCount, long nRetryIntervalTime,
long nTimeout)
Send Job to SIPIVR 6800
Parameters: