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

122
Appendix I HOOK OCX API
Features:
1) Hook OCX library provides an easy way, that let user could write the
program to process the hook request from IVR. Every hook request from
IVR includes an identity; we call the "Hook ID". Programmer can use it to
distinguish different hook requests, and execute corresponding processes
2) Allow many Hook Server service for 1 SIPIVR 6800 (release 1.5 or above).
3) Use Microsoft MSMQ 3.0 TCP connection for transportation
4) Thread-safe in between each Hook.
Function List:
long Init()
Initialize OCX.
Parameters: no parameter
Return
Values:
0: success
others: failure
long SetHookRetParam(LPCTSTR sHandle, LPCTSTR
sVarName, LPCTSTR sValue)
Called within HookStart call back.
Prepare Hook return parameters for RespToIVR.
Parameters:
sHandle(LPCTSTR): Handle from HookStart
sVarName(LPCTSTR): Returned Parameter Name
sValue(LPCTSTR): Returned Parameter Value
Return Values:
0: success
others: error
long RespToIVR(LPCTSTR sHandle)
Called within HookStart call back.
Send Response Result to SIPIVR 6800.
Parameters:
sHandle(LPCTSTR): Handle from HookStart
Return Values:
0: success
others: error
Variant GetIVRIP(LPCTSTR sHandle)
Called within HookStart call back.
Retrieve SIPIVR 6800 IP address.
Parameters:
sHandle(LPCTSTR): Handle from HookStart
Return Values:
NULL: failure
String type variable value of SIPIVR 6800 IP address.