1. Manuals
  2. Brands
  3. Altigen Manuals
  4. Software
  5. AltiAgent ActiveX
  6. Programmer's manual

Altigen AltiAgent ActiveX Programmer's Manual

Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual
AltiAgent ActiveX Programmer's Guide
This document provides instructions on configuring and using ActiveX controls 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

Advertisement

Table of Contents
loading

Related Manuals for Altigen AltiAgent ActiveX

Summary of Contents for Altigen AltiAgent ActiveX

  • Page 1: Table Of Contents

    AltiAgent ActiveX Programmer’s Guide This document provides instructions on configuring and using ActiveX controls with AltiAgent. API reference information is also provided. Contents Using an AltiAgent ActiveX Control Object ......... 2 Understanding Key Files .

  • Page 2: Using An Altiagent Activex Control Object

    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.

  • Page 3: Using Appwizard To Create A Project

    AltiAgent ActiveX Programmer’s Guide Using AppWizard to Create a Project Use AppWizard to create a dialog based MFC project: Choose MFC AppWizard (exe) and create a new win32 project named "ExampleVc"; press Next. Set Dialog based as the type of the Application; press Next. Keep ActiveX Control and Windows Sockets checkboxes checked.

  • Page 4: Altiagent Activex Control Api Reference

    AltiAgent ActiveX Programmer’s Guide In the Add Member Variable dialog, create a member variable named m_altictrl. 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...
  • Page 5 AltiAgent ActiveX Programmer’s Guide Parameters ulSessionID = Session ID uStatus = Call Status szCallerID = Caller ID szCallerName = Caller Name szCallDNIS = DNIS pszDateTime = Call start date and time pszDuration = Conversation duration...
  • Page 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...

  • Page 7: Altictrl Methods

    AltiAgent ActiveX Programmer’s Guide 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...

  • Page 8: Setivrdata

    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.

  • Page 9: Getivrdata

    AltiAgent ActiveX Programmer’s Guide 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...

  • Page 10: Seturldata

    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.

  • Page 11: Setcallername

    AltiAgent ActiveX Programmer’s Guide VB Syntax object.GetURLData(SessionID) Parameters SessionID [In]: unique ID for a call Return Type String URL 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.

  • Page 12: Getextnumber

    AltiAgent ActiveX Programmer’s Guide VB Example Dim data As String Data = "Tom"; If (AltiCtrl1.SetCallerName(ulSessionID, data) = False) Then Else End If GetExtNumber Description Get extension number which AltiAgent had been logged in. VC++ Syntax BSTR GetExtNumber() VB++ Syntax object.GetExtNumber() Return type String extension number for the AltiAgent login is 256 bytes.

  • Page 13: Gettrunkaccesscode

    AltiAgent ActiveX Programmer’s Guide 1 - Unknown error occurs 2 - Disconnect AltiAgent 999 - Exception occurred VC++ Example BOOL bstart= m_altictrl. MakeCall(L"101"); VB Example Dim Result as Integer Dim dirNum As String dirNum = "101" Result = AltiCtrl1.MakeCall(dirNum) GetTrunkAccessCode Description Get default trunk access code set in AltiAgent.
  • Page 14 AltiAgent ActiveX Programmer’s Guide VC++ Syntax long DropCall(); VB++ Syntax long DropCall(); Return type 0 - Drop call command is sent successfully 0 - Unknown error occurs VC++ Example long result = m_altictrl.DropCall(); VB Example Dim data As Long data = AltiCtrl1.DropCall() SetBK Description Sets the background color of AltiCtrl.

Table of Contents