background image

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)

Summary of Contents for AltiAgent ActiveX

Page 1: ...sing 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...

Page 2: ...handled automatically at run time AltiCtrl ocx third party applications use this ActiveX control module to develop applications It needs to be registered before starting application development Note...

Page 3: ...nts 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 Al...

Page 4: ...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...

Page 5: ...iveX 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 Conversat...

Page 6: ...DTRANSFER LINECALLSTATE_DISCONNECTED LINECALLSTATE_AA LINECALLSTATE_VM LINECALLSTATE_PARK LINECALLSTATE_UNKNOWN LINECALLSTATE_MUSICONHOLD LINECALLSTATE_PLAYVOICEMAIL LINECALLSTATE_CALLPENDING LINECALL...

Page 7: ...r 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 p...

Page 8: ...ID 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 Las...

Page 9: ...nt 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...

Page 10: ...e 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...

Page 11: ...data As String Data AltiCtrl1 GetURLData ulSessionID SetCallerName Description Set Caller Name for existing call VC Syntax BOOL SetCallerName int SessionID BSTR string VB Syntax object SetCallerNameD...

Page 12: ...object GetExtNumber Return type String extension number for the AltiAgent login is 256 bytes VC Example CComBSTR bstrData m_altictrl GetExtNumber VB Example Dim data as String data AltiCtrl1 GetExtNu...

Page 13: ...ccess code set in AltiAgent VC Syntax BSTR GetTrunkAccessCode VB Syntax object GetTrunkAccessCode Return type Default trunk access code set in AltiAgent VC Example CComBSTR bstrTrunkAccess m_altictrl...

Page 14: ...opCall SetBK Description Sets the background color of AltiCtrl VC Syntax long SetBk short sRed short sGreen short sBlue VB Syntax long SetBk short sRed short sGreen short sBlue Parameters sRed in RGB...

Reviews: