2. Call Logging Function Overview

This chapter provides an overview of the Call Logging API functions that are used to develop and run call monitoring and call recording applications and a section on error handling.

2.1 Call Logging Function Groups

The call logging functions can be divided into three groups:

• Device-based functions -- functions that affect the status of a device or that set or get information related to a particular device
• Transaction-based functions -- functions that set or get information related to a particular call logging transaction
• Event-based functions -- functions that get information that has been sent to and stored in the event data block after a CLEV_MESSAGE event was generated

Table 8, Table 9, and Table 10 categorize the functions accordingly and provide brief descriptions of each of the call logging functions. For detailed descriptions of the functions, see Chapter 3 Call Logging Function Reference.

Table 8. Device-based Call Logging Functions

Function	Description
cl_Close( )	closes a previously opened call logging device
cl_DecodeTrace( )	decodes a previously recorded Layer 2 frame trace file and posts the call logging events to the SRL
cl_GetSemanticsStateCount( )	gets the number of semantics states
cl_GetSemanticsStateName( )	gets the name of a semantics state from its index
cl_GetUsrAttr( )	gets the user-defined attribute for a call logging device
cl_Open( )	opens a call logging device
cl_SetUsrAttr( )	sets the user-defined attribute for a call logging device

Table 9. Transaction-based Call Logging Functions

Function	Description
cl_GetTransaction( )	gets the call logging transaction ID
cl_GetTransactionDetails( )	gets the call logging transaction ID and other details
cl_GetTransactionUsrAttr( )	gets the user-defined attribute for a call logging transaction
cl_PeekCalled( )	gets the called party number, at function call time
cl_PeekCalling( )	gets the calling party number, at function call time
cl_PeekChannel( )	gets the channel number, at function call time
cl_PeekVariable( )	gets the value of a semantics-defined variable, at function call time
cl_ReleaseTransaction( )	releases the call logging transaction
cl_SetTransactionUsrAttr( )	sets the user-defined attribute for a call logging transaction

Table 10. Event-based Call Logging Functions

Function	Description
cl_GetCalled( )	gets the called party number, at event time
cl_GetCalling( )	gets the calling party number, at event time
cl_GetChannel( )	gets the channel number, at event time
cl_GetMessage( )	gets the Layer 3 message ID
cl_GetMessageDetails( )	gets the Layer 3 message ID and other details
cl_GetTransaction( )	gets the call logging transaction ID
cl_GetTransactionDetails( )	gets the call logging transaction ID and other details
cl_GetVariable( )	gets the value of a semantics-defined variable, at event time

Click here to contact Dialogic Customer Engineering