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

123
Variant GetHookParam(LPCTSTR sHandle, LPCTSTR
sVarName)
Called within HookStart call back.
Retrieve Hook parameter send by SIPIVR 6800.
Parameters:
sHandle(LPCTSTR): Handle from HookStart
sVarName(LPCTSTR):
Variable Name to be retrieved
Return Values:
NULL: no such variable name.
String type variable value
BOOL IsStoppedByIVR(LPCTSTR sHandle)
Called within HookStart call back.
Query whether the HOOK is stopped by SIPIVR or not.
Parameters:
sHandle(LPCTSTR): Handle from HookStart
return values:
True if wrong handle value
False if SIPIVR 6800 is still wait the Hook Result
Usage:
Check before calling RespToIVR to response to SIPIVR
6800
Why Hook will be stopped by SIPIVR 6800:
Over the maximum hook execute time in SIPIVR 6800
HOOK component.
Call is hang-up by caller or stopped.
Event
HookStart(LPCTSTR sHandle, long nHookId)
This Event will be triggered when SIPIVR running into the
Hook component in a call flow.
Parameters:
sHandle(LPCTSTR): Hook Handle
nHookId(long): Hook ID from SIPIVR Hook component.
This value normally is used to identify which Hook
function need to be done by HOOK server.
Property
DefaultIvrIP (default: 127.0.0.1)
Used for SIPIVR6800 Release 1.0 only.
SIPIVR IP address.
ForceTerminatedTime (default: 600 seconds)
Maximum time to be executed for this HOOK request. It can
be use to protect resource will be forced released in case
something wrong or hanging.
Timeout (default: 300 seconds)
Maximum time SIPIVR will wait for this HOOK. If the running
time over this value, IsStoppedByIVR will return True for AP
to release their allocated resource.