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

120
nSequence(long): Global unique sequence number giving by
application. This number will be the returned identifier when
SIPIVR send a job result back.
sIvrIP(LPCTSTR): SIPIVR IP address
nJobId(long): SIPIVR Job ID in Start component
nParamContainerId(long): Job parameter container ID created
by NewJobParamSection. 0 indicates no job parameters.
nMaxRetryCount(long): Maximum retry counter to wait for
SIPIVR to re-run when job result is “retry later”.
nRetryIntervalTime(long): Retry interval in minute for next retry
when job result is “retry later”.
nTimeout(long): Maximum time in minute to wait for SIPIVR to
run.
Return Values:
0: success
<0: failure
long CancelJob(long nSequence)
Cancel a pushed job.
Parameters:
nSequence(long): Global unique sequence number giving by
application for PushJob.
Return Values:
0: success
<0: failure
long GetJobStatus(long nSequence)
Check the job status
Parameters:
nSequence(long): Global unique sequence number giving by
application for PushJob.
Return Values:
0: sent to SIPIVR 6800 and waiting to run
1: the job is running by SIPIVR 6800
2: job is success ran by SIPIVR 6800
3: The job is failed to run due to resource issue. Retrying state.
4: Job is running but job result is failed or no job result is
designed in call flow.
5: Unable to get SIPIVR 6800 resource to run.
VARIANT GetJobRetParam(long nSequence, LPCTSTR sName)
Retrieve a job result parameter/variable
Parameters:
nSequence(long): Global unique sequence number giving by
application for PushJob.
sName(LPCTSTR): Variable name to be retrieved
Return Values:
NULL: indicate no such parameter or parameter value is NULL
Others: variable value sent by SIPIVR JobResult component.
long DelJobResult(long nSequence)