Go to the source code of this file.
Defines | |
#define | DEF_BOOL |
#define | FALSE 0 |
#define | TRUE 1 |
#define | NULL 0 |
#define | ilRQ_ERR 0 |
#define | ilRQ_ANY 0 |
#define | ilRET_OK 0L |
#define | ilRET_ERROR -1L |
#define | ilRET_LIB_NOTREADY -3L |
#define | ilRET_CONN_CLOSED -5L |
#define | ilRET_BAD_ARGS -7L |
#define | ilRET_FUNC_UNSUPPORTED -9L |
#define | ilRET_TIMEOUT -11L |
#define | ilRET_REQ_EXPIRED -12L |
#define | ilRET_NO_REQUESTS -13L |
#define | ilRET_BAD_CONN_NAME -15L |
#define | ilRET_REQ_FAILURE -1000L |
#define | ilCI_CONN_ID_CHAR "ConnId" |
#define | ilCI_ALL_CHAR "All" |
#define | ilCI_CALL_ID_CHAR "TSCallId" |
#define | ilCI_DN_CHAR "CalledNum" |
#define | ilCI_ANI_CHAR "ANI" |
#define | ilCI_DNIS_CHAR "DNIS" |
#define | ilCI_THIS_DN_CHAR "PortDN" |
#define | ilCI_THIS_TRUNK_CHAR "PortTrunk" |
#define | ilCI_THIS_QUEUE_CHAR "PortQueue" |
#define | ilCI_OTHER_DN_CHAR "OtherDN" |
#define | ilCI_OTHER_TRUNK_CHAR "OtherTrunk" |
#define | ilCI_OTHER_QUEUE_CHAR "OtherQueue" |
#define | ilCI_LAST_EVENT_NAME_CHAR "LastEvent" |
#define | ilCI_FIRST_HOME_LOC_CHAR "FirstHomeLocation" |
#define | ilCI_UNKNOWN_CHAR "Unknown" |
Typedefs | |
typedef int | BOOL |
typedef BOOL * | PBOOL |
typedef unsigned char | BYTE |
typedef unsigned short | USHORT |
typedef unsigned int | UINT |
typedef unsigned long | ULONG |
typedef void * | PVOID |
typedef BYTE * | PBYTE |
typedef int * | PINT |
typedef UINT * | PUINT |
typedef ULONG * | PULONG |
typedef BYTE * | PUSTR |
typedef const void * | CPVOID |
typedef PVOID * | PPVOID |
typedef char * | PSTR |
typedef const char * | CPSTR |
typedef long * | PLONG |
typedef long | LONG |
typedef long * | LPTR |
typedef long long | LONG64 |
typedef unsigned long long | ULONG64 |
typedef unsigned short | SOCKET_PORT |
typedef ULONG | ilPORT |
typedef ULONG | ilRQ |
typedef long | ilRET |
Enumerations | |
enum | ilCI_TYPE { ilCI_ALL = 100, ilCI_CONN_ID = 101, ilCI_CALL_ID = 102, ilCI_DN = 111, ilCI_ANI = 112, ilCI_DNIS = 113, ilCI_THIS_DN = 121, ilCI_THIS_TRUNK = 122, ilCI_THIS_QUEUE = 123, ilCI_OTHER_DN = 131, ilCI_OTHER_TRUNK = 132, ilCI_OTHER_QUEUE = 133, ilCI_LAST_EVENT_NAME = 151, ilCI_FIRST_HOME_LOC = 152, ilCI_UNKNOWN = 999 } |
enum | ilERR_TYPE { ilET_NUMBER = 0, ilET_TEXT = 10 } |
enum | ilDIALOUTERR { ilDO_NOT_SUPPORTED = 0, ilDO_NO_TRUNKS, ilDO_MISC } |
enum | ilFAILURE { ilFAIL_BUSY = 0, ilFAIL_NO_ANSWER, ilFAIL_CONNECT_FAILED } |
enum | CallStatus { eCallStatusUnknown = 0, eCallStatusDialingMakeCall, eCallStatusBusyMakeCall, eCallStatusRinging, eCallStatusHeld, eCallStatusBusy, eCallStatusDialing, eCallStatusEstablished, eCallStatusRetrieved, eCallStatusConfPartyDel, eCallStatusConfPartyAdd, eCallStatusXferComplete, eCallStatusReleased, eCallStatusNoChange } |
enum | IlibraryState { ilRET_ACTIVE = 0, ilRET_SHUTDOWN_IN_PROCESS, ilRET_ALL_AGENTS_LOGGEDOUT, ilRET_NO_CALLS_IN_PROGRESS } |
Functions | |
BOOL | ilInitiate (CPSTR psName) |
BOOL | ilSetVersionNumber (CPSTR pszVersionNumber) |
BOOL | ilConnectionOpen (CPSTR psHost, SOCKET_PORT sPort, ULONG ulTimeoutMS) |
BOOL | ilConnectionOpenConfigServer (CPSTR psHost, SOCKET_PORT sPort, CPSTR szAppName, ULONG ulTimeoutMS) |
BOOL | ilConnectionClose (void) |
ilRQ | ilSRqNoteCallStart (ilRQ RqID, ilPORT Port, CPSTR psCallID, CPSTR psDNIS, CPSTR psANI, CPSTR psTagCDT) |
ilRQ | ilSRqNoteCallEnd (ilRQ RqID, ilPORT Port) |
ilRET | ilGetReply (ilRQ RqID, PSTR psRep, int iRepLen) |
ilRET | ilWatch (ULONG ulMaxTimeMSec) |
ilRQ | ilSRqUDataAddKD (ilRQ RqID, ilPORT port, CPSTR psKey, CPSTR psData) |
ilRQ | ilSRqRouteGet (ilRQ RqID, ilPORT Port, CPSTR psRP) |
ilRET | ilGetReplyAny (ilRQ *pRqID, PSTR psRep, int iRepLen) |
ilRQ | ilSRqCallInit (ilRQ RqID, ilPORT Port, CPSTR psDstDN) |
ilRQ | ilSRqCallComplete (ilRQ RqID, ilPORT Port) |
ilRQ | ilSRqCallConference (ilRQ RqID, ilPORT Port, CPSTR psDstDN) |
ilRQ | ilSRqCallTransfer (ilRQ RqID, ilPORT Port, CPSTR psDstDN) |
ilRQ | ilSRqCallTransferKVList (ilRQ RqID, ilPORT Port, CPSTR psDstDN, CPSTR psData) |
ilRQ | ilSRqCallConsultInit (ilRQ RqID, ilPORT Port, CPSTR psDstDN) |
ilRQ | ilSRqCallConsultComplete (ilRQ RqID, ilPORT Port) |
ilRQ | ilSRqCallConsultConference (ilRQ RqID, ilPORT Port) |
ilRQ | ilSRqCallConsultTransfer (ilRQ RqID, ilPORT Port) |
ilRQ | ilSRqUDataAddList (ilRQ RqID, ilPORT Port, CPSTR psList) |
ilRQ | ilSRqUDataGetKD (ilRQ RqID, ilPORT Port, CPSTR psKey) |
ilRQ | ilSRqUDataDelKD (ilRQ RqID, ilPORT Port, CPSTR psKey) |
ilRQ | ilSRqUDataDelAll (ilRQ RqID, ilPORT Port) |
ilRQ | ilSRqGetCallInfo (ilRQ RqID, ilPORT Port, ilCI_TYPE eCI) |
ilRQ | ilSRqCDT_Init (ilRQ RqID, ilPORT Port, CPSTR psDstDN, CPSTR psService, CPSTR psCDT_Type, CPSTR psCDT_Tag) |
ilRQ | ilSRqCDT_Cancel (ilRQ RqID, ilPORT Port) |
ilRQ | ilSRqVersion (ilRQ RqID, ilPORT Port, CPSTR psService) |
CPSTR | ilGetVersion (void) |
ilRQ | ilSRqToLog (ilRQ RqID, ilPORT Port, CPSTR psService, CPSTR psStr) |
BOOL | ilSetLogHeader (CPSTR pszLogHeader) |
BOOL | ilSetTimeout (ULONG ulMSec) |
ULONG | ilGetTimeout (void) |
long | ilGetLastError (ilERR_TYPE eErrType) |
long | ilGetLastPortError (ilPORT ilPort, ilERR_TYPE eErrType) |
ilRET | ilLocalPrn (ilRQ RqID, ilPORT Port, CPSTR psFmt,...) |
ilRET | ilLocalPrnSelector (char *selector, ilRQ RqID, ilPORT Port, CPSTR psFmt,...) |
int | ilGetCallStatus (ilPORT Port) |
CPSTR | ilPrnError (long lErrCode) |
ilRQ | ilSRqRouteDone (ilRQ RqID, ilPORT Port) |
ilRQ | ilSRqRouteStart (ilRQ RqID, ilPORT Port, CPSTR psRP) |
ilRQ | ilGetRequest (ilPORT Port, PSTR psReq, int iReqLen) |
ilRET | ilSendReply (ilRQ RqID, BOOL bResult, CPSTR psReply) |
ilRQ | ilSRqRouteAbort (ilRQ RqID, ilPORT Port) |
ilRQ | ilSRqStatPeek (ilRQ RqID, ilPORT Port, CPSTR psStatName) |
ilRQ | ilSRqStatGet (ilRQ RqID, ilPORT Port, CPSTR psSS_Name, CPSTR psObjectType, CPSTR psObjectID, CPSTR psStatType) |
BOOL | ilDeinitiate (void) |
ilRET | ilDialOutError (ilPORT Port, ilDIALOUTERR _ilDialOutErr) |
ilRQ | ilSRqGetDialOutData () |
ilRQ | ilSRqDialOutDataInit (ilRQ RqID, ilPORT Port, ilRQ RqID_DialOut) |
ilRET | ilCallEstablished (ilPORT Port) |
ilRET | ilFailure (ilPORT Port, ilFAILURE _ilFailure) |
ilRET | ilGetProcessingState () |
char * | ilGetParmValue (char *, int) |
|
The ilCallEstablished() function indicates that an outbound call has been established.
|
|
The ilConnectionClose() function is provided for compatibility with previous versions of this library. It is a no-op and should not be used.
|
|
The ilConnectionOpen() function opens a connection and logs in to the IServer.
|
|
The ilConnectionOpenConfigServer() function opens connections and logs in to IVR Server.
|
|
The ilDeinitiate() function is available only for compatibility with previous versions of this library. It is not intended that the IVR Library be de-initiated in order to be initiated again. It is recommended that it not be called.
|
|
The ilDialOutError() function indicates an outbound call could not be made.
|
|
The ilFailure() function indicates that an outbound call could not be made
|
|
The ilGetCallStatus() function returns the current call status on the port.
|
|
The ilGetLastError() returns the latest error code from the library
|
|
The ilGetLastPortError() returns the latest error code for the named port
|
|
The ilGetParmValue() function is reserved |
|
The ilGetProcessingState() function returns the current state of I-Library
|
|
Use the ilGetReply() function to obtain the reply to a previous ilSRq request function. The ilGetReply() function stores the text in a string buffer that your application maintains.
|
|
The ilGetReplyAny() function retrieves whatever is the next available reply with data and writes the ilRQ number for that reply in the location specified by the first argument, a pointer to an ilRQ variable.
|
|
The ilGetRequest() function checks for a request (treatment) from URS. It accepts (for a specified port) URS treatment through an IVR server.
|
|
The ilGetTimeout() function gets the current value of timeout set by the previous ilSetTimeout call.
|
|
The ilGetVersion() function lets you retrieve the version of the IVR Library.
|
|
The ilInitiate() function must be called before calling any other function in the library with the exception of ilSetLogHeader. Otherwise the IVR Library rejects all function calls. As an argument it takes configuration name of the IVR object resource. This function sets up all required services within the library.
|
|
The ilLocalPrn() function prints text directly to local log.
|
|
The ilLocalPrnSelector() function prints text directly to local log. based upon a selection variable.
|
|
The ilPrnError() function prints an error message associated with an error code received from the ilGetLastError() function. You should call the ilGetLastError() function first, take an appropriate action (according to the returned error code), and then either use the ilPrnError() function to print an error message or call the ilSRqToLog() function.
|
|
The ilSendReply() function sends a reply for an earlier received treatment request (URS via Iserver).
|
|
The ilSetLogHeader() is a no-op and should not be called.
|
|
The ilSetTimeout() function sets the timeout for next calls of the ilGetReply() and ilGetRequest() functions.
|
|
The ilSetVersionNumber() function lets you specify a version of your IVR driver/application.
|
|
The ilSRqCallComplete() function releases a call associated with the specified IVR port and is equivalent to the ilSRqNoteCallEnd() function. It may be called at any time there is an active call. Note: This function will not work for the offsite-switch option (IVR-In-Front).
|
|
The ilSRqCallConference() function makes a new conference call. A new party, specified by the psDstDN parameter, is added to the call. Check the specific T-Server/Switch configuration to verify that this functionality is supported. This function does not work for the offsite-switch option (IVR-In-Front).
|
|
The ilSRqCallConsultComplete() function releases a previously initiated consult call. Check the specific T-Server/Switch configuration to verify that this functionality is supported. The function does not work for the offsite-switch option (IVR-In-Front).
|
|
The ilSRqCallConsultConference() function merges the original and consultation call that resides on this port into conference. The new party from the consultation call is added to the base call. Check the specific T-Server/Switch configuration to verify that this functionality is supported. The function does not work for the offsite-switch option (IVR-In-Front).
|
|
The ilSRqCallConsultInit() function places the existing call on hold and originates a consultation call. The new party, specified by the psDstDN parameter, is connected to the specified IVR port. The party(s) from the base call is (are) placed on hold. Check the specific T-Server/Switch configuration to verify that this functionality is supported. The function does not work for the offsite-switch option (IVR-In-Front).
|
|
The ilSRqCallConsultTransfer() function completes a call transfer. This causes the IVR port specified by the port parameter to be released from both the original and consultation call. Parties participating in the original and consultation call that reside on this port are merged into one call. Check the specific T-Server/Switch configuration to verify that this functionality is supported. The function does not work for the offsite-switch option (IVR-In-Front).
|
|
The ilSRqCallInit() function initiates a new call from the IVR port to a destination DN specified by psDstDN. Note: This function will not work for the offsite-switch option (IVR-In-Front).
|
|
The ilSRqCallTransfer() function completes a call transfer. This causes the call on the specified port parameter to be released from both the original and consultation call. Parties participating in the original and consultation call that originally resided on this port are merged into one call. Check the specific T-Server/Switch configuration to verify that this functionality is supported. This function does not work for the offsite-switch option (IVR-In-Front).
|
|
The ilSRqCallTransferKVList() function completes a call transfer and transmits user data along with the call. This causes the call on the specified port parameter to be released from both the original and consultation call. Parties participating in the original and consultation call that originally resided on this port are merged into one call. Check the specific T-Server/Switch configuration to verify that this functionality is supported. This function does not work for the offsite-switch option (IVR-In-Front).
|
|
The ilSRqCDT_Cancel() function cancels a previous ilSRqCDT_Init() function request.
|
|
The ilSRqCDT_Init() function requests an access number or tag to make a Call Data Transfer (CDT) to a remote destination. Use the ilGetReply() function to get access number information, an access number (indirect type), or tag value (depending on the type of CDT) in your driver's reply buffer. The reply buffer will store information needed to transfer the call, including any routing digits (9 for outside line, 415 for CA, and so forth). After receiving the reply for this request, the user of the library is responsible for making the transfer of the call through PSTN. CDT requests can be:
|
|
The ilSRqDialOutDataInit() function updates status on the outbound call indicating that the application/driver has made the call.
|
|
The ilSRqGetCallInfo() function requests information about a type of call data, such as a connection ID, DN, and such. Use the ilGetReply() function to get the information in your driver's reply buffer.
|
|
The ilSRqGetDialOutData() function requests outbound call data from IServer.
|
|
Call the ilSRqNoteCallEnd() function when call activity on a particular port has completed. If configured for IVR-Behind-Switch, the IVR Server will request that the associated TServer release the call.
|
|
The ilSRqNoteCallStart() function notifies the IVR Interface Server that a new call resides on a particular IVR resource specified by the Port argument. Call the ilSRqNoteCallStart() function each time that call processing is started.
The IVR script should call this function before it calls any other telephony requests to IVR Interface Server for the particular IVR channel (except for the ilCallInit() function, which performs the equivalent function). Otherwise, the telephony request will be rejected and a corresponding error returned.
|
|
The ilSRqRouteAbort() function indicates to the Universal Routing Server (URS) that the route sequence associated with RqID has been aborted.
|
|
The ilSRqRouteDone() function is for compatibility with previous versions of this library, it is no longer supported.
|
|
The ilSRqRouteGet() function gets the next service (route) from the router. Immediately after getting the next service, the IVR Server automatically responds to the router with a route point (successfully) used message. If there is a possibility that this may not be the case, use RouteStart instead.
|
|
The ilSRqRouteStart() function indicates to URS that a route sequence for psRP has started. The IVR Server will return treatments to the application via the ilGetRequest() function. For each treatment, the IVR application (this driver if this is an interface for an application) should apply and respond with the results via the ilSendReply() function. The ilGetRequest() function will fail upon strategy termination. Call the ilSRqRouteAbort() function to end the current strategy.
|
|
The ilSRqStatGet() function is provided for compatibility with previous versions of this library. It is no longer supported in 7.0. ilSRqStatPeek should be used instead. |
|
The ilSRqStatPeek() function requests statistics from StatServer. The statistics, CurrNumberWaitingCalls and ExpectedWaitTime, are supported.
|
|
The ilSRqToLog() function inserts an information string into log file of psService.
|
|
The ilSRqUDataAddKD() function attaches one data element specified by psKey and psData to the active call that resides on the IVR port.
|
|
The ilSRqUDataAddList() function adds the list of key-value to the call residing on the IVR channel specified by Port. The IVR API supports functions that use a pointer to an ordered list structure. This structure allows sending and receiving a number of parameters presented as a single string. An ordered list structure is a string composed of several fields in strict order. Each field is separated from another field by a delimiter character. The order of fields in this structure is very important and must be specified. If a field has a zero value (string is empty) - this string still retains its place in the list. The first character in an ordered list is a delimiter. Each parameter begins after this delimiter and continues until another delimiter is found or the string is terminated, and so on. The following are examples of an ordered list.
|
|
The ilSRqUDataDelAll() function requests deletion of all user data attached to the call associated with the specified IVR port.
|
|
The ilSRqUDataDelKD() function requests deletion of the key-value pair specified by the key.
|
|
The ilSRqUDataGetKD() function requests the value of the key-value pair specified by the key. Note: Calls to get the key-value data (ilSRqUDataGetKD) require the exact (including case) key string that was used when the key-value was attached. Use the GetReply() function to get the value in your driver's reply buffer.
|
|
The ilSRqVersion() function requests the version number of the IVR Library or of a named service.
|
|
The ilWatch() function is provided for compatibility with previous versions of this library. It should not be called.
|