Altigen AltiAgent ActiveX Manual

AltiAgent ActiveX Programmer’s Guide

Thisdocument provides instructions on configuringand using ActiveXcontrols with AltiAgent. API

reference information is also provided.

Contents

Using an AltiAgent ActiveX Control Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2

Understanding Key Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2

Basic Procedure to Use an ActiveX Object with AltiAgent. . . . . . . . . . . . . . . . . . . . . . . . . . . .2

Using AppWizard to Create a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Inserting AltiCtrl into dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Handle AltiCtrl Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3

AltiCtrl Methods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3

AltiAgent ActiveX Control API Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4

StartAltiCtrl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

AltiCtrl Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4

CallNotify. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

AltiCtrl Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

SetUserData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

GetUserData. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

SetIVRData. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8

GetIVRData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

SetURLData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

GetURLData. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

SetCallerName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

GetExtNumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

MakeCall . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

GetTrunkAccessCode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13

Related Documentation

• AltiGen AltiAgent Manual - information on installation and configuration of the AltiAgent

client system software.

02/2008

2 AltiAgent ActiveX Programmer’s Guide

Using an AltiAgent ActiveX Control Object

The AltiAgent ActiveX Control Object is an ActiveX Object. It will work with AltiAgent, getting

call-related information from AltiAgent, which acts as a server, and implement actions based on the

call information, for example, popping up corresponding customer information and logging caller

ID into a database.

This document contains descriptions of AltiAgent ActiveX Control Object files and type library,

followed by examples in VC++ and VB.

Understanding Key Files

•AltiCtrl.tlb—this type library file contains functions within the AltiCtrl ActiveX Object.

Methods contained in this type library need to be used directly by Visual C++ developers. In

Visual Basic, type library functions are handled automatically at run time.

•AltiCtrl.ocx—third party applicationsusethisActiveX controlmodule to develop applications.

It needs to be registered before starting application development.

Note: Before using AltiAgent AltiCtrl to develop your application, you need to register

AltiCtrl.ocx using RegSvr32.exe first. Because this object will work with AltiAgent, you

need to run an AltiAgent client when you develop and run your application on the same

machine.

Basic Procedure to Use an ActiveX Object with AltiAgent

To use ActiveX control object with AltiAgent:

1. Make sure AltiAgent is installed on the client desktop PC.

2. Copy AltiCtrl.ocx file from the AltiAgent API directory to the Windows system32 directory.

3. Bring up the command prompt and register altictrl.ocx

4. Edit VB or VC sample code to interface with destination client application.

5. Compile customized code to an executable file.

6. Copy that executable file to the same directory as AltiAgent.

AltiAgent ActiveX Programmer’s Guide 3

Using AppWizard to Create a Project

Use AppWizard to create a dialog based MFC project:

1. Choose MFC AppWizard (exe) and create a new win32 project named "ExampleVc"; press

Next.

2. Set Dialog based as the type of the Application; press Next.

3. Keep ActiveX Control and Windows Sockets checkboxes checked.

4. The program uses shared MFC DLLs (AltiCtrl uses shared MFC DLLs).

5. Click Finished to create the project.

Inserting AltiCtrl into dialog

AltiCtrl is an ActiveX Control without any GUI. It is invisible and can be inserted anywhere.

1. Open the main dialog (IDD_EXAMPLEVC_DIALOG)

2. Right-click the dialog and a context menu will display.

3. Choose Insert ActiveX Control to display the Insert ActiveX Control dialog box.

4. Select AltiCtrl Control and click OK to add it.

5. Place the control at a suitable location and size it as desired. Please note that the control is

invisible at runtime.

6. Identify the control as IDC_ALTICTRLCTRL1 (default value).

Handle AltiCtrl Events

To add an event process function:

1. Open Class Wizard and go to Message Maps page.

2. Set CExampleVcDlg as current class.

3. Set IDC_ALTICTRLCTRL1 as current selection of “Object Ids” list box and all AltiCtrl

Events will be displayed in Message list box.

4. Add member functions for the events you would like to handle.

5. Add code for these member functions.

AltiCtrl Methods

When adding a function to handle an AltiCtrl Event, you don't need to worry about how and when

the function is called. AltiCtrl will perform the event call back for you.

When using the AltiCtrl properties of getting and setting methods, you can use AltiCtrl to set or

monitor a Call property. Before doing so, you must add a member variable associated with this

control.

To add a member variable associated with this control:

1. Open Class Wizard and go to Member Variables page.

2. Set CExampleVcDlg as current class.

3. Double-click IDC_ALTICTRLCTRL1 of Control Ids list box and a message box will be

displayed to prompt you to add the ActiveX Control AltiCtrlinto the project. Click OK to have

Developer Studio generate a C++ wrapper class.

4. When the Confirm Classes dialog box appears, set CAltiCtrl as the class name and click OK.

4 AltiAgent ActiveX Programmer’s Guide

5. In the Add Member Variable dialog, create a member variable named m_altictrl.

6. Click OK to add it to the class. m_altictrl is now a member of CAltiCtrl.

Now, VC has created a member in class CExampleVcDlg which can be used as a general object.

AltiAgent ActiveX Control API Reference

StartAltiCtrl

Description

Start AltiCtrl on the client. This is the first step to use this AltiCtrl.

VC++ Syntax

BOOL StartAltiCtrl()

VB++ Syntax

object.StartAltiCtrl()

Return type

BOOL - TRUE if connect to AltiAgent successfully; otherwise FALSE.

Remark

This function is the key of using AltiCtrl. Client cannot call the method or get any event from

AltiAgent if this function call fails.

VC++ Example

BOOL bstart= m_altictrl.StartAltiCtrl();

VB Example

Dim bstart as bool

bstart = AltiCtrl1.StartAltiCtrl()

AltiCtrl Event

CallNotify

Description

When AltiView/AltiAgent 5.0 receives a call event from AltiServ, AltiCtrl will send the event to

your application, each call will have an unique session ID, each call may several events with its

unique session ID.

Syntax

OnCallNotifyXXXXX (long ulSessionID, short uStatus, BSTR

szCallerID, BSTR szCallerName, BSTR szCallDNIS, BSTR szWorkgroup,

BSTR pszDateTime, BSTR pszDuration)

AltiAgent ActiveX Programmer’s Guide 5

Parameters

ulSessionID

uStatus

szCallerID

szCallerName

szCallDNIS

pszDateTime

pszDuration

= Session ID

= Call Status

= Caller ID

= Caller Name

= DNIS

= Call start date and time

= Conversation duration

6 AltiAgent ActiveX Programmer’s Guide

Remark

Call status value:

LINECALLSTATE_IDLE

LINECALLSTATE_OFFERING

LINECALLSTATE_ACCEPTED

LINECALLSTATE_DIALTONE

LINECALLSTATE_DIALING

LINECALLSTATE_RINGBACK

LINECALLSTATE_BUSY

LINECALLSTATE_SPECIALINFO

LINECALLSTATE_CONNECTED

LINECALLSTATE_PROCEEDING

LINECALLSTATE_ONHOLD

LINECALLSTATE_CONFERENCED

LINECALLSTATE_ONHOLDPENDCONF

LINECALLSTATE_ONHOLDPENDTRANSFER

LINECALLSTATE_DISCONNECTED

LINECALLSTATE_AA

LINECALLSTATE_VM

LINECALLSTATE_PARK

LINECALLSTATE_UNKNOWN

LINECALLSTATE_MUSICONHOLD

LINECALLSTATE_PLAYVOICEMAIL

LINECALLSTATE_CALLPENDING

LINECALLSTATE_MONITORSIRENT

LINECALLSTATE_CALLBARGEIN

LINECALLSTATE_XFER_RINGBACK

LINECALLSTATE_XFER_WAITFORONHOOK

LINECALLSTATE_DUMMYRING

LINECALLSTATE_FORWARDRING

LINECALLSTATE_DATALOAD

LINECALLSTATE_RECORD

LINECALLSTATE_APC

LINECALLSTATE_SUPERVISE_COACH

LINECALLSTATE_LINE_PARK

LINECALLSTATE_RMT_OFFLINE

AltiAgent ActiveX Programmer’s Guide 7

AltiCtrl Methods

SetUserData

Description

Set user data for existing call. User data is used for AltiAgent to describe a call information, for

example “This call is urgent” and so on. It can be any information defined by user.

VC++ Syntax

BOOL SetUserData(int SessionID , BSTR string)

VB Syntax

object.SetUserData(SessionID,string)

Parameters

SessionID [In] - unique ID for a call

String [In] - set user data for a call; maximum length is 256 bytes. It is only used for trunk line calls.

Return Type

BOOL - if successful TRUE; otherwise FALSE

Remark

SessionID - Session ID received from OnCallNotify event needs to be provided as input to this

function. This Session ID is valid in ring event and connect event. After Disconnect event, it is no

longer valid.

VC++ Example

CComBSTR bstrdata = _T("user data");

m_altictrl. SetUserData (ulSessionID, bstrData);

VB Example

Dim data As String

Data = "user data"

If (AltiCtrl1.SetUserData(ulSessionID, data) = False) Then

...

Else

...

End If

GetUserData

Description

Get user data for existing call.

VC++ Syntax

BSTR GetUserData(int SessionID)

8 AltiAgent ActiveX Programmer’s Guide

VB Syntax

object.GetUserData(SessionID)

Parameters

SessionID - [In]: unique ID for a call

Return Type

String user data for a call; maximum length is 256 bytes.

Remark

SessionID - Session ID received from OnCallNotify event needs to be provided as input to this

function. This Session ID is valid in ring event and connect event. After Disconnect event, it is no

longer valid.

VC++ Example

CComBSTR bstrData;

bstrData = m_altictrl.GetUserData (ulSessionID);

VB Example

Dim data As String

Data = AltiCtrl1.GetUserData(ulSessionID)

SetIVRData

Description

Set IVR data for existing call (used only in Web call). IVR data is the format of “name=value” pairs,

which can be used in Web Call and Auto Atendant; for example:

“FirstName=John&LastName=Anny&Password=hello1234” and so on.

Note

SetIVRData is a reserved API.

VC++ Syntax

BOOL SetIVRData(int SessionID, BSTR string)

VB Syntax

object.SetIVRData(SessionID,string)

Parameters

SessionID [In]: unique ID for a call

String [In]: Set IVR data for a call, maximum length is 256 bytes

Return Type

BOOL - if successful TRUE; otherwise FALSE.

Remark

SessionID - Session ID received from OnCallNotify event needs to be provided as input to this

function. This Session ID is valid in ring event and connect event. After Disconnect event, it is no

longer valid.

AltiAgent ActiveX Programmer’s Guide 9

VC++ Example

CComBSTR bstrData = _T("ivr data");

m_altictrl. SetURLData (ulSessionID, bstrdata);

VB Example

Dim data As String

Data = "ivr data"

If (AltiCtrl1.SetURLData(ulSessionID, data) = False) Then

...

Else

...

End If

GetIVRData

Description

Get IVR data for existing call.

VC++ Syntax

BSTR GetIVRData(int SessionID)

VB Syntax

object.GetIVRData(SessionID)

Parameters

SessionID [In]: unique ID for a call

Return Type

String IVR data for a call; maximum length is 256 bytes.

Remark

SessionID - Session ID received from OnCallNotify event needs to be provided as input to this

function. This Session ID is valid in ring event and connect event. After Disconnect event, it is no

longer valid.

VC++ Example

CComBSTR bstrData;

bstrData = m_altictrl.GetIVRData (ulSessionID);

VB Example

Dim data As String

Data = AltiCtrl1.GetIVRData(ulSessionID)

10 AltiAgent ActiveX Programmer’s Guide

SetURLData

Description

Set URL data for existing call (used only in Web call). When a call comes to a Web site, it can

contain URL data such as “http://www.altigen.com,” so that the user application can know where

this call comes from.

Note

SetURLData is a reserved API.

VC++ Syntax

BOOL SetURLData(int SessionID,BSTR string)

VB Syntax

object.SetURLData(SessionID,string)

Parameters

SessionID [In]: unique ID for a call

String [In] Set URL data for a call; maximum length is 256 bytes.

Return Type

BOOL - if successful TRUE; otherwise FALSE

Remark

SessionID - Session ID received from OnCallNotify event needs to be provided as input to this

function. This Session ID is valid in ring event and connect event. After Disconnect event, it is no

longer valid.

VC++ Example

CComBSTR bstrData = _T("url data");

m_altictrl. SetURLData (ulSessionID, bstrData);

VB Example

Dim data As String

Data = "url data"

If (AltiCtrl1.SetURLData(ulSessionID, data) = False) Then

...

Else

...

End If

GetURLData

Description

Get URL data for existing call

VC++ Syntax

BSTR GetURLData(int SessionID)

Tabla de contenidos

Otros manuales de Software de Altigen

Altigen

Altigen VRManager Manual de usuario

Altigen

Altigen AltiConsole Manual de usuario

Altigen

Altigen MAX Communication Server Release 6.5 Manual de usuario

Altigen

Altigen AltiView Manual de usuario

Altigen

Altigen AltiServ Manual de usuario

Altigen

Altigen Call Detail Reporting Manual de usuario

Altigen

Altigen VRManager Manual de usuario

Altigen

Altigen AltiConsole 4.5 Manual de usuario

Altigen

Altigen AltiReport Manual de usuario

Altigen

Altigen AltiWeb Manual de usuario

Altigen

Altigen AltiReport Manual de usuario

Altigen

Altigen Altiware OE 4.0 Guide Manual de usuario

Altigen

Altigen SuperQ Manual de usuario

Altigen

Altigen AltiConsole Manual de usuario

Altigen

Altigen VRManager Manual de usuario

Altigen

Altigen AltiContact Manager Version 4.6 Manual de instrucciones

Altigen

Altigen Advanced Call RouterTM Manual de usuario

Altigen

Altigen Adv Call Router 6/2008 4510-0001-6.0 Manual de usuario

Altigen

Altigen VRManager Manual de usuario

Altigen

Altigen AltiWare OE/ACC Version 5.0 Manual de instrucciones

Altigen

Altigen Call Detail Reporting Manual de usuario

Altigen

Altigen AltiWare OE Release 4.0 Manual de instrucciones

Altigen

Altigen AltiView Manual de usuario

Altigen

Altigen MAXCS ACC 6.5 Manual de instrucciones

Manuales populares de Software de otras marcas

COMPRO

COMPRO COMPROFM Manual de usuario

Muratec

Muratec OFFICEBRIDGE ONLINE Manual de usuario

Oracle

Oracle Contact Center Anywhere 8.1 Manual de usuario

Adobe

Adobe 65007312 - Photoshop Lightroom Manual

Avaya

Avaya NULL One-X for RIM Blackberry Manual de usuario

HP ProLiant BL420c Manual de usuario

PS Audio

PS Audio PowerPlay Manual del propietario

Brady

Brady LOCKOUT PRO 3.0 Manual de servicio

Avaya

Avaya Interaction Center Manual de usuario

Texas Instruments

Texas Instruments TI-83 Plus Silver Edition Manual

Novell

Novell GROUPWISE 8 - INTERNET AGENT Manual de usuario

Oracle

Oracle Application 9i Manual de usuario

Acer

Acer RDM Manual de usuario

Canon

Canon Vixia HF21 Manual de usuario

Canon

Canon ZR950 Manual de usuario

Samsung

Samsung Auto Backup Manual de usuario

Polycom

Polycom Vortex EF2201 Instrucciones de instalación y funcionamiento

Brocade Communications Systems

Brocade Communications Systems Brocade 8/12c Manual de usuario