OpenScape Contact Center Extensions V2R1 Integration Connector. Programming Guide A31003-S2220-R

Transcription

1 OpenScape Contact Center Extensions V2R1 Integration Connector Programming Guide

2 Our Quality and Environmental Management Systems are implemented according to the requirements of the ISO9001 and ISO14001 standards and are certified by an external certification company. Copyright Unify Software and Solutions GmbH&Co.KG2014 Mies-van-der-Rohe-Str. 6, Munich/Germany All rights reserved. Reference No.: The information provided in this document contains merely general descriptions or characteristics of performance which in case of actual use do not always apply as described or which may change as a result of further development of the products. An obligation to provide the respective characteristics shall only exist if expressly agreed in the terms of contract. Availability and technical specifications are subject to change without notice. Unify, OpenScape, OpenStage and HiPath are registered trademarks of Unify Software and Solutions GmbH & Co. KG. All other company, brand, product and service names are trademarksorregisteredtrademarkstrademarks or registered trademarks of their respective holders. unify.com

3 Content Content 1 About this guide Important product information Overview of contents Typographical styles CTI Basics System architecture Application development Registration of the interface library Application examples Synchronous and asynchronous method execution Troubleshooting Status changes among extensions and agents Enumeration types AcdContactTypeEnum AcdDequeueReasonEnum AcdFunctionTypeEnum AcdHandlingStateEnum AcdMediaTypeEnum AcdPartyTypeEnum AgentStateOsvHuntgroupEnum ApplicationIdentifierEnum AutoAnswerFlagEnum BusyStateDetailEnum BusyStateEnum CallDirectionEnum CallListChangeNotificationEnum CallStateEnum ConferenceEventTypeEnum CstaVersionEnum DeviceTypeEnum DoNotDisturbFlagEnum ErrorEnum EventCauseEnum EventTypeEnum ForwardingStateEnum IPVersionEnum LocalConnectionStateEnum LogLevelEnum LogMessageDelimiterEnum...24 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 3

4 Content MonitorDeviceHandlingFlagEnum MonitorStateEnum NodeTypeEnum ServerConnectionModeEnum ServerConnectionStateEnum ServerTypeEnum SetForwardingActionEnum SiteStateEnum SiteTypeEnum UserAgentStateEnum "CocCtiConnector" class Properties AvailableLicences ConfigData ServerConnectionMode ServerConnectionState Methods AcdAvailable AcdCheckPassword AcdExitPostProcessingState AcdGetBusinessUnitForExtension AcdGetBusinessUnitForUserId AcdGetBusinessUnits AcdGetCallInformation AcdGetPostProcessingReasons AcdGetPostProcessingState AcdGetQueues AcdGetTeams AcdGetUnavailableReasons AcdGetUserIdForUserName AcdGetUsers AcdGetUserState AcdGetWorkReasons AcdGetWrapupReasons AcdLogoff AcdLogon AcdRegisterForFunctions AcdRegisterForGlobalEvents AcdRegisterForNodeEvents AcdSaveWrapupData AcdSetPostProcessingState AcdSetPrimaryContact AcdUnavailable AcdUnregisterForFunctions AcdUnregisterForGlobalEvents AcdUnregisterForNodeEvents AcdWork AgentAvailable AgentLogoff OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

5 Content AgentLogon AgentUnavailable AgentWork AlternateCall AnswerCall CheckMonitoringDevice ClearConnection Close ConferenceCall ConsultCall CreateCallback DeflectCall DeleteCallback DialDigits GetAgentState GetAgentStateOsvHuntgroup GetDoNotDisturb GetErrorAs GetExtensionCallList GetForwarding GetPhoneState HoldCall IsExtensionOutOfService MakeCall Open ReconnectCall RetrieveCall SendDTMF SetAgentStateOsvHuntgroup SetForwarding SingleStepTransferCall SnapshotDevice SnapshotDeviceAdvanced StartMonitorDevice StopMonitorDevice TransferCall Events OnAcdAgentStateChangeInfoEvent OnAcdAvailableEvent OnAcdCheckPasswordEvent OnAcdContactStateChangeInfoEvent OnAcdContactStateInfoEvent OnAcdExitPostProcessingStateEvent OnAcdGetBusinessUnitForExtensionEvent OnAcdGetBusinessUnitForUserIdEvent OnAcdGetBusinessUnitsEvent OnAcdGetCallInformationEvent OnAcdGetPostProcessingReasonsEvent OnAcdGetPostProcessingStateEvent OnAcdGetQueuesEvent OnAcdGetTeamsEvent OnAcdGetUnavailableReasonsEvent...56 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 5

6 Content OnAcdGetUserIdForUserNameEvent OnAcdGetUsersEvent OnAcdGetUserStateEvent OnAcdGetWorkReasonsEvent OnAcdGetWrapupReasonsEvent OnAcdLogoffEvent OnAcdLogonEvent OnAcdRegisterForFunctionsEvent OnAcdRegisterForGlobalEventsEvent OnAcdRegisterForNodeEventsEvent OnAcdSaveWrapupDataEvent OnAcdSetPostProcessingStateEvent OnAcdSetPrimaryContactEvent OnAcdUnavailableEvent OnAcdUnregisterForFunctionsEvent OnAcdUnregisterForGlobalEventsEvent OnAcdUnregisterForNodeEventsEvent OnAcdUserStateChangeInfoEvent OnAcdVoiceRingingInfoEvent OnAcdWorkEvent OnAgentAvailableEvent OnAgentLogoffEvent OnAgentLogonEvent OnAgentStateChangeInfoEvent OnAgentUnavailableEvent OnAgentWorkEvent OnAlternateCallEvent OnAnswerCallEvent OnCallbackInfoEvent OnCallDisconnectOnHeldInfoEvent OnCallEstablishedInfoEvent OnCallPickupInfoEvent OnCheckMonitoringDeviceEvent OnClearConnectionEvent OnConferenceCallEvent OnConferenceInfoEvent OnConsultCallEvent OnCreateCallbackEvent OnDeflectCallEvent OnDeleteCallbackEvent OnDialDigitsEvent OnErrorEvent OnFailoverInfoEvent OnGetAgentStateEvent OnGetAgentStateOsvHuntgroupEvent OnGetDoNotDisturbEvent OnGetForwardingEvent OnHoldCallEvent OnLoggingEvent OnMakeCallEvent OnPhoneCallStateChangeInfoEvent OnPhoneClearedInfoEvent OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

7 Content OnPhoneDialingInfoEvent OnPhoneRingingInfoEvent OnPhoneStateBusyInfoEvent OnPhoneStateChangeInfoEvent OnReconnectCallEvent OnRetrieveCallEvent OnSendDTMFEvent OnServerConnectionStateChangeEvent OnSetAgentStateOsvHuntgroupEvent OnSetForwardingEvent OnSingleStepTransferCallEvent OnSiteStateInfoEvent OnSnapshotDeviceAdvancedEvent OnSnapshotDeviceEvent OnStartMonitorDeviceEvent OnStopMonitorDeviceEvent OnTransferCallEvent OnTransferCompletedInfoEvent OnTransferedInfoEvent Other classes AcdContactDataListParamX Properties Methods AcdFunctionTypeListParamX Properties Methods AcdWrapupReasonKeyDataListParamX Properties Methods IAcdAgentStateChangeInfoDataX Properties IAcdAvailableDataX Properties IAcdBusinessUnitsDataX Properties IAcdBusinessUnitsListX Properties Methods IAcdCheckPasswordDataX Properties IAcdContactDataListX Properties Methods IAcdContactDataX Properties IAcdContactStateAdvancedDataListX Properties Methods...78 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 7

8 Content IAcdContactStateAdvancedDataX Properties IAcdContactStateChangeInfoDataX Properties IAcdContactStateDataListX Properties Methods IAcdContactStateDataX Properties IAcdContactStateInfoDataX Properties IAcdExitPostProcessingStateDataX Properties IAcdGetBusinessUnitForExtensionDataX Properties IAcdGetBusinessUnitForUserIdDataX Properties IAcdGetBusinessUnitsDataX Properties IAcdGetCallInformationDataX Properties Methods IAcdGetPostProcessingReasonsDataX Properties IAcdGetPostProcessingStateDataX Properties IAcdGetQueuesDataX Properties Methods IAcdGetTeamsDataX Properties Methods IAcdGetUnavailableReasonsDataX Properties Methods IAcdGetUserIdForUserNameDataX Properties IAcdGetUsersDataX Properties IAcdGetUserStateDataX Properties IAcdGetWorkReasonsDataX Properties IAcdGetWrapupReasonsDataX Properties Methods IAcdLogoffDataX Properties OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

9 Content IAcdLogonDataX Properties IAcdMediaTypeDataX Properties IAcdMediaTypeListX Properties Methods IAcdPostProcessingReasonsDataX Properties IAcdPostProcessingReasonsListX Properties Methods IAcdPostProcessingServPermFlagsX Properties Methods IAcdQueueDataListX Properties Methods IAcdQueueDataX Properties IAcdRegisterForFunctionsDataX Properties IAcdRegisterForGlobalEventsDataX Properties IAcdRegisterForNodeEventsDataX Properties IAcdSaveWrapupDataX Properties Methods IAcdSetPostProcessingStateDataX Properties Methods IAcdSetPrimaryContactDataX Properties Methods IAcdTeamDataListX Properties Methods IAcdTeamDataX Properties IAcdUnavailableDataX Properties IAcdUnavailableReasonDataListX Properties Methods IAcdUnavailableReasonDataX Properties IAcdUnregisterForFunctionsDataX OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 9

10 Content Properties IAcdUnregisterForGlobalEventsDataX Properties IAcdUnregisterForNodeEventsDataX Properties IAcdUserConfigDataX Properties IAcdUserDataX Properties IAcdUserDataListX Properties Methods IAcdUserStateChangeInfoDataX Properties IAcdVoiceRingingInfoDataX Properties IAcdWorkDataX Properties IAcdWorkReasonDataListX Properties Methods IAcdWorkReasonDataX Properties IAcdWrapupReasonDataX Properties IAcdWrapupReasonKeyDataListX Properties Methods IAcdWrapupReasonKeyDataX Properties IAcdWrapupReasonsDataListX Properties Methods IAgentAvailableDataX Properties Methods IAgentLogoffDataX Properties Methods IAgentLogonDataX Properties Methods IAgentStateChangeInfoDataX Properties IAgentUnavailableDataX Properties Methods IAgentWorkDataX OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

11 Content Properties Methods IAlternateCallDataX Properties Methods IAnswerCallDataX Properties Methods ICallbackInfoDataX Properties ICallDisconnectOnHeldInfoDataX Properties ICallEstablishedInfoDataX Properties ICallPickupInfoDataX Properties ICheckMonitoringDeviceDataX Properties Methods IClearConnectionDataX Properties Methods ICommonConfigDataX Properties IConferenceCallDataX Properties Methods IConferenceInfoDataX Properties IConfigDataX Properties IConnectionDataX Properties IConnectionListX Properties Methods IConsultCallDataX Properties Methods ICreateCallbackDataX Properties Methods ICstaErrorX Properties Methods ICtiConnectivityConfigDataX Properties IDeflectCallDataX OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 11

12 Content Properties Methods IDeleteCallbackDataX Properties Methods IDialDigitsDataX Properties Methods IExtensionCallDataX Properties IExtensionCallListX Properties Methods IFailoverInfoDataX Properties IGetAgentStateDataX Properties Methods IGetAgentStateOsvHuntgroupDataX Properties Methods IGetDoNotDisturbDataX Properties Methods IGetExtensionCallListDataX Properties IGetForwardingDataX Properties Methods IGetPhoneStateDataX Properties IHoldCallDataX Properties Methods ILoggingConfigDataX Properties IMakeCallDataX Properties Methods IOldCallIdListX Properties Methods IPartyDataX Properties IPartyListX Properties Methods IPhoneCallStateChangeInfoDataX OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

13 Content Properties IPhoneClearedInfoDataX Properties IPhoneDialingInfoDataX Properties IPhoneRingingInfoDataX Properties IPhoneStateBusyInfoDataX Properties IPhoneStateChangeInfoDataX Properties IReconnectCallDataX Properties Methods IRetrieveCallDataX Properties Methods ISendDTMFDataX Properties Methods IServerConnectionStateChangeDataX Properties ISetAgentStateOsvHuntgroupDataX Properties Methods ISetForwardingDataX Properties Methods ISingleStepTransferCallDataX Properties Methods ISiteStateInfoDataX Properties ISnapshotAdvCallListX Properties Methods ISnapshotAdvCallX Properties Methods ISnapshotDeviceAdvancedDataX Properties Methods ISnapshotDeviceDataX Properties Methods IStartMonitorDeviceDataX Properties Methods OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 13

14 Content IStopMonitorDeviceDataX Properties Methods ITransferCallDataX Properties Methods ITransferCompletedInfoDataX Properties ITransferedInfoDataX Properties IUserAgentServPermFlagsX Properties Realtime Basics System architecture Application example COM DLL Registration of the interface library Establishing a connection with the Connectivity Server Receiving data Agents Application development with Java API Integration of the Java API Establishing a connection with the Connectivity Server Receiving data Enumeration types EnumAgentColumnType EnumAgentState (only OSCC V7) EnumCallType EnumDataType EnumErrorCode EnumGroupColumnType EnumLoggedOnMedia EnumMediaType EnumNodeType EnumQueueColumnType EnumServerErrorType EnumServerState EnumUserHandlingState (only OSCC V8) EnumUserPresenceState (only OSCC V8) EnumUserRoutingState (only OSCC V8) EnumValid Classes IRealtimeLink Properties Methods OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

15 Content Events IAcdContact Properties IAcdContactList Properties Methods IAcdStep Properties IAcdStepList Properties Methods IAgentColumnConfig Properties IAgentColumnConfigList Properties Methods IAgentConfig Properties IAgentObject Properties IAgentObjectList Properties Methods IAgentsData Properties IColumnConfig Properties IConfiguredViewsEvent Properties IGroupColumnConfig Properties IGroupColumnConfigList Properties Methods IGroupConfig Properties IGroupObject Properties IGroupObjectList Properties Methods IGroupData Properties ILogoffResponse Properties ILogonResponse OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 15

16 Content Properties IQueueColumnConfig Properties IQueueColumnConfigList Properties Methods IQueueConfig Properties IQueueObject Properties IQueueObjectsList Properties Methods IQueuesData Properties IQueueVirtualAgentObject Properties IQueueVirtualAgentObjectsList Properties ITeamConfig Properties ITeamEntry Properties ITeamList Properties Methods IServerErrorEvent Properties IVirtualAgentObject Properties IVirtualAgentObjectsList Properties IVirtualAgentsData Properties OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

17 About this guide Important product information 1 About this guide 1.1 Important product information The documentation describes the interface library of the Integration Connector. The CTI interface library is used by application programs with telephony and agent control functions based on the Integration Connector. The real-time interface library is used to create real-time frontend applications. This documentation is intended for software developers and project managers. This guide applies to OSCC-E and the Solution Kit. It contains the entire pallet of the interface library. The following features are not part of the OSCC-E: CallCoding Journal via Journal Server. Voice recording via ASC node. Connect balancing (only available for OS Concierge) 1.2 Overview of contents Section 2.1 Briefly describes the basics needed for application development with the CTI interface library of the OSCC-E server. At select locations below, examples are given in VisualBasic. Section 2.2 Explains the enumeration types of the CTI library. Section 2.3 Describes the "CocCtiConnector" class in detail according to the property procedures, methods and events. Section 2.4 Describes other classes of the CTI library. Section 2.5 Describes the interfaces of the CTI library. Section 3.1 Briefly describes the basics needed for application development with the real-time interface library of the OSCC-E server. The following subchapters contain application examples in the C# and Java languages. OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 17

18 About this guide Typographical styles Section 3.2 Explains the enumeration types of the real-time library. Section 3.3 Describes the "RealtimeLink" class in detail according to the property procedures, methods and events. Section Typographical styles Describes the interfaces of the real-time library. Courier is used for parameters and constants. Courier bold is used for methods and event names and for general source code examples and user entries. Courier italics is used for method and event descriptions for type identifiers. In the detailed descriptions of methods, parameter types are differentiated as follows: Value parameters are presented without special identifying marks (e.g. CallID), parameters are underscored (e.g. New_CallID), Optional parameters are indicated by the subscript "opt" (e.g. Sync opt ), and the standard value is presented in the parameter description in square brackets. 18 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

19 Basics 2 CTI 2.1 Basics Important note in advance: As the DLL can only instanciated once, server applications are not programmable with it System architecture The OSCC-E server manages one or more telephone systems and makes functions available for the control of extensions and agents. These functions can be used in application programs via the interface library. The interface library is a COM DLL that makes the CTI and agent control functions of the OSCC-E server available. The interface library can therefore be used in any programming language that exists for a COM implementation, e.g. Visual Basic, Visual C# and Delphi. As shown in the following figure by way of example, the OSCC-E server and the interface library are components of a three-layer CTI system architecture. This architecture can incorporate different telephone systems and call centers/contact centers at the switch level and contains the components of the OSCC-E server at the interface level, which is then addressed on the application level via the interface library. OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 19

20 Basics Application development As the figure shows, the OSCC-E server communicates with each telephone system via a so-called node. A node is uniquely assigned to one telephone system and is identified by a node name. This node communicates with this system via the CSTA protocol. If the telephone system is additionally connected with a call center/contact center which is usually the case the control functions are likewise implemented via the node, namely via the call center SDK functions. Therefore, any necessary version adaptations in the contact center and the associated SDK no longer require adaptations in the client application. In the client application, each connection object an object of the "CustPABXCtiLink" class described below of the interface library is assigned to exactly one node. The interface library communicates with the OSCC-E server via messages using TCP/IP. For this reason, the client system must support socket connection to the OSCC-E server via a defined port. IMPORTANT NOTE: The interface library offers a range of CTI functions comparable to that of the OpenScape Contact Center Desktop which can be used in development projects. The CTI functions and events of the interface library are based on the functions and messages of the CSTA interface of the telephone system. Signaling and the scope of features of this interface differ from the scope of features of HFA end devices (HiPath Feature Access), among other things in passive call situations and conferencing and transfer situations. Therefore, depending on the particular situation, it is possible that the functions and information offered via the interface library may differ from those offered on an end device Registration of the interface library Application examples Before the interface library can be used, it must be registered in the operating system. This can take place in the development environment or directly under Windows with the following command, for example: regsvr32.exe coccustcticonlib.dll The examples provided below are written in C#. Usage is similar in other COM-compatible programming languages. Declaring a connection object using coccustcticonlib; private CocCtiConnector cticonnector; Instantiation of a connection object The connection object must be instantiated before use. cticonnector = new CocCtiConnector();establishment of a connection to the OSCC-E server 20 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

21 Basics The first step after instantiation is to establish the connection to the OSCC-E server. At least the following connection parameters must be specified (the values given here are examples only). this.cticonnector.configdata.cticonnectivityconfigd ata.ipaddress = ; this.cticonnector.configdata.cticonnectivityconfigd ata.ipaddress = ; this.cticonnector.configdata.cticonnectivityconfigd ata.siteid = LOC001 ; this.cticonnector.configdata.cticonnectivityconfigd ata.extension = 1234 ; cticonnector.configdata.cticonnectivityconfigdata.c onnectandmonitor = true; ErrorEnum result = this.cticonnector.open(false); if (result == ErrorEnum.glbOK) { } cticonnector.configdata.cticonnectivityconfigd ata.connectandmonitor = true; Within an application only one connection object can be created. If connection was successful, the Open function returns the value glbok. If not, an error occurred, and an error description can be retrieved with the GetErrorAs function (see below). Terminating the connection When the program ends, the connection to the OSCC-E server should be terminated and the reference to the object should be released. cticonnector.close(); cticonnector = null; Synchronous and asynchronous method execution Control functions for extensions and agents send internal messages to the OSCC-E server and evaluate the responses. Therefore, these control functions can be executed either synchronously or asynchronously. In the case of synchronous execution, the method is not ended until the corresponding replies from the OSCC-E server have arrived and all results are available. When the method is ended, values are assigned to the return parameters and the method result (error or no error) is determined on the basis of the server replies. In the case of the asynchronous execution, the method is ended after the messages are sent to the OSCC-E server without waiting for its reply. When the method is ended, no values are assigned to the return parameters, which is why literal values can be assigned to these parameters when the method is called up. The method result has the value glbok (no error if the parameter test did not identify errors directly after the method was called up). The event belonging to the method OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 21

22 Enumeration types execution then delivers the method result and the values of the return parameters (e.g. the OnMakeCallEvent event for the MakeCall method). The method execution mode is controlled via a parameter. Synchronous execution is useful for simple applications in which the method result is associated with immediate replies or changes at the application's user interface (e.g. a change in the state of a button). It is also useful when multiple method calls need to occur in sequence in relation to the individual events. NOTE: In complex applications with a higher event rate or connection parallelism, asynchronous method execution is preferable. The optional parameters of the functions can be used in VB.NET but not in C#. The standard value for the optional parameter Sync is false, i.e. the method is executed asynchronously by default. Commands have to be called and events have to be handled within the application thread created by the connection object Troubleshooting Errors relating to method execution are output in two different ways: Through the result of a method when called synchronously (in case of an error, the result is not equal to glbok), OR Through the result data of an event when called asynchronously. All other errors are indicated by OnErrorEvent. For each error code, a written description for the display or the log file output can be retrieved using the GetErrorAs method. If the error code indicates a CSTA error, the CstaError property delivers a description of the error according to its error class and error value. In addition to the error codes that can be returned by various methods, there are specific error codes that are individually listed below in the method descriptions Status changes among extensions and agents The status of extensions and agents can change due to actions of the application program or through external events (for example, through an incoming call). Changes in the extension status are indicated by the OnPhoneStateChangeInfoEvent event, while changes in the agent status are indicated by the OnAcdUserStateChangeInfoEvent event. After the successful call of a CTI command the application should not allow any other CTI command until the following OnPhoneStateChangeEvent notifies the now permitted commands. 22 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

23 Enumeration types 2.2 Enumeration types AcdContactTypeEnum AcdDequeueReasonEnum AcdFunctionTypeEnum AcdHandlingStateEnum AcdMediaTypeEnum AcdPartyTypeEnum AgentStateOsvHuntgroupEnum ApplicationIdentifierEnum AutoAnswerFlagEnum BusyStateDetailEnum BusyStateEnum CallDirectionEnum CallListChangeNotificationEnum CallStateEnum This enumeration type describes the media type and the assignment method of a contact in the call center. This enumeration type is intended for future functions. This enumeration type describes the special ACD functions. This enumeration type describes the handling state of a contact in the call center. This enumeration type describes the media type of a contact. This enumeration type describes the type of subscriber to which an ACD call is currently assigned. This enumeration type describes the availability status of an agent in a hunt group. This enumeration type describes the type of application in relation to use of the interface library. This enumeration type describes the capability of an analog or digital end device to dial with the handset hung up. This enumeration type describes details on the busy status of an extension. This enumeration type describes the busy status of an extension. This enumeration type describes the direction states of a call. This enumeration type describes a change in a call connected with an extension. This enumeration type describes the states of a call. OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 23

24 Enumeration types ConferenceEventTypeEnum CstaVersionEnum DeviceTypeEnum DoNotDisturbFlagEnum ErrorEnum EventCauseEnum EventTypeEnum ForwardingStateEnum IPVersionEnum LocalConnectionStateEnum LogLevelEnum LogMessageDelimiterEnum This enumeration type describes a change in the state of a conference. This enumeration type describes the version of the underlying CSTA. This enumeration type describes a device type MonitorDeviceHandlingFlagEnum MonitorStateEnum NodeTypeEnum ServerConnectionModeEnum This enumeration type describes the do-not-disturb state of an extension. This enumeration type describes error codes (glbok means "no error"). This enumeration type describes the event reason for a CSTA command. This enumeration type is intended for future functions. This enumeration type is intended for future functions. This enumeration type describes the IP protocol version used. This enumeration type describes the current state of a connection. This enumeration type describes the level of a log message. This enumeration type indicates the delimiter between individual values in log messages. This enumeration type describes the type of monitor handling. This enumeration type describes the monitor state. This enumeration type describes the node type (telephone system, ACD, etc.). This enumeration type describes the connection mode. 24 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

25 Enumeration types ServerConnectionStateEnum ServerTypeEnum SetForwardingActionEnum SiteStateEnum SiteTypeEnum UserAgentStateEnum This enumeration type describes the connection state to the OSCC-E server. This enumeration type describes the type of OSCC-E server. This enumeration type describes the state of the call forwarding. This enumeration type describes the state of a node. This enumeration type describes the node type. This enumeration type describes the routing state in which an agent may be found. OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 25

26 "CocCtiConnector" class 2.3 "CocCtiConnector" class Properties AvailableLicences An object of the CocCtiConnector class makes a connection to the OSCC- E server available via an extension and for an agent registered there. This property contains the number of free licenses for the application type at the time when the connection was established. AvailableLicences Integer ConfigData This property contains all configuration and setting data. ConfigData IConfigDataX ServerConnectionMode This property contains the server connection mode. ServerConnectionMode ServerConnectionModeEnum ServerConnectionState This property contains the server connection state. ServerConnectionState ServerConnectionStateEnum Methods AcdAvailable This method sets the agent for the media type to the "available" state. Table: AcdAvailable AcdAvailable LocationId Node name UserId User ID UserData Additional user data 26 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

27 "CocCtiConnector" class AcdAvailable MediaType AcdMediaTypeEnum Media type Sync opt Boolean Synchronous execution [false] IAcdAvailableDataX Events OnAcdAvailableEvent, OnAcdUserStateChangeInfoEvent Comment MediaType must not be AcdMediaTypeEnum.amtAll AcdCheckPassword AcdCheckPassword This method checks the validity of the password for a user ID. Table: AcdCheckPassword LocationId Node name UserId User ID Password Password UserData Additional user data Sync opt Boolean Synchronous execution [false] IAcdCheckPasswordDataX Events OnAcdCheckPasswordEvent Comment This function can only be called up after the AcdRegisterForGlobalEvents function was executed successfully AcdExitPostProcessingState AcdAvailable This method ends post-processing. Table: AcdExitPostProcessingState LocationId Node name UserId User ID AcdCallId Contact ID RequeueCount Integer Number of requeues UserData Additional user data Sync opt Boolean Synchronous execution [false] OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 27

28 "CocCtiConnector" class AcdAvailable IAcdExitPostProcessingStateDataX Events OnAcdExitPostProcessingStateEvent, OnAcdUserStateChangeInfoEvent AcdGetBusinessUnitForExtension This method delivers the business unit for which an extension is set up. Table: AcdGetBusinessUnitForExtension AcdGetBusinessUnitForExtension LocationId Node name Extension Extension UserData Additional user data Sync opt Boolean Synchronous execution [false] IAcdGetBusinessUnitForExtensionDataX Events OnAcdGetBusinessUnitForExtensionEvent AcdGetBusinessUnitForUserId This method delivers the business unit to which an agent belongs. Table: AcdGetBusinessUnitForUserId AcdGetBusinessUnitForUserId LocationId Node name UserId User ID UserData Additional user data Sync opt Boolean Synchronous execution [false] IAcdGetBusinessUnitForUserIdDataX Events OnAcdGetBusinessUnitForUserIdEvent AcdGetBusinessUnits This method delivers the setup business units. Table: AcdGetBusinessUnits AcdGetBusinessUnits LocationId Node name UserData Additional user data 28 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

29 "CocCtiConnector" class AcdGetBusinessUnits Sync opt Boolean Synchronous execution [false] IAcdGetBusinessUnitsDataX Events OnAcdGetBusinessUnitsEvent Comment Result data This message is also available in the restricted connection mode AcdGetCallInformation AcdGetCallInformation This method delivers information on an ACD voice call. Table: AcdGetCallInformation LocationId Node name UserId User ID AcdCallId ACD call ID PabxCallId Call ID UserData Additional user data Sync opt Boolean Synchronous execution [false] IAcdGetCallInformationDataX Events OnAcdGetCallInformationEvent Comment AcdCallId or PabxCallId must contain a value AcdGetPostProcessingReasons AcdGetPostProcessingReasons This method delivers the post-processing activity reasons of the business unit. Table: AcdGetPostProcessingReasons LocationId Node name BusinessUnitName Business unit UserData Additional user data Sync opt Boolean Synchronous execution [false] IGetPostProcessingReasonsDataX Events OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 29

30 "CocCtiConnector" class AcdGetPostProcessingReasons OnAcdGetPostProcessingReasons Comment This method requires OSCC V8 R0 or higher AcdGetPostProcessingState This method delivers the processing states of all active contacts of a user. Table: AcdGetPostProcessingState AcdGetPostProcessingState LocationId Node name UserID User ID UserData Additional user data Sync opt Boolean Synchronous execution [false] IAcdGetPostProcessingStateDataX Events OnAcdGetPostProcessingReasonsEvent Comment This method requires OSCC V8 R0 or higher AcdGetQueues This method delivers the queues set up in a business unit for a media type. Table: AcdGetQueues AcdGetQueues LocationId Node name MediaType AcdMediaTypeEnum Media type BusinessUnit Business unit UserData Additional user data Sync opt Boolean Synchronous execution [false] IAcdGetQueuesDataX Result data Events OnAcdGetQueuesEvent 30 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

31 "CocCtiConnector" class AcdGetTeams This method delivers the teams set up in a business unit. Table: AcdGetTeams AcdGetTeams LocationId Node name BusinessUnit Business unit UserData Additional user data Sync opt Boolean Synchronous execution [false] IAcdGetTeamsDataX Result data Events OnAcdGetTeamsEvent AcdGetUnavailableReasons This method delivers the unavailability reasons defined in a business unit. Table: AcdGetUnavailableReasons AcdGetUnavailableReasons LocationId Node name BusinessUnitName Business unit UserData Additional user data Sync opt Boolean Synchronous execution [false] IAcdGetUnavailableReasonsDataX Result data Events OnAcdGetUnavailableReasonsEvent AcdGetUserIdForUserName This method delivers the user ID for an ACD user name. Table: AcdGetUserIdForUserName AcdGetUserIdForUserName LocationId Node name UserName User name BusinessUnitName Business unit UserData Additional user data Sync opt Boolean Synchronous execution [false] OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 31

32 "CocCtiConnector" class AcdGetUserIdForUserName IGetUserIdForUserNameDataX Events OnAcdGetUserIdForUserName AcdGetUsers This method delivers the users assigned to a business unit for a media type. Table: AcdGetUsers AcdGetUsers LocationId Node name MediaType AcdMediaTypeEnum Media type BusinessUnit Business unit UserData Additional user data Sync opt Boolean Synchronous execution [false] IAcdGetUsersDataX Result data Events OnAcdGetUsersEvent Comment This message is also available in the restricted connection mode AcdGetUserState This method delivers the ACD state of a user. Table: AcdGetUserState AcdGetUserState LocationId Node name UserId User ID UserData Additional user data MediaType AcdMediaTypeEnum Media type Sync opt Boolean Synchronous execution [false] IAcdGetUserStateDataX Result data Events OnAcdGetUserStateEvent 32 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

33 "CocCtiConnector" class AcdGetWorkReasons This method delivers the work reasons defined in a business unit. Table: AcdGetWorkReasons AcdGetWorkReasons LocationId Node name BusinessUnitName Business unit UserData Additional user data Sync opt Boolean Synchronous execution [false] IAcdGetWorkReasonsDataX Result data Events OnAcdGetWorkReasonsEvent AcdGetWrapupReasons This method delivers the wrapup reasons defined in a business unit. Table: AcdGetWrapupReasons AcdGetWrapupReasons LocationId Node name BusinessUnitName Business unit UserData Additional user data Sync opt Boolean Synchronous execution [false] IAcdGetWrapupReasonsDataX Result data Events OnAcdGetWrapupReasonsEvent AcdLogoff This method logs off the agent for a media type. Table: AcdLogoff AcdLogoff LocationId Node name UserId User ID UserData Additional user data MediaType AcdMediaTypeEnum Media type Sync opt Boolean Synchronous execution [false] OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 33

34 "CocCtiConnector" class AcdLogoff IAcdLogoffDataX Events OnAcdLogoffEvent, OnAcdUserStateChangeInfoEvent Comment MediaType must not be AcdMediaTypeEnum.amtAll AcdLogon This method logs on the agent for a media type. Table: AcdLogon AcdLogon LocationId Node name UserId User ID UserData Additional user data MediaType AcdMediaTypeEnum Media type Sync opt Boolean Synchronous execution [false] IAcdLogonDataX Events OnAcdLogonEvent, OnAcdUserStateChangeInfoEvent Comment MediaType must not be AcdMediaTypeEnum.amtAll AcdRegisterForFunctions This method registers an agent for special ACD functions. Table: AcdRegisterForFunctions AcdRegisterForFunctions LocationId Node name UserId User ID UserData Additional user data FunctionTypeList AcdContactDataListParamX List of special functions Sync opt Boolean Synchronous execution [false] IAcdRegisterForFunctionsDataX Events OnAcdRegisterForFunctionsEvent 34 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

35 "CocCtiConnector" class AcdRegisterForGlobalEvents AcdRegisterForGlobalEvents This method registers for general ACD events. Table: AcdRegisterForGlobalEvents LocationId Node name UserData Additional user data Sync opt Boolean Synchronous execution [false] IAcdRegisterForGlobalEventsDataX Events OnAcdRegisterForGlobalEventsEvent AcdRegisterForNodeEvents AcdRegisterForNodeEvents This method registers for the media-related events of an agent. Table: AcdRegisterForNodeEvents LocationId Node name UserId User ID UserData Additional user data MediaType AcdMediaTypeEnum Media type Sync opt Boolean Synchronous execution [false] IAcdRegisterForNodeEventsDataX Events OnAcdRegisterForNodeEventsEvent, OnAcdUserStateChangeInfoEvent, OnAcdUserStateInfoEvent Comment MediaType must not be AcdMediaTypeEnum.amtAll AcdSaveWrapupData AcdSaveWrapupData This method saves the wrapup reasons for a contact. Table: AcdSaveWrapupData LocationId Node name UserId User ID AcdCallId ACD contact ID OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 35

36 "CocCtiConnector" class AcdSaveWrapupData WrapupReasonKeyList AcdWrapupReasonKeyDataListParamX List of keys of the wrapup reasons QueueKey Integer Queue key RequeueCount Integer Number of requeues UserData Additional user data Sync opt Boolean Synchronous execution [false] IAcdSaveWrapupDataX Events OnAcdSaveWrapupDataEvent AcdSetPostProcessingState AcdSetPostProcessingState This method makes it possible to change the reason for the post-processing of a contact. Table: AcdSetPostProcessingState LocationId Node name UserId User ID ReasonKey Integer Reason key AcdCallId ACD contact ID RequeueCount Integer Number of requeues UserData Additional user data Sync opt Boolean Synchronous execution [false] IAcdSetPostProcessing StateDataX Events OnAcdSetPostProcssingStateEvent Comment This method requires OSCC V8 R0 or higher. 36 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

37 "CocCtiConnector" class AcdSetPrimaryContact AcdSetPrimaryContact This method defines the contact as the primary contact, i.e. the contact currently being processed. Table: AcdSetPrimaryContact LocationId Node name UserId User ID AcdCallId ACD contact ID RequeueCount Integer Number of requeues UserData Additional user data Sync opt Boolean Synchronous execution [false] IAcdSetPrimaryContactDataX Events OnAcdSetPrimaryContactEvent Comment This method requires OSCC V8 R1 or higher AcdUnavailable AcdUnavailable This method sets the agent for a media type to the "unavailable" state. Table: AcdUnavailable LocationId Node name UserId User ID UserData Additional user data MediaType AcdMediaTypeEnum Media type ReasonCode Integer Unavailability reasons Sync opt Boolean Synchronous execution [false] IAcdUnavailableDataX Events OnAcdUnavailableEvent, OnAcdUserStateChangeInfoEvent Comment MediaType must not be AcdMediaTypeEnum.amtAll. OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 37

38 "CocCtiConnector" class AcdUnregisterForFunctions This method deregisters an agent for special ACD functions. Table: AcdUnregisterForFunctions AcdRegisterForFunctions LocationId Node name UserId User ID UserData Additional user data FunctionTypeList AcdFunctionTypeListParam List of special functions Sync opt Boolean Synchronous execution [false] IAcdUnregisterForFunctionsDataX Events OnAcdUnregisterForFunctionsEvent AcdUnregisterForGlobalEvents This method deregisters for general ACD events. Table: AcdUnregisterForGlobalEvents AcdUnregisterForGlobalEvents LocationId Node name UserData Additional user data Sync opt Boolean Synchronous execution [false] IAcdUnregisterForGlobalEventsDataX Events OnAcdUnregisterForGlobalEventsEvent AcdUnregisterForNodeEvents This method deregisters for the media-related events of an agent. Table: AcdUnregisterForNodeEvents AcdUnregisterForNodeEvents LocationId Node name UserId User ID UserData Additional user data MediaType AcdMediaTypeEnum Media type Sync opt Boolean Synchronous execution [false] 38 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

39 "CocCtiConnector" class AcdUnregisterForNodeEvents IAcdUnregisterForNodeEventsDataX Events OnAcdUnregisterForNodeEventsEvent Comment MediaType must not be AcdMediaTypeEnum.amtAll AcdWork This method sets the agent for a media type to the "work" state. Table: AcdWork AcdWork LocationId Node name UserId User ID UserData Additional user data MediaType AcdMediaTypeEnum Media type ReasonCode Integer Work reason Sync opt Boolean Synchronous execution [false] IAcdWorkDataX Events OnAcdWorkEvent, OnAcdUserStateChangeInfoEvent Comment MediaType must not be AcdMediaTypeEnum.amtAll AgentAvailable This method sets the agent state of an extension to the "available" state. Table: AgentAvailable AgentAvailable Extension Extension Sync opt Boolean Synchronous execution [false] IAgentAvailableDataX Events OnAgentAvailableEvent, OnAgentStateChangeInfoEvent Comment OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 39

40 "CocCtiConnector" class AgentAvailable This method is used to modify the agent state of an extension administrated in the HiPath This agent state permits an ACD routing independent of the OpenScape ContactCenter and is primarily used for emergency routing. If the agent ID corresponds to the registered OSCC user ID, this also changes the OSCC routing state and this change is displayed in the OnAcdUserStateChangeInfoEvent AgentLogoff This method sets the agent state of an extension to the "logged off" state. Table: AgentLogoff AgentLogoff Extension Extension Sync opt Boolean Synchronous execution [false] IAgentLogoffDataX Events OnAgentLogoffEvent, OnAgentStateChangeInfoEvent Comment This method is used to modify the agent state of an extension administrated in the HiPath This agent state permits an ACD routing independent of the OpenScape ContactCenter and is primarily used for emergency routing. If the agent ID corresponds to the registered OSCC user ID, this also changes the OSCC routing state and this change is displayed in the OnAcdUserStateChangeInfoEvent AgentLogon This method sets the agent state of an extension to the "logged on" state. Table: AgentLogon AgentLogon Extension Extension Sync opt Boolean Synchronous execution [false] IAgentLogonDataX Events OnAgentLogonEvent, OnAgentStateChangeInfoEvent Comment This method is used to modify the agent state of an extension administrated in the HiPath This agent state permits an ACD routing independent of the OpenScape ContactCenter and is primarily used for emergency routing. If the agent ID corresponds to the registered OSCC user ID, this also changes the OSCC routing state and this change is displayed in the OnAcdUserStateChangeInfoEvent. 40 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

41 "CocCtiConnector" class AgentUnavailable AgentUnavailable This method sets the agent state of an extension to the "available" state. Table: AgentUnavailable Extension Extension Sync opt Boolean Synchronous execution [false] IAgentUnavailableDataX Events OnAgentUnavailableEvent, OnAgentStateChangeInfoEvent Comment This method is used to modify the agent state of an extension administrated in the HiPath This agent state permits an ACD routing independent of the OpenScape ContactCenter and is primarily used for emergency routing. If the agent ID corresponds to the registered OSCC user ID, this also changes the OSCC routing state and this change is displayed in the OnAcdUserStateChangeInfoEvent AgentWork This method sets the agent state of an extension to the "work" state. Table: AgentWork AgentWork Extension Extension Sync opt Boolean Synchronous execution [false] IAgentWorkDataX Events OnAgentWorkEvent, OnAgentStateChangeInfoEvent Comment This method is used to modify the agent state of an extension administrated in the HiPath This agent state permits an ACD routing independent of the OpenScape ContactCenter and is primarily used for emergency routing. If the agent ID corresponds to the registered OSCC user ID, this also changes the OSCC routing state and this change is displayed in the OnAcdUserStateChangeInfoEvent AlternateCall This method alternates between a current call and a call on hold. Table: AlternateCall AlternateCall Extension Extension OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 41

42 "CocCtiConnector" class AlternateCall CallId ID of call CallIdOnHold ID of call on hold Sync opt Boolean Synchronous execution [false] IAlternateCallDataX Events OnAlternateCallEvent Comment Result data If an empty string is passed to each of the Extension, CallId and CallIdOnHold parameters, toggling occurs between the current call and the call on hold AnswerCall This method answers a call. Table: AnswerCall AnswerCall Extension Extension CallId ID of call Sync opt Boolean Synchronous execution [false] IAnswerCallDataX Result data Events OnAnswerCallEvent, OnPhoneStateChangeInfoEvent Comment If an empty string is passed to each of the Extension and CallId parameters, the current call is accepted CheckMonitoringDevice This method checks the monitoring status of an extension. Table: CheckMonitoringDevice CheckMonitoringDevice Extension Extension UserData Additional user data Sync opt Boolean Synchronous execution [false] ICheckMonitoringDeviceDataX Result data Events OnCheckMonitoringDeviceEvent 42 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

43 "CocCtiConnector" class ClearConnection ClearConnection This method terminates a call. Table: ClearConnection Extension Extension CallId ID of call Trunc opt Trunk number of an external connection [""] Sync opt Boolean Synchronous execution [true] IClearConnectionDataX Events Result data OnClearConnectionEvent, OnPhoneStateChangeInfoEvent Comment If an empty string is passed to each of the Extension, CallId and Trunc parameters, the current call is terminated Close This method closes the current connection to the OSCC-E server ConferenceCall ConferenceCall This method connects a call on hold with another call to form a conference call. Table: ConferenceCall Extension Extension CallId ID of call CallIdOnHold ID of call on hold Sync opt Boolean Synchronous execution [false] IConferenceCallDataX Events Result data OnConferenceCallEvent, OnConferenceInfoEvent, OnPhoneStateChangeInfoEvent Comment If an empty string is passed to each of the Extension, CallId and CallIdOnHold parameters, the call on hold is added to the conference. OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 43

44 "CocCtiConnector" class ConsultCall This method places a call on hold and initiates a consultation call. Table: ConsultCall ConsultCall Extension Extension CallId ID of call Destination Destination of consultation call AutoAnswerFlag AutoAnswerFlagEnum Dial while handset is hung up Sync opt Boolean Synchronous execution [false] IConsultCallDataX Events Result data OnConsultCallEvent, OnPhoneStateChangeInfoEvent Comment If an empty string is passed to each of the Extension and CallId parameters, a consultation call is established for the current call CreateCallback CreateCallback This method sets up a callback request at the extension for a call that could not be accepted by the called extension due to its state. Table: CreateCallback Extension Extension CallId ID of call Sync opt Boolean Synchronous execution [false] ICreateCallbackDataX Events Result data OnCreateCallbackEvent, OnPhoneStateChangeInfoEvent Comment The callback takes place from the telephone system to the extension as soon as the called extension is ready to receive a call. 44 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

45 "CocCtiConnector" class DeflectCall This method deflects a call to another destination number. Table: DeflectCall DeflectCall Extension Extension CallID ID of call Destination Deflection destination Sync opt Boolean Synchronous execution [false] IDeflectCallDataX Events Result data OnDeflectCallEvent, OnPhoneStateChangeInfoEvent Comment If an empty string is passed to each of the Extension and CallId parameters, the current call is deflected. If an extension is in the idle state and a ringing call should be accepted by another extension, the other extension should be entered under "Extension" and the own extension should be entered under "Destination" DeleteCallback This method deletes a callback request to another extension. Table: DeleteCallback DeleteCallback Extension Extension Destination Destination extension Sync opt Boolean Synchronous execution [false] IDeleteCallbackDataX Result data Events OnDeleteCallbackEvent DialDigits This method dials a number sequence in cut-through dialing (non-block dialing). Table: DialDigits DialDigits Extension Extension CallId ID of call OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 45

46 "CocCtiConnector" class DialDigits Digits Number sequence Sync opt Boolean Synchronous execution [false] IDialDigitsDataX Long 0 = no error Events OnDialDigitsEvent GetAgentState This method checks the agent status of an extension. Table: GetAgentState GetAgentState Extension Extension Sync opt Boolean Synchronous execution [false] IGetAgentStateDataX Events OnFailoverInfoEvent GetAgentStateOsvHuntgroup This method checks the agent status of a hunt group extension. Table: GetAgentStateOsvHuntgroup GetAgentStateOsvHuntgroup Extension Extension Sync opt Boolean Synchronous execution [false] IGetAgentStateOsvHuntgroupDataX Events OnGetAgentStateOsvHuntgroupEvent GetDoNotDisturb This method checks the do-not-disturb state of the logged-on extension. Table: GetDoNotDisturb GetDoNotDisturb Sync opt Boolean Synchronous execution [false] IGetDoNotDisturbDataX 46 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

47 "CocCtiConnector" class GetDoNotDisturb Events OnGetDoNotDisturbEvent GetErrorAs This method delivers a descriptive text for an error code. Table: GetErrorAs GetErrorAs ErrorEnum Error code GetExtensionCallList This method delivers the calls currently connected with an extension. Table: GetExtensionCallList GetExtensionCallList Extension Extension IGetExtensionCallListDataX GetForwarding This method checks the forwarding state of the logged-on extension. Table: GetForwarding GetForwarding Sync opt Boolean Synchronous execution [false] IGetForwardingDataX Events OnGetForwardingEvent GetPhoneState This method delivers the status of an extension. Table: GetPhoneState GetForwarding Extension Extension OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 47

48 "CocCtiConnector" class GetForwarding IGetPhoneStateDataX HoldCall This method places a connection on hold (during which the caller usually hears a message on hold or music on hold through the telephone system). Table: HoldCall HoldCall Extension Extension CallId ID of call Sync opt Boolean Synchronous execution [false] IHoldCallDataX Events OnHoldCallEvent, OnPhoneStateChangeInfoEvent Comment If an empty string is passed to the Extension parameter, the current call is placed on hold IsExtensionOutOfService This checks whether an extension is out of service. Table: IsExtensionOutOfService IsExtensionOutOfService Extension Extension Boolean MakeCall This method initiates an outgoing call. Table: MakeCall MakeCall Extension Extension Destination Destination number AutoAnswerFlag EnumAutoAnswerFlag Dial while handset is hung up NumberToDisplay opt Transmitted phone number [""] NameToDisplay opt Transmitted name [""] Sync opt Boolean Synchronous execution optional [true] IMakeCallDataX 48 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

49 "CocCtiConnector" class MakeCall Events OnMakeCallEvent, OnPhoneStateChangeInfoEvent, OnPhoneDialingInfoEvent Comment If an empty string is transferred to the Extension parameter, the call is initiated from the current extension. The usability of the NumberToDisplay and NameToDisplay parameters depends on the settings of the telephone system Open This method opens a connection to the OSCC-E server. Table: Open Open Restricted Boolean Open a connection with restricted functionality ErrorEnum Comment Before this method is called, the IpAddress, Port, SiteId, Extension and ApplicationIdentifier properties must be assigned valid values in the ConfigData. If Restricted is true, only those functions and properties are available that are required prior to a fully valid connection, for example during a user logon. An Extension does not need to be set for this logon ReconnectCall This method terminates a consultation call and returns to the call on hold. Table: ReconnectCall ReconnectCall Extension Extension CallId ID of call CallIdOnHold ID of call on hold Sync opt Boolean Synchronous execution [false] IReconnectCallDataX Events OnReconnectCallEvent, OnPhoneStateChangeInfoEvent Comment If an empty string is passed to each of the Extension, CallId and CallIdOnHold parameters, you return to the current call. OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 49

50 "CocCtiConnector" class RetrieveCall This method retrieves a call on hold. Table: RetrieveCall RetrieveCall Extension Extension CallId ID of call Sync opt Boolean Synchronous execution [false] IRetrieveCallDataX Events OnRetrieveCallEvent, OnPhoneStateChangeInfoEvent Comment If an empty string is passed to each of the Extension and CallId parameters, you return to the current call SendDTMF This method sends a command sequence using DTMF dialing within an active call. Table: SendDTMF SendDTMF Extension Extension CallId ID of call Digits Command sequence Sync opt Boolean Synchronous execution [false] ISendDTMFDataX Events OnSendDTMFEvent Comment The command sequence may only contain the digits "0" to "9", the letters "A" to "D" and the symbols "*" and "#" SetAgentStateOsvHuntgroup SetAgentStateOsvHuntgroup This method sets the agent status of a hunt group extension. Table: SetAgentStateOsvHuntgroup Extension Extension AgentState AgentStateOsvHuntgroupEnum 50 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

51 "CocCtiConnector" class SetAgentStateOsvHuntgroup Sync opt Boolean Synchronous execution [false] ISetAgentStateOsvHuntgroupDataX Events OnSetAgentStateOsvHuntgroupEvent SetForwarding This method sets the forwarding state of the logged-on extension. Table: SetForwarding SetForwarding Destination Forwarding destination Action SetForwardingActionEnum Forwarding action Sync opt Boolean Synchronous execution [false] ISetForwardingDataX Events OnSetForwardingEvent SingleStepTransferCall SingleStepTransferCall This method transfers a call without consultation (blind transfer) to another extension. Table: SingleStepTransferCall Extension Extension CallId ID of call Destination Transfer destination Sync opt Boolean Synchronous execution [false] ISingleStepTransferCallDataX Events OnSingleStepTransferCallEvent, OnPhoneStateChangeInfoEvent, OnTransferCompletedEvent Comment If an empty string is passed to each of the Extension and CallId parameters, the current call is forwarded. Because the messages may be incomplete at the end of this command, depending on the system, it is recommended to implement this command as a ConsultCall-TransferCall sequence. OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 51

52 "CocCtiConnector" class SnapshotDevice This method delivers the current device status of an extension. Table: SnapshotDevice SnapshotDevice Extension Extension UserData Additional user data Sync opt Boolean Synchronous execution [false] ISnapshotDeviceDataX Events OnSnapshotDeviceEvent SnapshotDeviceAdvanced SnapshotDeviceAdvanced This method delivers the current connection state of an extension. Table: SnapshotDeviceAdvanced Extension Extension UserData Additional user data Sync opt Boolean Synchronous execution [false] ISnapshotDeviceAdvancedDataX Events OnSnapshotDeviceAdvancedEvent StartMonitorDevice StartMonitorDevice This method starts the monitoring of the busy lamp field state of an extension. Table: StartMonitorDevice Extension Extension UserData Additional user data Sync opt Boolean Synchronous execution [false] IStartMonitorDeviceDataX Events OnStartMonitorDeviceEvent 52 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

53 "CocCtiConnector" class StopMonitorDevice StopMonitorDevice This method ends the monitoring of the busy lamp field state of an extension. Table: StopMonitorDevice Extension Extension Sync opt Boolean Synchronous execution [false] IStopMonitorDeviceDataX Events OnStopMonitorDeviceEvent TransferCall This method transfers a call on hold to another extension from a consultation call. Table: TransferCall TransferCall Extension Extension CallId ID of call CallIdOnHold ID of call on hold Sync opt Boolean Synchronous execution [false] ITransferCallDataX Events OnTransferCallEvent, OnPhoneStateChangeInfoEvent, OnTransferCompletedInfoEvent Comment If an empty string is passed to each of the Extension, CallId and CallIdOnHold parameters, the call currently on hold is forwarded. OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 53

54 "CocCtiConnector" class Events OnAcdAgentStateChangeInfoEvent OnAcdAgentStateChangeInfoEvent This event shows a change in the routing state of the agent. This event can only occur in a nonstandard OSCC-E-V2 configuration when using the HPPC connector. Table: OnAcdAgentStateChangeInfoEvent EventData IAcdAgentStateChangeInfoDataX Result data OnAcdAvailableEvent This event shows the result of an asynchronous call of the AcdAvailable method. OnAcdAvailableEvent Table: OnAcdAvailableEvent EventData IAcdAvailableDataX Result data OnAcdCheckPasswordEvent OnAcdCheckPasswordEvent This event shows the result of an asynchronous call of the AcdCheckPassword method. Table: OnAcdCheckPasswordEvent EventData IAcdCheckPasswordDataX Result data OnAcdContactStateChangeInfoEvent OnAcdContactStateChangeInfoEvent This event shows a status change in an ACD contact (OSCC V8 R1 or higher). Table: OnAcdContactStateChangeInfoEvent EventData IAcdContactStateChangeInfoDataX Result data OnAcdContactStateInfoEvent OnAcdContactStateInfoEvent This event shows detailed information on the state of an ACD contact after a change or an action (OSCC V8 R1 or higher). Table: OnAcdContactStateInfoEvent EventData IAcdContactStateInfoDataX Result data 54 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

55 "CocCtiConnector" class OnAcdExitPostProcessingStateEvent OnAcdExitPostProcessingStateEvent This event shows the result of an asynchronous call of the AcdExitPostProcessingState method (OSCC V8 R0 or higher). Table: OnAcdExitPostProcessingStateEvent EventData IAcdExitPostProcessingStateDataX Result data OnAcdGetBusinessUnitForExtensionEvent OnAcdGetBusinessUnitForExtensionEvent This event shows the result of an asynchronous call of the AcdGetBusinessUnitForExtension method. Table: OnAcdGetBusinessUnitForExtensionEvent EventData IAcdGetBusinessUnitForExtensionDataX Result data OnAcdGetBusinessUnitForUserIdEvent OnAcdGetBusinessUnitForUserIdEvent This event shows the result of an asynchronous call of the AcdGetBusinessUnitForUserId method. Table: OnAcdGetBusinessUnitForUserIdEvent EventData IAcdGetBusinessUnitForUserIdDataX Result data OnAcdGetBusinessUnitsEvent OnAcdGetBusinessUnitsEvent This event shows the result of an asynchronous call of the AcdGetBusinessUnits method. Table: OnAcdGetBusinessUnitsEvent EventData IAcdGetBusinessUnitsDataX Result data OnAcdGetCallInformationEvent OnAcdGetCallInformationEvent This event shows the result of an asynchronous call of the AcdGetCallInformation method. Table: OnAcdGetCallInformationEvent EventData IAcdGetCallInformationDataX Result data OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 55

56 "CocCtiConnector" class OnAcdGetPostProcessingReasonsEvent OnAcdGetPostProcessingReasonsEvent This event shows the result of an asynchronous call of the AcdGetPostProcessingReasons method (OSCC V8 R0 or higher). Table: OnAcdGetPostProcessingReasonsEvent EventData IAcdGetPostProcessingReasonsDataX Result data OnAcdGetPostProcessingStateEvent OnAcdGetPostProcessingStateEvent This event shows the result of an asynchronous call of the AcdGetPostProcesssingState method (OSCC V8 R0 or higher). Table: OnAcdGetPostProcessingStateEvent EventData IAcdGetPostProcessingStateDataX Result data OnAcdGetQueuesEvent This event shows the result of an asynchronous call of the AcdGetQueue method. OnAcdGetQueuesEvent Table: OnAcdGetQueuesEvent EventData IAcdGetQueuesDataX Result data OnAcdGetTeamsEvent This event shows the result of an asynchronous call of the AcdGetTeams method. OnAcdGetTeamsEvent Table: OnAcdGetTeamsEvent EventData IAcdGetTeamsDataX Result data OnAcdGetUnavailableReasonsEvent OnAcdGetUnavailableReasonsEvent This event shows the result of an asynchronous call of the AcdGetUnavailableReason method. Table: OnAcdGetUnavailableReasonsEvent EventData IAcdGetUnavailableReasonsDataX Result data 56 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

57 "CocCtiConnector" class OnAcdGetUserIdForUserNameEvent OnAcdGetUserIdForUserNameEvent This event shows the result of an asynchronous call of the AcdGetUserIdForUserName method. Table: OnAcdGetUserIdForUserNameEvent EventData IAcdGetUserIdForUserNameDataX Result data OnAcdGetUsersEvent This event shows the result of an asynchronous call of the AcdGetUsers method. OnAcdGetUsersEvent Table: OnAcdGetUsersEvent EventData IAcdGetUsersDataX Result data OnAcdGetUserStateEvent OnAcdGetUserStateEvent This event shows the result of an asynchronous call of the AcdGetUserState method. Table: OnAcdGetUserStateEvent EventData IAcdGetUserStateDataX Result data OnAcdGetWorkReasonsEvent OnAcdGetWorkReasonsEvent This event shows the result of an asynchronous call of the AcdGetWorkReasons method. Table: OnAcdGetWorkReasonsEvent EventData IAcdGetWorkReasonsDataX Result data OnAcdGetWrapupReasonsEvent OnAcdGetWrapupReasonsEvent This event shows the result of an asynchronous call of the AcdGetWrapupReasons method. Table: OnAcdGetWrapupReasonsEvent EventData IAcdGetWrapupReasonsDataX Result data OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 57

58 "CocCtiConnector" class OnAcdLogoffEvent This event shows the result of an asynchronous call of the AcdLogoff method. OnAcdLogoffEvent Table: OnAcdLogoffEvent EventData IAcdLogoffDataX Result data OnAcdLogonEvent This event shows the result of an asynchronous call of the AcdLogon method. OnAcdLogonEvent Table: OnAcdLogonEvent EventData IAcdLogonDataX Result data OnAcdRegisterForFunctionsEvent OnAcdRegisterForFunctionsEvent This event shows the result of an asynchronous call of the AcdRegisterForFunctions method. Table: OnAcdRegisterForFunctionsEvent EventData IAcdRegisterForFunctionsDataX Result data OnAcdRegisterForGlobalEventsEvent OnAcdRegisterForGlobalEventsEvent This event shows the result of an asynchronous call of the AcdRegisterForGlobalEvents method. Table: OnAcdRegisterForGlobalEventsEvent EventData IAcdRegisterForGlobalEventsDataX Result data OnAcdRegisterForNodeEventsEvent OnAcdRegisterForNodeEventsEvent This event shows the result of an asynchronous call of the AcdRegisterForNodeEvents method. Table: OnAcdRegisterForNodeEventsEvent EventData IAcdRegisterForNodeEventsDataX Result data 58 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

59 "CocCtiConnector" class OnAcdSaveWrapupDataEvent OnAcdSaveWrapupDataEvent This event shows the result of an asynchronous call of the AcdSaveWrapupData method. Table: OnAcdWrapupDataEvent EventData IAcdSaveWrapupDataX Result data OnAcdSetPostProcessingStateEvent OnAcdSetPostProcessingStateEvent This event shows the result of an asynchronous call of the AcdSetPostProcessingState method (OSCC V8 R0 or higher). Table: OnAcdSetPostProcessingStateEvent EventData IAcdSetPostProcessingStateDataX Result data OnAcdSetPrimaryContactEvent OnAcdSetPrimaryContactEvent This event shows the result of an asynchronous call of the AcdSetPrimaryContact method (OSCC V8 R1 or higher). Table: OnAcdSetPrimaryContactEvent EventData IAcdSetPrimaryContactDataX Result data OnAcdUnavailableEvent This event shows the result of an asynchronous call of the AcdUnavailable method. OnAcdUnavailableEvent Table: OnAcdUnavailableEvent EventData IAcdUnavailableDataX Result data OnAcdUnregisterForFunctionsEvent OnAcdUnregisterForFunctionsEvent This event shows the result of an asynchronous call of the AcdUnregisterForFunctions method. Table: OnAcdUnregisterForFunctionsEvent EventData IAcdUnregisterForFunctionsDataX Result data OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 59

60 "CocCtiConnector" class OnAcdUnregisterForGlobalEventsEvent OnAcdUnregisterForGlobalEventsEvent This event shows the result of an asynchronous call of the AcdUnregisterForGlobalEvents method. Table: OnAcdUnregisterForGlobalEventsEvent EventData IAcdUnregisterForGlobalEventsDataX Result data OnAcdUnregisterForNodeEventsEvent OnAcdUnregisterForNodeEventsEvent This event shows the result of an asynchronous call of the AcdUnregisterForNodeEvents method. Table: OnAcdUnregisterForNodeEventsEvent EventData IAcdUnregisterForNodeEventsDataX Result data OnAcdUserStateChangeInfoEvent OnAcdUserStateChangeInfoEvent This event shows a change in the ACD user state. Table: OnAcdUserStateChangeInfoEvent EventData IAcdUserStateChangeInfoDataX Result data OnAcdVoiceRingingInfoEvent OnAcdVoiceRingingInfoEvent This event shows an incoming ACD call. Table: OnAcdVoiceRingingInfoEvent EventData IAcdVoiceRingingInfoDataX Result data OnAcdWorkEvent This event shows the result of an asynchronous call of the AcdWork method. OnAcdWorkEvent Table: OnAcdWorkEvent EventData IAcdWorkDataX Result data 60 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

61 "CocCtiConnector" class OnAgentAvailableEvent This event shows the result of an asynchronous call of the AgentAvailable method. OnAgentAvailableEvent Table: OnAgentAvailableEvent EventData IAgentAvailableDataX Result data OnAgentLogoffEvent This event shows the result of an asynchronous call of the AgentLogoff method. OnAgentLogoffEvent Table: OnAgentLogoffEvent EventData IAgentLogoffDataX Result data OnAgentLogonEvent This event shows the result of an asynchronous call of the AgentLogon method. OnAgentLogonEvent Table: OnAgentLogonEvent EventData IAgentLogonDataX Result data OnAgentStateChangeInfoEvent OnAgentStateChangeInfoEvent This event shows a change in the agent status of a phone number. Table: OnAgentStateChangeInfoEvent EventData IAgentStateChangeInfoDataX Result data OnAgentUnavailableEvent This event shows the result of an asynchronous call of the AgentUnavailab method. OnAgentUnavailableEvent Table: OnAgentUnavailableEvent EventData IAgentUnavailableDataX Result data OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 61

62 "CocCtiConnector" class OnAgentWorkEvent This event shows the result of an asynchronous call of the AgentWork method. OnAgentWorkEvent Table: OnAgentWorkEvent EventData IAgentWorkDataX Result data OnAlternateCallEvent This event shows the result of an asynchronous call of the AlternateCall method. OnAlternateCallEvent Table: OnAlternateCallEvent EventData IAlternateCallDataX Result data OnAnswerCallEvent This event shows the result of an asynchronous call of the AnswerCall method. OnAnswerCallEvent Table: OnAnswerCallEvent EventData IAnswerCallDataX Result data OnCallbackInfoEvent OnCallbackInfoEvent This event shows the placement of a desired callback. Table: OnCallbackInfoEvent EventData ICallbackInfoDataX Result data OnCallDisconnectOnHeldInfoEvent OnCallDisconnectOnHeldInfoEvent This event shows the end of a call. Table: OnCallDisconnectOnHeldInfoEvent EventData ICallDisconnectOnHeldInfoDataX Result data 62 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

63 "CocCtiConnector" class OnCallEstablishedInfoEvent OnCallEstablishedInfoEvent This event shows the acceptance of a call. Table: OnCallEstablishedInfoEvent EventData ICallEstablishedInfoDataX Result data OnCallPickupInfoEvent OnCallPickupInfoEvent This event shows the acceptance of a call without signaling (pickup). Table: OnCallPickupInfoEvent EventData ICallPickupInfoDataX Result data OnCheckMonitoringDeviceEvent OnCheckMonitoringDeviceEvent This event shows the result of an asynchronous call of the CheckMonitoringDevice method. Table: OnCheckMonitoringEvent EventData ICheckMonitoringDeviceDataX Result data OnClearConnectionEvent This event shows the result of an asynchronous call of the ClearConnection method. OnClearCallEvent Table: OnClearConnectionEvent EventData IClearConnectionDataX Result data OnConferenceCallEvent This event shows the result of an asynchronous call of the ConferenceCall method. OnConferenceCallEvent Table: OnConferenceCallEvent EventData IConferenceCallDataX Result data OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 63

64 "CocCtiConnector" class OnConferenceInfoEvent This event shows a change in the conference state. Table: OnConferenceInfoEvent OnConferenceInfoEvent EventData IConferenceInfoDataX Result data OnConsultCallEvent This event shows the result of an asynchronous call of the ConsultCall method. OnConsultCallEvent Table: OnConsultCallEvent EventData IConsultCallDataX Result data OnCreateCallbackEvent This event shows the result of an asynchronous call of the CreateCallback method. OnCreateCallbackEvent Table: OnCreateCallbackEvent EventData ICreateCallbackDataX Result data OnDeflectCallEvent This event shows the result of an asynchronous call of the DeflectCall method. OnDeflectCallEvent Table: OnDeflectCallEvent EventData IDeflectCallDataX Result data OnDeleteCallbackEvent This event shows the result of an asynchronous call of the DeleteCallback method. OnDeleteCallbackEvent Table: OnDeleteCallbackEvent EventData IDeleteCallbackDataX Result data 64 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

65 "CocCtiConnector" class OnDialDigitsEvent This event shows the result of an asynchronous call of the DialDigits method. OnDialDigitsEvent Table: OnDialDigitsEvent EventData IDialDigitsDataX Result data OnErrorEvent This event shows an error message due to a method call. Table: OnErrorEvent OnErrorEvent. ErrorEnum Error code OnFailoverInfoEvent OnFailoverInfoEvent This event shows whether, in the case of geographically separated OSV instances, an error led to a node change. Table: OnFailoverInfoEvent EventData IFailoverInfoDataX Result data OnGetAgentStateEvent This event shows the result of an asynchronous call of the GetAgentState method. OnGetAgentStateEvent Table: OnGetAgentStateEvent EventData IGetAgentStateDataX Result data OnGetAgentStateOsvHuntgroupEvent OnGetAgentStateOsvHuntgroupEvent This event shows the result of an asynchronous call of the GetAgentStateOsvHuntgroup method. Table: OnGetAgentStateOsvHuntgroupEvent EventData IGetAgentStateOsvHuntgroupDataX Result data OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 65

66 "CocCtiConnector" class OnGetDoNotDisturbEvent OnGetDoNotDisturbEvent This event shows the result of an asynchronous call of the GetDoNotDisturb method. Table: OnGetDoNotDisturbEvent EventData IGetDoNotDisturbDataX Result data OnGetForwardingEvent This event shows the result of an asynchronous call of the GetForwarding method. OnGetForwardingEvent Table: OnGetForwardingEvent EventData IGetForwardingDataX Result data OnHoldCallEvent This event shows the result of an asynchronous call of the HoldCall method. OnHoldCallEvent Table: OnHoldCallEvent EventData IHoldCallDataX Result data OnLoggingEvent OnLoggingEvent This event shows a current log message. Table: OnLoggingEvent LogSession Session LogLevel LogLevelEnum Log level Msg Log message OnMakeCallEvent This event shows the result of an asynchronous call of the MakeCall method. OnMakeCallEvent Table: OnMakeCallEvent EventData IMakeCallDataX Result data 66 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

67 "CocCtiConnector" class OnPhoneCallStateChangeInfoEvent OnPhoneCallStateChangeInfoEvent This event shows a change in the current calls at an extension (OpenScape Voice). Table: OnPhoneCallStateChangeInfoEvent EventData IPhoneCallStateChangeInfoDataX Result data OnPhoneClearedInfoEvent OnPhoneClearedInfoEvent This event shows that a call at an extension has been disconnected. Table: OnPhoneClearedInfoEvent EventData IPhoneClearedInfoDataX Result data OnPhoneDialingInfoEvent OnPhoneDialingInfoEvent This event shows that an outgoing calls was initiated from an extension. Table: OnPhoneDialingInfoEvent EventData IPhoneDialingInfoDataX Result data OnPhoneRingingInfoEvent OnPhoneRingingInfoEvent This event shows that a call arrived at an extension. Table: OnPhoneRingingInfoEvent EventData IPhoneRingingInfoDataX Result data OnPhoneStateBusyInfoEvent OnPhoneStateBusyInfoEvent This event shows details on the busy state of an extension. Table: OnPhoneStateBusyInfoEvent EventData IPhoneStateBusyInfoDataX Result data OnPhoneStateChangeInfoEvent OnPhoneStateChangeInfoEvent This event shows that the call state of the logged-on extension has changed. Table: OnPhoneStateChangeInfoEvent OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 67

68 "CocCtiConnector" class OnPhoneStateChangeInfoEvent EventData IPhoneStateChangeInfoDataX Result data OnReconnectCallEvent OnReconnectCallEvent This event shows the result of an asynchronous call of the ReconnectCall method. Table: OnReconnectCallEvent EventData IReconnectCallDataX Result data OnRetrieveCallEvent This event shows the result of an asynchronous call of the RetrieveCall method. OnRetrieveCallEvent Table: OnRetrieveCallEvent EventData IRetrieveCallDataX Result data OnSendDTMFEvent This event shows the result of an asynchronous call of the SendDTMF method. OnSendDTMFEvent Table: OnSendDTMFEvent EventData ISendDTMFDataX Result data OnServerConnectionStateChangeEvent OnServerConnectionStateInfoEvent This event shows a change in the connection state to the OSCC-E server. Table: OnServerConnectionStateInfoEvent EventData IServerConnectionStateChangeDataX Result data OnSetAgentStateOsvHuntgroupEvent OnSetAgentStateOsvHuntgroupEvent This event shows the result of an asynchronous call of the SetAgentStateOsvHuntgroup method. Table: OnSetAgentStateOsvHuntgroupEvent EventData ISetAgentStateOsvHuntgroupDataX Result data 68 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

69 "CocCtiConnector" class OnSetForwardingEvent This event shows the result of an asynchronous call of the SetForwarding method. OnSetForwardingEvent Table: OnSetForwardingEvent EventData ISetForwardingDataX Result data OnSingleStepTransferCallEvent OnSingleStepTransferEvent This event shows the result of an asynchronous call of the SingleStepTransferCall method. Table: OnSingleStepTransferCallEvent EventData ISingleStepTransferCallDataX Result data OnSiteStateInfoEvent OnSiteStateInfoEvent This event shows the state of a node. Table: OnSiteStateInfoEvent EventData ISiteStateInfoDataX Node type OnSnapshotDeviceAdvancedEvent OnSnapshotDeviceAdvancedEvent This event shows the result of an asynchronous call of the SnapshotDeviceAdvanced method. Table: OnSnapshotDeviceAdvancedEvent EventData ISnapshotDeviceAdvancedDataX Result data OnSnapshotDeviceEvent This event shows the result of an asynchronous call of the SnapshotDevice method. OnSnapshotDeviceEvent Table: OnSnapshotDeviceEvent EventData ISnapshotDeviceDataX Result data OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 69

70 "CocCtiConnector" class OnStartMonitorDeviceEvent OnStartMonitorDeviceEvent This event shows the result of an asynchronous call of the StartMonitorDevice method. Table: OnStartMonitorDeviceEvent EventData IStartMonitorDeviceDataX Result data OnStopMonitorDeviceEvent OnStopMonitorDeviceEvent This event shows the result of an asynchronous call of the StopMonitorDevice method. Table: OnStopMonitorDeviceEvent EventData IStopMonitorDeviceDataX Result data OnTransferCallEvent This event shows the result of an asynchronous call of the TransferCall method. OnTransferCallEvent Table: OnTransferCallEvent EventData ITransferCallDataX Result data OnTransferCompletedInfoEvent This event shows the result of forwarding through a call of TransferCall or SingleStepTransferCall. OnTransferCompletedInfoEvent Table: OnTransferCompletedInfoEvent EventData ITransferCompletedInfoDataX Result data OnTransferedInfoEvent OnTransferedInfoEvent This event shows an incoming forwarded call. Table: OnTransferedInfoEvent EventData ITransferedInfoDataX Result data 70 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

71 Other classes 2.4 Other classes AcdContactDataListParamX Properties The AcdContactDataListParamX class makes a list of call data available that can be passed as a parameter. ContactDataList This property contains the list of call data Methods Add ContactDataList IAcdContactDataListX Add This method adds a key value pair to the list. Table: Add Key Key term Value Value AcdFunctionTypeListParamX Properties The AcdTypeListParamX class makes a list of function types available that can be passed as a parameter. FunctionTypeList This property contains the list of function types. FunctionTypeList IAcdFunctionTypeListX Methods Add This method adds a function type to the list. Table: Add Add FunctionType AcdFunctionTypeEnum Function type OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 71

72 Other classes AcdWrapupReasonKeyDataListParamX Properties The AcdWrapupReasonKeyDataListParamX class makes a list of wrapup reasons available that can be passed as a parameter. WrapupReasonKeyList This property contains the list of keys for the wrapup reasons. WrapupReasonKeyList IAcdWrapupReasonKeyDataListX Methods Add This method adds the key of a wrapup reason to the list. Table: Add Add WrapupReasonKey Integer Key of the wrapup reason 72 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

73 IAcdAgentStateChangeInfoDataX Properties This interface makes the result data for the OnAcdAgentStateChangeInfoEvent available. AcdReasonKey This property contains the key for an ACD state reason. AcdReasonKey Integer AgentId This property contains the agent ID. AgentId AgentServicePermitted This property contains the currently possible agent routing control functions. AgentServicePermitted IUserAgentServPermFlagsX AgentState This property contains the agent routing state. AgentState UserAgentStatesEnum Extension This property contains the extension. Extension UserData This property contains the additional user data. UserData OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 73

74 2.5.2 IAcdAvailableDataX Properties This interface makes the result data for the AcdAvailable method and the OnAcdAvailableEvent available. This property contains the error code. ErrorEnum ErrorData This property contains the error description. ErrorData LocationId This property contains the node name. LocationId MediaType This property contains the media type. MediaType AcdMediaTypeEnum UserData This property contains the additional user data. UserData UserId This property contains the user ID. UserId 74 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

75 2.5.3 IAcdBusinessUnitsDataX This interface makes business unit data available Properties BusinessUnitKey This property contains the key of the business unit. BusinessUnitKey Integer BusinessUnitName This property contains the name of the business unit. BusinessUnitName Description This property contains the description of the business unit. Description IAcdBusinessUnitsListX This interface makes a list of IBusinessUnitsDataX objects available Properties Count This property contains the number of lists. Count Integer Methods get_item This methods returns the IPartyDataX object. get_item s Index Integer List index IBusinessUnitsDataX OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 75

76 GetEnumerator This method returns an enumerator. GetEnumerator IEnumerator IAcdCheckPasswordDataX Properties This interface makes the result data for the AcdCheckPassword method and the OnAcdCheckPasswordEvent available. This property contains the error code. ErrorEnum ErrorData This property contains the error description. ErrorData LocationId This property contains the node name. LocationId MediaType This property contains the media type. MediaType AcdMediaTypeEnum PasswordValid This property indicates whether the password was recognized as valid. PasswordValid Boolean UserData This property contains the additional user data. UserData 76 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

77 UserData UserId This property contains the user ID. UserId IAcdContactDataListX This interface makes a list of IContactDataX objects available Properties Count This property contains the number of lists. Count Integer Methods get_item This methods returns the IContactDataX object. get_item s Index Integer List index IAcdContactDataX GetEnumerator This method returns an enumerator IAcdContactDataX GetEnumerator IEnumerator This interface makes the contact call data available Properties Key This property contains the key term. Key OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 77

78 Value This property contains the value. Value IAcdContactStateAdvancedDataListX Properties This interface makes a list of IContactStateAdvancedDataX objects available. Count This property contains the number of lists. Count Integer Methods get_item This method returns the IContactStateAdvancedDataX object. get_item s Index Integer List index IAcdContactStateAdvancedDataX GetEnumerator This method returns an enumerator. GetEnumerator IEnumerator IAcdContactStateAdvancedDataX This interface makes detailed information on an ACD contact available Properties AcdHandling This property indicates whether a contact is being handled by the ACD. AcdHandling Boolean 78 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

79 AutoWrapup This property indicates whether post-processing (automatic wrapup) is active. AutoWrapup Boolean AutoWrapupSuspended This property indicates whether automatic wrapup was suspended for a contact. AutoWrapupSuspended Boolean ContactId This property contains the contact ID. ContactId ContactType This property contains the contact type. ContactType AcdContactTypeEnum HandlingState This property contains the handling state. HandlingState AcdHandlingStateEnum MandatoryWrapup This property specifies whether wrapup reasons must be entered. MandatoryWrapup Boolean ManualPostProcessingReason This property contains the manually set reason for post-processing. ManualPostProcessingReason Integer MediaType This property contains the media type. OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 79

80 MediaType AcdMediaTypeEnum PostProcessingPending This property indicates whether manually set post-processing is pending. PostProcessingPending Boolean PrimaryContact This property indicates whether the contact is the primary contact. PrimaryContact Boolean RequeueCount This property contains the number of requeues. RequeueCount Integer IAcdContactStateChangeInfoDataX Properties This interface makes data on the OnAcdContactStateChangeInfoEvent available. ContactStateAdvancedList This property contains the list of contact information. ContactStateAdvancedList IAcdContactStateAdvancedDataListX Extension This property contains the extension. Extension LocationId This property contains the node name. LocationId MediaType This property contains the media type. 80 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

81 MediaType AcdMediaTypeEnum UserId This property contains the user ID. UserId IAcdContactStateDataListX This interface makes a list of IContactStateDataX objects available Properties Count This property contains the number of lists. Count Integer Methods get_item This methods returns the IContactStateDataX object. get_item s Index Integer List index IAcdContactStateDataX GetEnumerator This method returns an enumerator. GetEnumerator IEnumerator OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 81

82 IAcdContactStateDataX This interface makes the state data of an ACD contact available Properties AcdHandling This property indicates whether a contact is being handled by the ACD. AcdHandling Boolean AutoWrapup This property indicates whether post-processing (automatic wrapup) is active. AutoWrapup Boolean AutoWrapupSuspended This property indicates whether automatic wrapup was suspended for a contact. AutoWrapupSuspended Boolean ContactId This property contains the contact ID. ContactId ContactType This property contains the contact type. ContactType AcdContactTypeEnum HandlingState This property contains the handling state. HandlingState AcdHandlingStateEnum 82 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

83 MandatoryWrapup This property specifies whether wrapup reasons must be entered. MandatoryWrapup Boolean ManualPostProcessingReason This property contains the manually set reason for post-processing. ManualPostProcessingReason Integer MediaType This property contains the media type. MediaType AcdMediaTypeEnum PostProcessingPending This property indicates whether manually set post-processing is pending. PostProcessingPending Boolean PrimaryContact This property indicates whether the contact is the primary contact. PrimaryContact Boolean RequeueCount This property contains the number of requeues. RequeueCount Integer IAcdContactStateInfoDataX Properties This interface makes the result data for the OnAcdContactStateInfoEvent available. This interface makes the result data for the OnAcdContactStateInfoEvent available. ContactStateDataList This property contains the list of contact states. OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 83

84 ContactStateDataList IAcdContactStateDataListX Extension This property contains the extension. Extension FunctionId This property contains detailed information on the node type. FunctionId NodeTypeEnum LocationId This property contains the node name. LocationId MediaType This property contains the media type. MediaType MediaTypeEnum NodeNumber This property contains the node number. NodeNumber PostProcessingEnabled This property indicates whether post-processing is enabled for this contact. PostProcessingEnabled Boolean SetPostProcessingReason This property indicates whether the reason for post-processing can be changed manually for this contact. SetPostProcessingReason Boolean 84 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

85 UserId This property contains the user ID. UserId IAcdExitPostProcessingStateDataX Properties This interface makes the result data for the AcdExitPostProcessingState method and the OnAcdExitPostProcessingStateEvent available. This property contains the error code. ErrorEnum ErrorData This property contains the error description. ErrorData LocationId This property contains the node name. LocationId UserData This property contains the additional user data. UserData UserId This property contains the user ID. UserId OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 85

86 IAcdGetBusinessUnitForExtensionDataX Properties This interface makes the result data for the AcdGetBusinessUnitForExtension method and the OnGetBusinessUnitForExtensionEvent available. BusinessUnitKey This property contains the key of the business unit. BusinessUnitKey Integer BusinessUnitName This property contains the name of the business unit. BusinessUnitName This property contains the error code. ErrorEnum ErrorData This property contains the error description. ErrorData Extension This property contains the extension. Extension LocationId This property contains the node name. LocationId 86 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

87 UserData This property contains the additional user data. UserData IAcdGetBusinessUnitForUserIdDataX Properties This interface makes the result data for the AcdGetBusinessUnitForUserId method and the OnGetBusinessUnitForUserIdEvent available. BusinessUnitKey This property contains the key of the business unit. BusinessUnitKey Integer BusinessUnitName This property contains the name of the business unit. BusinessUnitName This property contains the error code. ErrorEnum ErrorData This property contains the error description. ErrorData LocationId This property contains the node name. LocationId UserData This property contains the additional user data. UserData OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 87

88 UserData UserId This property contains the user ID. UserId IAcdGetBusinessUnitsDataX Properties This interface makes the result data for the AcdGetBusinessUnits method and the OnGetBusinessUnitsEvent available. BusinessUnitsList This property contains the list of the business unit. BusinessUnitsList IAcdBusinessUnitsListX This property contains the error code. ErrorEnum ErrorData This property contains the error description. ErrorData LocationId This property contains the node name. LocationId UserData This property contains the additional user data. UserData 88 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

89 IAcdGetCallInformationDataX Properties This interface makes the information data on an ACD voice contact available. AcdCallId This property contains the ACD call ID. AcdCallId Caption This property contains the call description. Caption ContactDataList This property contains the list of call data (key value pairs). ContactDataList IAcdContactDataListX ContactType This property contains the contact type. ContactType AcdContactTypeEnum This property contains the error code. ErrorEnum ErrorData This property contains the error description. ErrorData Extension This property contains the extension. Extension OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 89

90 LocationId This property contains the node name. LocationId PabxCallId This property contains the call ID. PabxCallId QueueKey This property contains the key of the queue. QueueKey Integer QueueName This property contains the name of the queue. QueueName UserData This property contains the additional user data. UserData UserId This property contains the user ID. UserId Methods To This method returns a string that indicates the current object. To 90 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

91 IAcdGetPostProcessingReasonsDataX Properties This interface makes the result data for the AcdGetPostProcessingReasons method and the OnGetPostProcessingReasonsEvent available. This property contains the error code. ErrorEnum ErrorData This property contains the error description. ErrorData LocationId This property contains the node name. LocationId PostProcessingReasonsList This property contains the list of post-processing reasons. PostProcessingReasonsList IAcdPostProcessingReasonsListX UserData This property contains the additional user data. UserData IAcdGetPostProcessingStateDataX Properties This interface makes the result data for the AcdGetPostProcessingState method and the OnAcdGetPostProcessingStateEvent available. ContactStateDataList This property contains the list of contact states. ContactStateDataList IAcdContactStateDataListX OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 91

92 This property contains the error code. ErrorEnum ErrorData This property contains the error description. ErrorData LocationId This property contains the node name. LocationId UserData This property contains the additional user data. UserData UserId This property contains the user ID. UserId IAcdGetQueuesDataX Properties This interface makes the result data for the AcdGetQueues method and the OnAcdGetQueuesEvent available. This property contains the error code. ErrorEnum ErrorData This property contains the error description. ErrorData 92 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

93 LocationId This property contains the node name. LocationId MediaType This property contains the media type. MediaType MediaTypeEnum QueueDataList This property contains the list of queue data. QueueDataList IAcdQueueDataListX UserData This property contains the additional user data. UserData Methods To This method returns a string that indicates the current object. To IAcdGetTeamsDataX Properties This interface makes the result data for the AcdGetTeams method and the OnAcdGetTeamsEvent available. This property contains the error code. ErrorEnum OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 93

94 ErrorData This property contains the error description. ErrorData LocationId This property contains the node name. LocationId QueueDataList This property contains the list of queue data. TeamDataList IAcdTeamDataListX UserData This property contains the additional user data. UserData Methods To This method returns a string that indicates the current object. To IAcdGetUnavailableReasonsDataX Properties This interface makes the result data for the AcdGetUnavailableReasons method and the OnAcdGetUnavailableReasonsEvent available. This property contains the error code. ErrorEnum 94 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

95 ErrorData This property contains the error description. ErrorData LocationId This property contains the node name. LocationId UnavailableReasonsDataList This property contains the list of unavailability reasons. UnavailableReasonsDataList IAcdUnavailableReasonsDataListX UserData This property contains the additional user data. UserData Methods To This method returns a string that indicates the current object. To IAcdGetUserIdForUserNameDataX Properties This interface makes the result data for the AcdGetUserIdForUserName method and the OnAcdGetUserIdForUserNameEvent available. This property contains the error code. ErrorEnum OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 95

96 ErrorData This property contains the error description. ErrorData LocationId This property contains the node name. LocationId UserData This property contains the additional user data. UserData UserId This property contains the user ID. UserId IAcdGetUsersDataX Properties This interface makes the result data for the AcdGetUsers method and the OnAcdGetUsersEvent available. This property contains the error code. ErrorEnum ErrorData This property contains the error description. ErrorData 96 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

97 LocationId This property contains the node name. LocationId UserData This property contains the additional user data. UserData UserDataList This property contains the list of user data. UserDataList IAcdUserDataListX IAcdGetUserStateDataX Properties This interface makes the result data for the AcdGetUserState method and the OnAcdGetUserStateEvent available. This property contains the error code. ErrorEnum ErrorData This property contains the error description. ErrorData Extension This property contains the extension. Extension OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 97

98 LocationId This property contains the node name. LocationId LoggedOnMediaTypeList This property contains the list of media types for which the user is logged on. LoggedOnMediaTypeList IAcdMediaTypeListX MediaType This property contains the media type (in case of a negative reply, otherwise awtnone). MediaType AcdMediaTypeEnum UserData This property contains the additional user data. UserData UserId This property contains the user ID. UserId UserState This property contains the ACD routing state. UserState UserAgentStatesEnum IAcdGetWorkReasonsDataX This interface makes the result data for the AcdGetWorkReasons method and the OnAcdGetWorkReasonsEvent available. 98 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

99 Properties This property contains the error code. ErrorEnum ErrorData This property contains the error description. ErrorData LocationId This property contains the node name. LocationId UserData This property contains the additional user data. UserData WorkReasonsDataList This property contains the list of work reasons. WrapupReasonsDataList IAcdWorkReasonDataListX IAcdGetWrapupReasonsDataX Properties This interface makes the result data for the AcdGetWrapupReasons method and the OnAcdGetWrapupReasonsEvent available. This property contains the error code. ErrorEnum OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 99

100 ErrorData This property contains the error description. ErrorData LocationId This property contains the node name. LocationId UserData This property contains the additional user data. UserData WrapupReasonsDataList This property contains the list of wrapup reasons. WrapupReasonsDataList IAcdWrapupReasonsDataListX Methods To This method returns a string that indicates the current object IAcdLogoffDataX Properties To This interface makes the result data for the AcdLogoff method and the OnAcdLogoffEvent available. This property contains the error code. ErrorEnum 100 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

101 ErrorData This property contains the error description. ErrorData LocationId This property contains the node name. LocationId MediaType This property contains the media type. MediaType AcdMediaTypeEnum UserData This property contains the additional user data. UserData UserId This property contains the user ID IAcdLogonDataX Properties UserId This interface makes the result data for the AcdLogon method and the OnAcdLogonEvent available. This property contains the error code. ErrorEnum OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 101

102 ErrorData This property contains the error description. ErrorData LocationId This property contains the node name. LocationId MediaType This property contains the media type. MediaType AcdMediaTypeEnum UserData This property contains the additional user data. UserData UserId This property contains the user ID. UserId IAcdMediaTypeDataX This interface makes data of a media type available Properties MediaType This property contains the media type. MediaType AcdMediaTypeEnum 102 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

103 IAcdMediaTypeListX This interface makes a list of IAcdMediaTypeDataX objects available Properties Count This property contains the number of lists. Count Integer Methods get_item This methods returns the IAcdMediaTypeDataX object. get_item s Index Integer List index IAcdMediaTypeDataX GetEnumerator This method returns an enumerator. GetEnumerator IEnumerator IAcdPostProcessingReasonsDataX This interface makes data of a post-processing reason available Properties BusinessUnitKey This property contains the key of the business unit. BusinessUnitKey Integer Description This property contains a description of the post-processing reason. Description OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 103

104 ReasonKey This property contains the key of the post-processing reason. ReasonKey Integer ReasonName This property contains the name of the post-processing reason. ReasonName ReferenceKey This property contains the reference key of the post-processing reason. ReferenceKey Integer IAcdPostProcessingReasonsListX Properties This interface makes a list of IAcdPostProcessingReasonsDataX objects available. Count This property contains the number of lists. Count Integer Methods get_item This methods returns the IAcdPostProcessingReasonsDataX object. get_item s Index Integer List index IAcdPostProcessingReasonsDataX GetEnumerator This method returns an enumerator. GetEnumerator IEnumerator 104 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

105 IAcdPostProcessingServPermFlagsX Properties This interface makes the possible actions in the post-processing state available. Exit This property indicates whether post-processing can be ended. Exit Boolean SetReason This property indicates whether the reason for post-processing can be changed manually. SetReason Boolean Methods To This method returns a string that indicates the current object. To IAcdQueueDataListX This interface makes a list of IAcdQueueDataX objects available Properties Count This property contains the number of lists. Count Integer Methods get_item This methods returns the IAcdQueueDataX object. get_item s Index Integer List index IAcdQueueDataX OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 105

106 GetEnumerator This method returns an enumerator IAcdQueueDataX GetEnumerator IEnumerator This interface makes detailed information on a queue available Properties BusinessUnitKey This property contains the key of the business unit. BusinessUnitKey Integer Description This property contains the description of the queue. Description MediaType This property contains the media type. MediaType AcdMediaTypeEnum QueueKey This property contains the key of the queue. QueueKey Integer QueueName This property contains the queue name. QueueName WrapupReasonKeyDataList This property contains the list of wrapup reasons belonging to the queue. WrapupReasonKeyDataList IAcdWrapupReasonKeyDataList 106 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

107 IAcdRegisterForFunctionsDataX Properties This interface makes the result data for the AcdRegisterForFunctions method and the OnAcdRegisterForFunctionsEvent available. This property contains the error code. Error code ErrorEnum ErrorData This property contains the error description. ErrorData FunctionTypeList This property contains the list of registered, special functions. FunctionTypeList IAcdFunctionTypeListX FunctionTypeListMask This property contains a string representation of the list of registered, special functions. FunctionTypeListMask LocationId This property contains the node name. LocationId UserData This property contains the additional user data. UserData OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 107

108 UserId This property contains the user ID. UserId IAcdRegisterForGlobalEventsDataX Properties This interface makes the result data for the AcdRegisterForGlobalEvents method and the OnAcdRegisterForGlobalEventsEvent available. This property contains the error code. ErrorEnum ErrorData This property contains the error description. ErrorData LocationId This property contains the node name. LocationId UserData This property contains the additional user data. UserData IAcdRegisterForNodeEventsDataX Properties This interface makes the result data for the AcdRegisterForNodeEvents method and the OnAcdRegisterForNodeEventsEvent available. AcdRelease This property contains the ACD release number. AcdRelease Integer 108 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

109 AcdVersion The property contains the ACD version number. AcdVersion Integer This property contains the error code. ErrorEnum ErrorData This property contains the error description. ErrorData LocationId This property contains the node name. LocationId MediaType This property contains the media type. MediaType AcdMediaTypeEnum UserData This property contains the additional user data. UserData UserId This property contains the user ID. UserId IAcdSaveWrapupDataX This interface makes the result data for the AcdSaveWrapupData method and the OnAcdSaveWrapupDataEvent available. OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 109

110 Properties This property contains the error code. ErrorEnum ErrorData This property contains the error description. ErrorData LocationId This property contains the node name. LocationId UserData This property contains the additional user data. UserData UserId This property contains the user ID. UserId Methods To This method returns a string that indicates the current object. To 110 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

111 IAcdSetPostProcessingStateDataX Properties This interface makes the result data for the AcdSetPostProcessingState method and the OnAcdSetPostProcessingStateEvent available. This property contains the error code. ErrorEnum ErrorData This property contains the error description. ErrorData LocationId This property contains the node name. LocationId UserData This property contains the additional user data. UserData UserId This property contains the user ID. UserId Methods To This method returns a string that indicates the current object. To OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 111

112 IAcdSetPrimaryContactDataX Properties This interface makes the result data for the AcdSetPrimaryContact method and the OnAcdSetPrimaryContactEvent available. This property contains the error code. ErrorEnum ErrorData This property contains the error description. ErrorData LocationId This property contains the node name. LocationId UserData This property contains the additional user data. UserData UserId This property contains the user ID. UserId Methods To This method returns a string that indicates the current object. To IAcdTeamDataListX This interface makes a list of IAcdTeamDataX objects available. 112 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

113 Properties Count This property contains the number of lists. Count Integer Methods get_item This methods returns the IAcdTeamDataX object. get_item s Index Integer List index IAcdTeamDataX GetEnumerator This method returns an enumerator IAcdTeamDataX GetEnumerator IEnumerator This interface makes detailed information on an agent team available Properties BusinessUnitKey This property contains the key of the business unit. BusinessUnitKey Integer Description This property contains a description of the team. Description TeamKey This property contains the key of the team. TeamKey Integer OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 113

114 TeamName This property contains the team name. TeamName IAcdUnavailableDataX Properties This interface makes the result data for the AcdUnavailable method and the OnAcdUnavailableEvent available. This property contains the error code. ErrorEnum ErrorData This property contains the error description. ErrorData LocationId This property contains the node name. LocationId MediaType This property contains the media type. MediaType AcdMediaTypeEnum UserData This property contains the additional user data. UserData UserId This property contains the user ID. UserId 114 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

115 IAcdUnavailableReasonDataListX Properties This interface makes a list of IAcdUnavailableReasonDataX objects available. Count This property contains the number of lists. Count Integer Methods get_item This methods returns the IAcdUnavailableReasonDataX object. get_item s Index Integer List index IAcdUnavailableReasonDataX GetEnumerator This method returns an enumerator. GetEnumerator IEnumerator IAcdUnavailableReasonDataX This interface makes data of an unavailability reason available Properties BusinessUnitKey This property contains the key of the business unit. BusinessUnitKey Integer Description This property contains a description of the unavailability reason. Description OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 115

116 ReasonKey This property contains the key of the unavailability reason. ReasonKey Integer ReasonName This property contains the name of the unavailability reason. ReasonName ReferenceKey This property contains the reference key of the unavailability reason. ReferenceKey Integer IAcdUnregisterForFunctionsDataX Properties This interface makes the result data for the AcdUnregisterForFunctions method and the OnAcdUnregisterForFunctionsEvent available. This property contains the error code. ErrorEnum ErrorData This property contains the error description. ErrorData FunctionTypeList This property contains the list of registered, special functions. FunctionTypeList IAcdFunctionTypeListX 116 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

117 FunctionTypeListMask This property contains a string representation of the list of registered, special functions. FunctionTypeListMask LocationId This property contains the node name. LocationId UserData This property contains the additional user data. UserData UserId This property contains the user ID. UserId IAcdUnregisterForGlobalEventsDataX Properties This interface makes the result data for the AcdUnregisterForGlobalEvents method and the OnAcdUnregisterForGlobalEventsEvent available. This property contains the error code. ErrorEnum ErrorData This property contains the error description. ErrorData OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 117

118 LocationId This property contains the node name. LocationId UserData This property contains the additional user data. UserData IAcdUnregisterForNodeEventsDataX Properties This interface makes the result data for the AcdUnregisterForNodeEvents method and the OnAcdUnregisterForNodeEventsEvent available. This property contains the error code. ErrorEnum ErrorData This property contains the error description. ErrorData LocationId This property contains the node name. LocationId MediaType This property contains the media type. MediaType AcdMediaTypeEnum 118 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

119 UserData This property contains the additional user data. UserData UserId This property contains the user ID. UserId IAcdUserConfigDataX The interface makes the data for the ACD user logon available Properties BusinessUnitName This property contains the name of the business unit. BusinessUnitName Password This property contains the user password. Password UserId This property contains the ACD user ID IAcdUserDataX UserId This interface makes the user data available Properties BusinessUnitKey This property contains the key of the business unit. BusinessUnitKey Integer OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 119

120 DepartmentKey This property contains the department key. DepartmentKey Integer Firstname This property contains the first name. Firstname Lastname This property contains the last name. Lastname MediaTypeList This property contains the list of media types. MediaTypeList IAcdMediaTypeList UserId This property contains the user ID. UserId UserKey This property contains the user key. UserKey Integer UserName This property contains the ACD user name. UserName 120 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

121 IAcdUserDataListX This interface makes a list of IAcdUserDataX objects available Properties Count This property contains the number of lists. Count Integer Methods get_item This methods returns the IAcdUserDataX object. get_item s Index Integer List index IAcdUserDataX GetEnumerator This method returns an enumerator. GetEnumerator IEnumerator IAcdUserStateChangeInfoDataX Properties This interface makes the result data for the OnAcdUserStateChangeInfoEvent available. AcdReasonKey This property contains the key of the state change reason. AcdReasonKey Integer Extension This property contains the extension. Extension OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 121

122 LocationId This property contains the node name. LocationId MediaTypeList This property contains the list of media types for which the user is logged on. LoggedOnMediaTypeList IAcdMediaTypeListX UserId This property contains the user ID. UserId UserServicePermitted This property contains the options currently available for changing the routing state. UserServicePermittedFlags IUserAgentServPermFlagsX UserState This property contains the ACD routing state. UserState UserAgentStatesEnum IAcdVoiceRingingInfoDataX Properties This interface makes the data for the OnAcdVoiceRingingInfoEvent available. AcdCallId This property contains the ACD call ID. AcdCallId Caption This property contains the call description. Caption 122 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

123 Caption ContactDataList This property contains the list of call data (key value pairs). ContactDataList IAcdContactDataListX ContactType This property contains the contact type. ContactType AcdContactTypeEnum Extension This property contains the extension. Extension FromPartyAgentKey This property contains the agent key of the call source. FromPartyAgentKey Integer FromPartyDevice This property contains the phone number of the call source. FromPartyDevice FromPartyPartyType This property contains the subscriber type of the call source. FromPartyPartyType AcdPartyTypeEnum FunctionId This property contains detailed information on the node type. FunctionId NodeTypeEnum LocationId This property contains the node name. OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 123

124 LocationId NodeNumber This property contains the node number. NodeNumber OriginalFromPartyAgentKey This property contains the agent key of the original call source. OriginalFromPartyAgentKey Integer OriginalFromPartyDevice This property contains the phone number of the original call source. OriginalFromPartyDevice OriginalFromPartyPartyType This property contains the subscriber type of the original call source. OriginalFromPartyPartyType AcdPartyTypeEnum OriginalToPartyAgentKey This property contains the agent key of the original call destination. OriginalToPartyAgentKey Integer OriginalToPartyDevice This property contains the phone number of the original call destination. OriginalToPartyDevice OriginalToPartyPartyType This property contains the subscriber type of the original call destination. OriginalToPartyPartyType AcdPartyTypeEnum 124 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

125 PabxCallId This property contains the call ID. PabxCallId Priority This property contains the call priority. Priority Integer QueueKey This property contains the key of the queue. QueueKey Integer QueueName This property contains the name of the queue. QueueName ToPartyAgentKey This property contains the agent key of the call destination. ToPartyAgentKey Integer ToPartyDevice This property contains the phone number of the call destination. ToPartyDevice ToPartyPartyType This property contains the subscriber type of the call destination. ToPartyPartyType AcdPartyTypeEnum OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 125

126 UserId This property contains the ACD user ID IAcdWorkDataX Properties UserId This interface makes the result data for the AcdWork method and the OnAcdWorkEvent available. This property contains the error code. ErrorEnum ErrorData This property contains the error description. ErrorData LocationId This property contains the node name. LocationId MediaType This property contains the media type. MediaType AcdMediaTypeEnum UserData This property contains the additional user data. UserData 126 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

127 UserId This property contains the user ID. UserId IAcdWorkReasonDataListX This interface makes a list of IAcdWorkReasonDataX objects available Properties Count This property contains the number of lists. Count Integer Methods get_item This methods returns the IAcdWorkReasonDataX object. get_item s Index Integer List index IAcdWorkReasonDataX GetEnumerator This method returns an enumerator. GetEnumerator IEnumerator IAcdWorkReasonDataX This interface makes data of a work reason available Properties BusinessUnitKey This property contains the key of the business unit. BusinessUnitKey Integer OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 127

128 Description This property contains a description of the work reason. Description ReasonKey This property contains the key of the work reason. ReasonKey Integer ReasonName This property contains the name of the work reason. ReasonName ReferenceKey This property contains the reference key of the work reason. ReferenceKey Integer IAcdWrapupReasonDataX This interface makes a wrapup reason available Properties BusinessUnitKey This property contains the key of the business unit. BusinessUnitKey Integer Description This property contains a description of the wrapup reason. Description ReasonKey This property contains the key of the wrapup reason. ReasonKey Integer 128 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

129 ReasonName This property contains the name of the wrapup reason. ReasonName IAcdWrapupReasonKeyDataListX Properties This interface makes a list of IAcdWrapupReasonKeyDataX objects available. Count This property contains the number of lists. Count Integer Methods get_item This methods returns the IAcdWrapupReasonKeyDataX object. get_item s Index Integer List index IAcdWrapupReasonKeyDataX GetEnumerator This method returns an enumerator. GetEnumerator IEnumerator IAcdWrapupReasonKeyDataX This interface makes a key for a wrapup reason available Properties WrapupReasonKey This property contains the key of the wrapup reason. WrapupReasonKey Integer OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 129

130 IAcdWrapupReasonsDataListX This interface makes a list of IAcdWrapupReasonsDataX objects available Properties Count This property contains the number of lists. Count Integer Methods get_item This methods returns the IAcdWrapupReasonsDataX object. get_item s Index Integer List index IAcdWrapupReasonsDataX GetEnumerator This method returns an enumerator. GetEnumerator IEnumerator IAgentAvailableDataX Properties This interface makes the result data for the AgentAvailable method and the OnAgentAvailableEvent available. AgentState This property contains details on the agent state of an extension. AgentState UserAgentStatesEnum CstaError This property contains details on the CSTA error. CstaError ICstaErrorX 130 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

131 This property contains the error code. ErrorEnum Extension This property contains the extension. Extension Methods IsCstaError This method indicates whether a CSTA error occurred. IsCstaError Boolean IsError This method indicates whether an error occurred. IsError Boolean To This method returns a string that indicates the current object. To IAgentLogoffDataX Properties This interface makes the result data for the AgentLogoff method and the OnAgentLogoffEvent available. AgentState This property contains details on the agent state of an extension. AgentState UserAgentStatesEnum OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 131

132 CstaError This property contains details on the CSTA error. CstaError ICstaErrorX This property contains the error code. ErrorEnum 132 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

133 Extension This property contains the extension. Extension Methods IsCstaError This method indicates whether a CSTA error occurred. IsCstaError Boolean IsError This method indicates whether an error occurred. IsError Boolean To This method returns a string that indicates the current object. To IAgentLogonDataX Properties This interface makes the result data for the AgentLogon method and the OnAgentLogonEvent available. AgentState This property contains details on the agent state of an extension. AgentState UserAgentStatesEnum CstaError This property contains details on the CSTA error. CstaError ICstaErrorX OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 133

134 This property contains the error code. ErrorEnum Extension This property contains the extension. Extension Methods IsCstaError This method indicates whether a CSTA error occurred. IsCstaError Boolean IsError This method indicates whether an error occurred. IsError Boolean To This method returns a string that indicates the current object. To IAgentStateChangeInfoDataX Properties This interface makes the result data for the OnAgentStateChangeInfoEvent available. AgentId This property contains the agent ID. AgentId 134 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

135 AgentServicePermitted This property contains the options currently available for changing the routing state. AgentServicePermittedFlags IUserAgentServPermFlagsX AgentState This property contains the agent routing state. AgentState UserAgentStatesEnum Extension This property contains the extension. Extension UserData This property contains the additional user data. UserData IAgentUnavailableDataX Properties This interface makes the result data for the AgentUnavailable method and the OnAgentUnavailableEvent available. AgentState This property contains details on the agent state of an extension. AgentState UserAgentStatesEnum CstaError This property contains details on the CSTA error. CstaError ICstaErrorX OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 135

136 This property contains the error code. ErrorEnum Extension This property contains the extension. Extension Methods IsCstaError This method indicates whether a CSTA error occurred. IsCstaError Boolean IsError This method indicates whether an error occurred. IsError Boolean To This method returns a string that indicates the current object IAgentWorkDataX Properties To This interface makes the result data for the AgentWork method and the OnAgentWorkEvent available. AgentState This property contains details on the agent state of an extension. AgentState UserAgentStatesEnum 136 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

137 CstaError This property contains details on the CSTA error. CstaError ICstaErrorX This property contains the error code. ErrorEnum Extension This property contains the extension. Extension Methods IsCstaError This method indicates whether a CSTA error occurred. IsCstaError Boolean IsError This method indicates whether an error occurred. IsError Boolean To This method returns a string that indicates the current object. To OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 137

138 IAlternateCallDataX Properties This interface makes the result data for the AlternateCall method and the OnAlternateCallEvent available. CstaError This property contains details on the CSTA error. CstaError ICstaErrorX This property contains the error code. ErrorEnum Extension This property contains the extension. Extension Methods IsCstaError This method indicates whether a CSTA error occurred. IsCstaError Boolean IsError This method indicates whether an error occurred. IsError Boolean To This method returns a string that indicates the current object. To 138 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

139 IAnswerCallDataX Properties This interface makes the result data for the AnswerCall method and the OnAnswerCallEvent available. CstaError This property contains details on the CSTA error. CstaError ICstaErrorX This property contains the error code. ErrorEnum Extension This property contains the extension. Extension Methods IsCstaError This method indicates whether a CSTA error occurred. IsCstaError Boolean IsError This method indicates whether an error occurred. IsError Boolean To This method returns a string that indicates the current object. To OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 139

140 ICallbackInfoDataX This interface makes the result data for the OnCallbackInfoEvent available Properties CallbackDevice This property contains the extension to which the callback is established. CallbackDevice CallId This property contains the call ID of the initiated callback. CallId Extension This property contains the extension. Extension SiteId This property contains the node name. SiteId ICallDisconnectOnHeldInfoDataX Properties This interface makes the result data for the OnCallDisconnectOnHeldInfoEvent available. CallId This property contains the call ID of the call on hold. CallId DisconnectingDevice This property contains the disconnecting extension. DisconnectingDevice 140 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

141 Extension This property contains the extension. Extension ICallEstablishedInfoDataX Properties This interface makes the information data for the OnCallEstablishedInfoEvent available. AnsweringDevice This property contains the accepting phone number. AnsweringDevice CallAnswered This property indicates whether a call was accepted. CallAnswered Boolean CallId This property contains the call ID of the disconnected call. CallId CallingDevice This property contains the incoming phone number. CallingDevice EventCause This property contains the event reason for a CSTA command. EventCause EventCauseEnum Extension This property contains the extension. Extension OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 141

142 LastRedirectingDevice This property contains the extension of the last call redirection. LastRedirectingDevice OriginalCalledDevice This property contains the originally called number. OriginalCalledDevice ICallPickupInfoDataX Properties This interface makes the information data for the OnCallPickupInfoEvent available. CallId This property contains the call ID of the call. CallId CallingDevice This property contains the incoming phone number. CallingDevice Extension This property contains the extension. Extension LastRedirectingDevice This property contains the extension of the last call redirection. LastRedirectingDevice OriginalCalledDevice This property contains the originally called number. OriginalCalledDevice 142 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

143 PickupDevice This property contains the extension that picks up the call. PickupDevice SiteId This property contains the node name. SiteId ICheckMonitoringDeviceDataX Properties This interface makes the result data for the CheckMonitoringDevice method and the OnCheckMonitoringDeviceEvent available. This property contains the error code. ErrorEnum Extension This property contains the extension. Extension MonitorDeviceHandlingFlag This property contains details on the type of monitoring of an extension. MonitorDeviceHandlingFlag MonitorDeviceHandlingFlagEnum MonitorState This property contains details on the monitoring state of an extension. MonitorState MonitorStateEnum UserData This property contains the additional user data. UserData OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 143

144 Methods IsCstaError This method indicates whether a CSTA error occurred. IsCstaError Boolean IsError This method indicates whether an error occurred. IsError Boolean To This method returns a string that indicates the current object. To IClearConnectionDataX Properties This interface makes the result data for the ClearConnection method and the OnClearConnectionEvent available. CstaError This property contains details on the CSTA error. CstaError ICstaErrorX This property contains the error code. ErrorEnum Extension This property contains the extension. Extension 144 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

145 Methods IsCstaError This method indicates whether a CSTA error occurred. IsCstaError Boolean IsError This method indicates whether an error occurred. IsError Boolean To This method returns a string that indicates the current object. To ICommonConfigDataX Properties This interface makes general configuration and setting data available. ApplicationIdentifier This property contains the application identifier required for the license check. ApplicationIdentifier ApplicationIdentifierEnum DefaultUserData This property contains the default user data that are used for various functions and events. DefaultUserData IPVersion This property contains the IP protocol version in use. IPVersion IPVersionEnum OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 145

146 SynchronTimeout This property contains the timeout value for synchronous method execution in milliseconds. SynchronTimeout Integer IConferenceCallDataX Properties This interface makes the result data for the ConferenceCall method and the OnConferenceCallEvent available. CallId This property contains the call ID of the conference. CallId CstaError This property contains details on the CSTA error. CstaError ICstaErrorX This property contains the error code. ErrorEnum Extension This property contains the extension. Extension Methods IsCstaError This method indicates whether a CSTA error occurred. IsCstaError Boolean 146 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

147 IsError This method indicates whether an error occurred. IsError Boolean To This method returns a string that indicates the current object. To IConferenceInfoDataX Properties This interface makes the result data for the OnConferenceInfoEvent available. CallId This property contains the call ID of the conference. CallId ConferenceCreator This property indicates whether a subscriber convened the conference. ConferenceCreator Boolean ConferenceEventType This property contains the event that led to a change in the conference state. ConferenceEventType ConferenceEventTypeEnum ConsultCallId This property contains the call ID with the consulted extension. ConsultCallId OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 147

148 EventCause This property contains the event reason for a CSTA command. EventCause EventCauseEnum Extension This property contains the extension. Extension HoldCallId This property contains the call ID with the extension on hold. HoldCallId Lcs This property contains the connection state. Lcs LocalConnectionStateEnum PartyList This property contains the subscriber list of the conference. PartyList IPartyListX ReplacedCallId This property contains the call ID replaced by the call ID of the conference. ReplacedCallId SilentMonitoring This property indicates whether silent monitoring is enabled. SilentMonitoring Boolean 148 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

149 SiteId This property contains the node name. SiteId IConfigDataX This interface makes configuration and setting data available Properties AcdUserConfigData This property contains the user data for the ACD logon. AcdUserConfigData AcdUserConfigDataX CommonConfigData This property contains general configuration data. CommonConfigData ICommonConfigDataX CtiConnectivityConfigData This property contains the configuration data for the CTI connection. CtiConnectivityConfigData CtiConnectivityConfigDataX LogConfigData This property contains the settings for the process log for program diagnosis IConnectionDataX LogConfigData ILoggingConfigDataX This interface makes detailed information on a voice connection available Properties ActiveCallId This property contains the call ID of the connection. ActiveCallId OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 149

150 Device This property contains the extension or the trunk number (for external subscribers). Device DeviceDisplay This property contains the display of the extension. DeviceDisplay DeviceType This property contains the extension type. DeviceType DeviceTypeEnum OldCallIdList This property contains the list of former call IDs. OldCallIdList IOldCallIdListX Position This property indicates the position of the extension in the list of connection subscribers IConnectionListX Position Integer This interface makes a list of IConnectionDataX objects available Properties Count This property contains the number of lists. Count Integer 150 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

151 Methods get_item This methods returns the IConnectionDataX object. get_item s Index Integer List index IConnectionDataX GetEnumerator This method returns an enumerator IConsultCallDataX Properties GetEnumerator IEnumerator This interface makes the result data for the ConsultCall method and the OnConsultCallEvent available. CallId This property contains the call ID of the consultation call. CallId CstaError This property contains details on the CSTA error. CstaError ICstaErrorX This property contains the error code. ErrorEnum Extension This property contains the extension. Extension OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 151

152 Methods IsCstaError This method indicates whether a CSTA error occurred. IsCstaError Boolean IsError This method indicates whether an error occurred. IsError Boolean To This method returns a string that indicates the current object. To ICreateCallbackDataX Properties This interface makes the result data for the CreateCallback method and the OnCreateCallbackEvent available. CstaError This property contains details on the CSTA error. CstaError ICstaErrorX Destination This property contains the callback number. Destination This property contains the error code. ErrorEnum 152 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

153 Extension This property contains the extension. Extension Methods IsCstaError This method indicates whether a CSTA error occurred. IsCstaError Boolean IsError This method indicates whether an error occurred. IsError Boolean To This method returns a string that indicates the current object. To ICstaErrorX This interface makes detailed information on a CSTA error available Properties CstaErrorClass This property contains the CSTA error class value. CstaErrorClass Integer CstaErrorClassTxt This property contains the CSTA error class description. CstaErrorClassTxt OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 153

154 CstaErrorValue This property contains the CSTA error value. CstaErrorValue Integer CstaErrorValueTxt This property contains the CSTA error description. CstaErrorValueTxt Methods To This method returns a string that indicates the current object. To ICtiConnectivityConfigDataX Properties This interface makes general configuration and setting data for the CTI connection available. AutoReconnect This property indicates whether an attempt should automatically be made to reestablish the connection if a connection is lost. AutoReconnect Boolean ConnectAndMonitor This property indicates whether the state of the extension should be monitored after a successful logon. ConnectAndMonitor Boolean Extension This property contains the extension. The E164 format can be used. Extension 154 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

155 IpAddress This property contains the IP address of the Integration Connector. IpAddress Port This property contains the port number of the Integration Connector. Port Integer SiteId This property contains the node name IDeflectCallDataX Properties SiteId This interface makes the result data for the DeflectCall method and the OnDeflectCallEvent available. CstaError This property contains details on the CSTA error. CstaError ICstaErrorX This property contains the error code. ErrorEnum Extension This property contains the extension. Extension OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 155

156 Methods IsCstaError This method indicates whether a CSTA error occurred. IsCstaError Boolean IsError This method indicates whether an error occurred. IsError Boolean To This method returns a string that indicates the current object. To IDeleteCallbackDataX Properties This interface makes the result data for the DeleteCallback method and the OnDeleteCallbackEvent available. CstaError This property contains details on the CSTA error. CstaError ICstaErrorX This property contains the error code. ErrorEnum Extension This property contains the extension. Extension 156 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

157 Methods IsCstaError This method indicates whether a CSTA error occurred. IsCstaError Boolean IsError This method indicates whether an error occurred. IsError Boolean To This method returns a string that indicates the current object IDialDigitsDataX Properties To This interface makes the result data for the DialDigits method and the OnDialDigitsEvent available. CstaError This property contains details on the CSTA error. CstaError ICstaErrorX This property contains the error code. ErrorEnum Extension This property contains the extension. Extension OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 157

158 Methods IsCstaError This method indicates whether a CSTA error occurred. IsCstaError Boolean IsError This method indicates whether an error occurred. IsError Boolean To This method returns a string that indicates the current object. To IExtensionCallDataX This interface makes information on a connected voice call available Properties Active This property indicates whether the call is active. Active Boolean CallId This property contains the call ID. CallId CallState This property contains the connection state. CallState CallStateEnum 158 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

159 Cause This property contains the event reason for a CSTA command. Cause EventCauseEnum Direction This property contains the connection direction. Direction CallDirectionEnum PartyList This property contains the subscriber list of the conference. PartyList IPartyListX RemoteParty This property contains the remote party. RemoteParty RemotePartyBusy This property indicates whether the remote party is busy. RemotePartyBusy Boolean ReplacedCallId This property contains the call ID replaced by the call ID of the conference. ReplacedCallId ServicePermittedFlags This property contains the CTI functions currently available IExtensionCallListX ServicePermittedFlags IServPermFlagsX This interface makes a list of IExtensionCallDataX objects available. OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 159

160 Properties Count This property contains the number of lists. Count Integer Methods get_item This methods returns the IExtensionCallDataX object. get_item s Index Integer List index IExtensionCallDataX GetEnumerator This method returns an enumerator IFailoverInfoDataX GetEnumerator IEnumerator This interface makes the result data for the OnFailoverInfoEvent available Properties SiteId This property contains the node name. SiteId SiteType This property contains the node type. SiteType SiteTypeEnum State This property contains the node state. State SiteStateEnum 160 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

161 TypeDetail This property contains detailed information on the node type. TypeDetail IGetAgentStateDataX Properties NodeTypeEnum This interface makes the result data for the GetAgentState method and the OnGetAgentStateEvent available. AgentId This property contains the agent ID. AgentId AgentState This property contains the agent routing state. AgentState UserAgentStatesEnum CstaError This property contains details on the CSTA error. CstaError ICstaErrorX This property contains the error code. ErrorEnum Extension This property contains the extension. Extension OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 161

162 Methods IsCstaError This method indicates whether a CSTA error occurred. IsCstaError Boolean IsError This method indicates whether an error occurred. IsError Boolean To This method returns a string that indicates the current object. To IGetAgentStateOsvHuntgroupDataX Properties This interface makes the result data for the GetAgentStateOsvHuntgroup method and the OnGetAgentStateOsvHuntgroupEvent available. AgentState This property contains the agent routing state. AgentState AgentStateOsvHuntgroupEnum CstaError This property contains details on the CSTA error. CstaError ICstaErrorX This property contains the error code. ErrorEnum 162 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

163 Extension This property contains the extension. Extension Methods IsCstaError This method indicates whether a CSTA error occurred. IsCstaError Boolean IsError This method indicates whether an error occurred. IsError Boolean To This method returns a string that indicates the current object. To IGetDoNotDisturbDataX Properties This interface makes the result data for the GetDoNotDisturb method and the OnGetDoNotDisturbEvent available. CstaError This property contains details on the CSTA error. CstaError ICstaErrorX DoNotDisturbState This property contains the do-not-disturb state. DoNotDisturbState DoNotDisturbFlagEnum OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 163

164 This property contains the error code. ErrorEnum Extension This property contains the extension. Extension Methods IsCstaError This method indicates whether a CSTA error occurred. IsCstaError Boolean IsError This method indicates whether an error occurred. IsError Boolean To This method returns a string that indicates the current object. To IGetExtensionCallListDataX Properties This interface makes the result data for the GetExtensionCallList method and the OnGetExtensionCallListEvent available. This property contains the error code. ErrorEnum 164 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

165 ExtensionCallList This property contains the list of connected calls IGetForwardingDataX Properties ExtensionCallList IExtensionCallList This interface makes the result data for the GetDoNotDisturb method and the OnGetDoNotDisturbEvent available. BusyDestination The property contains the forwarding destination if busy. BusyDestination CstaError This property contains details on the CSTA error. CstaError ICstaErrorX Destination The property contains the forwarding destination for immediate forwarding. Destination This property contains the error code. ErrorEnum Extension This property contains the extension. Extension ForwardingState This property contains the forwarding state. ForwardingState ForwardingStateEnum OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 165

166 NoAnswerDestination This property contains the forwarding destination for time-controlled forwarding (Ring-No-Answer forwarding). NoAnswerDestination Methods IsCstaError This method indicates whether a CSTA error occurred. IsCstaError Boolean IsError This method indicates whether an error occurred. IsError Boolean To This method returns a string that indicates the current object. To IGetPhoneStateDataX This interface makes the result data for the GetPhoneState available Properties This property contains the error code. ErrorEnum PhoneStateInfoData This property contains the telephone state data. PhoneStateInfoData IPhoneStateChangeInfoDataX 166 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

167 IHoldCallDataX Properties This interface makes the result data for the HoldCall method and the OnHoldCallEvent available. CstaError This property contains details on the CSTA error. CstaError ICstaErrorX This property contains the error code. ErrorEnum Extension This property contains the extension. Extension Methods IsCstaError This method indicates whether a CSTA error occurred. IsCstaError Boolean IsError This method indicates whether an error occurred. IsError Boolean To This method returns a string that indicates the current object. To OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 167

168 ILoggingConfigDataX Properties This interface makes the general setting data for the process log available. LogAdvancedDirectory This property contains the path to the file directory in which the log files are saved. LogAdvancedDirectory LogAdvancedEnabled This property indicates whether the messages sent in OnLoggingEvent are written to a SmartInspect log file. LogAdvancedEnabled Boolean LogAdvancedFilename This property contains the path of the current log file (the file name is generated automatically). LogAdvancedFilename LogAdvancedFile This property contains the control values for the SmartInspect log files. LogAdvancedFile LogConnectivityMessages This property indicates whether the messages to and from the Integration Connector should be logged in OnLoggingEvent. LogConnectivityMessages Boolean LogInternalMessages This property indicates whether internal function calls should be logged in OnLoggingEvent. LogInternalMessages Boolean 168 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

169 LogKeepAlive This property indicates whether keep-alive messages should be logged in OnLoggingEvent. LogKeepAlive Boolean LogMessageDelimiter This property specifies the delimiter used between individual values in To outputs of event files. LogMessageDelimiter LogMessageDelimiterEnum LogMsgDelimiterValue This property specifies the delimiter used between individual values in To outputs of event files. LogMsgDelimiterValue LogTcpIpBuffer This property indicates whether the messages exchanged via TCP/IP should be logged in OnLoggingEvent. LogTcpIpBuffer Boolean LogTimerActivity This property indicates,. LogTimerActivity Boolean LogWithTimestamp This property indicates whether the date and time value of the message should be contained in OnLoggingEvent. LogWithTimestamp Boolean OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 169

170 IMakeCallDataX Properties This interface makes the result data for the MakeCall method and the OnMakeCallEvent available. CallId This property contains the call ID of the call. CallId CstaError This property contains details on the CSTA error. CstaError ICstaErrorX This property contains the error code. ErrorEnum Extension This property contains the extension. Extension Methods IsCstaError This method indicates whether a CSTA error occurred. IsCstaError Boolean IsError This method indicates whether an error occurred. IsError Boolean 170 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

171 To This method returns a string that indicates the current object IOldCallIdListX To This interface makes a list of call IDs available Properties Count This property contains the number of lists. Count Integer Methods get_item This method returns the call ID. get_item s Index Integer List index GetEnumerator This method returns an enumerator IPartyDataX Properties GetEnumerator IEnumerator This interface makes detailed information on a call party available. Device This property contains the extension or the trunk number (for external subscribers). Device OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 171

172 DeviceDisplay This property contains the display of the extension. DeviceDisplay DeviceType This property contains the extension type. DeviceType DeviceTypeEnum Position This property indicates the position of the extension in the list of conference participants. Position int IPartyListX This interface makes a list of IPartyDataX objects available Properties Count This property contains the number of lists. Count Integer Methods get_item This methods returns the IPartyDataX object. get_item s Index Integer List index IPartyDataX 172 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

173 GetEnumerator This method returns an enumerator. GetEnumerator IEnumerator IPhoneCallStateChangeInfoDataX Properties This interface makes the result data for the OnPhoneCallStateChangeEvent available. Action This property specifies the action that led to the change. Action CallListChangeNotificationEnum Extension This property contains the extension. Extension ExtensionCallList This property contains the list of connected calls. ExtensionCallList IExtensionCallList SiteId This property contains the node name. SiteId UserData This property contains the additional user data. UserData OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 173

174 IPhoneClearedInfoDataX Properties This interface makes the information data for the OnPhoneClearedInfoEvent available. CallId This property contains the call ID of the disconnected call. CallId DisconnectedDevice This property contains the phone number that was disconnected from the connection. DisconnectedDevice DisconnectingDevice This property contains the phone number that disconnected the connection. DisconnectingDevice EventCause This property contains the event reason for a CSTA command. EventCause EventCauseEnum Extension This property contains the extension. Extension IPhoneDialingInfoDataX This interface makes the information data for the OnPhoneDialingInfoEvent available. 174 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

175 Properties CalledDevice This property contains the called phone number. CalledDevice CallId This property contains the call ID. CallId Extension This property contains the extension. Extension IPhoneRingingInfoDataX Properties This interface makes the information data for the OnPhoneRingingInfoEvent available. CallId This property contains the call ID of the disconnected call. CallId CallingDevice This property contains the incoming phone number. CallingDevice CallWaiting This property indicates the wait state. CallWaiting Boolean OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 175

176 EventCause This property contains the event reason for a CSTA command. EventCause EventCauseEnum Extension This property contains the extension. Extension LastRedirectingDevice This property contains the extension of the last call redirection. LastRedirectingDevice OriginalCalledDevice This property contains the originally called number. OriginalCalledDevice RingingDevice This property contains the extension at which the call arrives. RingingDevice SiteId This property contains the node name. SiteId IPhoneStateBusyInfoDataX This interface makes the information data for the OnPhoneStateBusyInfoEvent available. 176 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

177 Properties AlertingCallId This property contains the call ID of the alerting call. AlertingCallId BusyState This property contains the busy state. BusyState BusyStateEnum BusyStateDetail This property contains details on the busy state. BusyStateDetail BusyStateDetailEnum Extension This property contains the extension. Extension PartyDevice This property contains the subscriber phone number. PartyDevice SiteId This property contains the node name. SiteId UserData This property contains the additional user data. UserData OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 177

178 IPhoneStateChangeInfoDataX Properties This interface makes the information data for the OnPhoneStateChangeInfoEvent available. CallState This property contains the connection state. CallState CallStateEnum Direction This property contains the connection direction. Direction CallDirectionEnum Display This property contains the text of the device display. Display Extension This property contains the extension. Extension RemotePartyBusy This property indicates whether the remote party is busy. RemotePartyBusy Boolean ReplacedCallId This property contains the call ID replaced by the call ID of the conference. ReplacedCallId ServicePermittedFlags This property contains the current CTI functions. ServicePermittedFlags IServPermFlagsX 178 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

179 UserData This property contains the additional user data. UserData IReconnectCallDataX Properties This interface makes the result data for the ReconnectCall method and the OnReconnectCallEvent available. CstaError This property contains details on the CSTA error. CstaError ICstaErrorX This property contains the error code. ErrorEnum Extension This property contains the extension. Extension Methods IsCstaError This method indicates whether a CSTA error occurred. IsCstaError Boolean IsError This method indicates whether an error occurred. IsError Boolean OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 179

180 To This method returns a string that indicates the current object. To IRetrieveCallDataX Properties This interface makes the result data for the RetrieveCall method and the OnRetrieveCallEvent available. CstaError This property contains details on the CSTA error. CstaError ICstaErrorX This property contains the error code. ErrorEnum Extension This property contains the extension. Extension Methods IsCstaError This method indicates whether a CSTA error occurred. IsCstaError Boolean IsError This method indicates whether an error occurred. IsError Boolean 180 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

181 To This method returns a string that indicates the current object ISendDTMFDataX Properties To This interface makes the result data for the SendDTMF method and the OnSendDTMFEvent available. CstaError This property contains details on the CSTA error. CstaError ICstaErrorX This property contains the error code. ErrorEnum Extension This property contains the extension. Extension Methods IsCstaError This method indicates whether a CSTA error occurred. IsCstaError Boolean IsError This method indicates whether an error occurred. IsError Boolean OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 181

182 To This method returns a string that indicates the current object. To IServerConnectionStateChangeDataX Properties This interface makes the information data for the OnServerConnectionStateChangeEvent available. NewConnectionState This property contains the current connection state. NewConnectionState ServerConnectionStateEnum OldConnectionState This property contains the previous connection state. OldConnectionState ServerConnectionStateEnum ServerType This property contains the server type. ServerType ServerTypeEnum ISetAgentStateOsvHuntgroupDataX Properties This interface makes the result data for the SetAgentStateOsvHuntgroup method and the OnSetAgentStateOsvHuntgroupEvent available. CstaError This property contains details on the CSTA error. CstaError ICstaErrorX This property contains the error code. ErrorEnum 182 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

183 Extension This property contains the extension. Extension Methods IsCstaError This method indicates whether a CSTA error occurred. IsCstaError Boolean IsError This method indicates whether an error occurred. IsError Boolean To This method returns a string that indicates the current object. To ISetForwardingDataX This interface makes the result data for the SetForwarding method and the OnSetForwardingEvent available Properties CstaError This property contains details on the CSTA error. CstaError ICstaErrorX This property contains the error code. ErrorEnum OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 183

184 Extension This property contains the extension. Extension Methods IsCstaError This method indicates whether a CSTA error occurred. IsCstaError Boolean IsError This method indicates whether an error occurred. IsError Boolean To This method returns a string that indicates the current object. To ISingleStepTransferCallDataX Properties This interface makes the result data for the SingleStepTransferCall method and the OnSingleStepTransferCallEvent available. CallId This property contains the call ID of the transfer call. CallId CstaError This property contains details on the CSTA error. CstaError ICstaErrorX 184 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

185 This property contains the error code. ErrorEnum Extension This property contains the extension. Extension Methods IsCstaError This method indicates whether a CSTA error occurred. IsCstaError Boolean IsError This method indicates whether an error occurred. IsError Boolean To This method returns a string that indicates the current object. To ISiteStateInfoDataX Properties This interface makes the result data for the OnSiteStateInfoEvent available. FailoverFlag This property indicates whether, in the case of geographically separated OSV instances, an error led to a node change. FailoverFlag Boolean OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 185

186 FunctionNodeId This property contains the ID of the function node. FunctionNodeId Integer FunctionNodeSoftwareVersion This property contains the version number of the function node. FunctionNodeSoftwareVersion OSCCSiteKey This property contains the key of the OSCC instance (only with the HPPC connector type). OSCCSiteKey SiteId This property contains the node name. SiteId SiteType This property contains the node type. SiteType SiteTypeEnum State This property contains the state of the node. State SiteStateEnum TypeDetail This property contains detailed information on the node type. TypeDetail NodeTypeEnum 186 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

187 ISnapshotAdvCallListX This interface makes a list of ISnapshotAdvCallX objects available Properties Count This property contains the number of lists. Count Integer Methods get_item This methods returns the ISnapshotAdvCallX object. get_item s Index Integer List index ISnapshotAdvCallX GetEnumerator This method returns an enumerator ISnapshotAdvCallX GetEnumerator IEnumerator This interface makes the state of a call determined by a snapshot available Properties CallId This property contains the call ID of the call. CallId Lcs This property contains the connection state. Lcs LocalConnectionStateEnum OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 187

188 ServicePermittedFlags This property contains the CTI functions currently available. ServicePermittedFlags IServPermFlagsX Methods To This method returns a string that indicates the current object. To ISnapshotDeviceAdvancedDataX Properties This interface makes the result data for the SnapshotDeviceAdvanced method and the OnSnapshotDeviceAdvancedEvent available. CallList This property contains the list of connected calls. CallList ISnapshotAdvCallListX CstaError This property contains details on the CSTA error. CstaError ICstaErrorX This property contains the error code. ErrorEnum Extension This property contains the extension. Extension 188 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

189 UserData This property contains the additional user data. UserData Methods IsCstaError This method indicates whether a CSTA error occurred. IsCstaError Boolean IsError This method indicates whether an error occurred. IsError Boolean To This method returns a string that indicates the current object. To ISnapshotDeviceDataX Properties This interface makes the result data for the SnapshotDevice method and the OnSnapshotDeviceEvent available. CallId This property contains the call ID of the current call. CallId CstaError This property contains details on the CSTA error. CstaError ICstaErrorX OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 189

190 CstaVersion This property contains the CSTA log version. CstaVersion CstaVersionEnum This property contains the error code. ErrorEnum Extension This property contains the extension. Extension Lcs This property contains the connection state. Lcs LocalConnectionStateEnum UserData This property contains the additional user data. UserData Methods IsCstaError This method indicates whether a CSTA error occurred. IsCstaError Boolean IsError This method indicates whether an error occurred. IsError Boolean 190 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

191 To This method returns a string that indicates the current object. To IStartMonitorDeviceDataX Properties This interface makes the result data for the StartMonitorDevice method and the OnStartMonitorDeviceEvent available. Busy This property indicates whether the extension is busy. Busy Boolean CallId This property contains the call ID of the current call. CallId CstaError This property contains details on the CSTA error. CstaError ICstaErrorX CstaVersion This property contains the CSTA log version. CstaVersion CstaVersionEnum This property contains the error code. ErrorEnum Extension This property contains the extension. Extension OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 191

192 Extension Lcs This property contains the connection state. Lcs LocalConnectionStateEnum MonitorDeviceHandlingFlag This property contains details on the type of monitoring of the extension. MonitorDeviceHandlingFlag MonitorDeviceHandlingFlagEnum NodeType This property contains detailed information on the node type. NodeType NodeTypeEnum SiteId This property contains the node name. SiteId UserData This property contains the additional user data. UserData Methods IsCstaError This method indicates whether a CSTA error occurred. IsCstaError Boolean 192 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

193 IsError This method indicates whether an error occurred. IsError Boolean To This method returns a string that indicates the current object. To IStopMonitorDeviceDataX Properties This interface makes the result data for the StopMonitorDevice method and the OnStopMonitorDeviceEvent available. CstaError This property contains details on the CSTA error. CstaError ICstaErrorX CstaVersion This property contains the CSTA log version. CstaVersion CstaVersionEnum This property contains the error code. ErrorEnum Extension This property contains the extension. Extension MonitorDeviceHandlingFlag This property contains details on the type of monitoring of the extension. OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 193

194 MonitorDeviceHandlingFlag MonitorDeviceHandlingFlagEnum SiteId This property contains the node name. SiteId UserData This property contains the additional user data. UserData Methods IsCstaError This method indicates whether a CSTA error occurred. IsCstaError Boolean IsError This method indicates whether an error occurred. IsError Boolean To This method returns a string that indicates the current object. To ITransferCallDataX This interface makes the result data for the TransferCall method and the OnTransferCallEvent available. 194 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

195 Properties CallId This property contains the call ID of the transfer call. CallId CstaError This property contains details on the CSTA error. CstaError ICstaErrorX This property contains the error code. ErrorEnum Extension This property contains the extension. Extension Methods IsCstaError This method indicates whether a CSTA error occurred. IsCstaError Boolean IsError This method indicates whether an error occurred. IsError Boolean OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 195

196 To This method returns a string that indicates the current object. To ITransferCompletedInfoDataX Properties This interface makes the result data for the OnTransferCompletedInfoEvent available. CallId This property contains the call ID of the transfer call. CallId ConnectionList This property contains the list of subscribers connected after the transfer. ConnectionList IConnectionListX EventCause This property contains the event reason of the CSTA command. EventCause EventCauseEnum Extension This property contains the transferred extension. Extension LastRedirectionDevice This property contains the extension of the last call redirection. LastRedirectionDevice 196 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

197 Lcs This property contains the connection state. Lcs LocalConnectionStateEnum OldCallIdOnHold This property contains the call ID of the original call. OldCallIdOnHold OldCallIdTransferTo This property contains the call ID of the consultation call. OldCallIdTransferTo SiteId This property contains the node name. SiteId TransferedDevice This property contains the transferred extension. TransferedDevice TransferedToDevice This property contains the called number of the transfer. TransferedToDevice TransferingDevice This property contains the transferring extension. TransferingDevice OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 197

198 ITransferedInfoDataX Properties This interface makes the result data for the OnTransferedInfoEvent available. CallId This property contains the call ID of the transfer call. CallId ConnectionList This property contains the list of subscribers connected after the transfer. ConnectionList IConnectionListX EventCause This property contains the event reason of the CSTA command. EventCause EventCauseEnum Extension This property contains the transferred extension. Extension LastRedirectionDevice This property contains the extension of the last call redirection. LastRedirectionDevice Lcs This property contains the connection state. Lcs LocalConnectionStateEnum 198 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

199 OldCallId This property contains the call ID of the consultation call. OldCallId SiteId This property contains the node name. SiteId TransferedDevice This property contains the transferred extension. TransferedDevice TransferedToDevice This property contains the called number of the transfer. TransferedToDevice TransferingDevice This property contains the transferring extension. TransferingDevice IUserAgentServPermFlagsX Properties This interface makes the possible agent state functions available. Available This property indicates whether the agent could change to the "available" state. Available Boolean OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 199

200 Logon This property indicates whether the agent could change to the "logged on" state. Logon Boolean Logoff This property indicates whether the agent could change to the "logged off" state. Logoff Boolean Unavailable This property indicates whether the agent could change to the "unavailable" state. Unavailable Boolean Work This property indicates whether the agent could change to the "work" state. Work Boolean 200 OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide

201 Realtime Basics 3 Realtime 3.1 Basics The real-time interface enables access to the real-time data of a contact center. This interface can be used to collect real-time data of the contact center. There are three types of real-time information. Queues These real-time data deliver the current state of a queue. This includes how many agents are currently available in the status, information on the accessibility of the queue and the average wait period for incoming calls. Groups These data contain the current figures on the handled tasks within a group and information on the current load. NOTE: Groups are only used in connection with Genesys. Agents In addition to general information, these data contain, for example, the average processing time of a task and the current state of an agent System architecture The data described above can be used via the interface library. The interface is available as a COM DLL and Java API. The interface library can therefore be used in any programming language that exists for a COM implementation, e.g. Visual Basic, Visual C# and Delphi. The Java API is used in Java projects. The following figure shows how the information flow between the various layers in the architecture is structured. The Platform Level contains the basic physical system. Two different contact centers are shown here, namely the OSCC (OpenScape ContactCenter) and Genesys. OpenScape Contact Center Extensions V2R1, Integration Connector, Programming Guide 201