Avaya IP Office CTI Link Programmer's Manual
Avaya IP Office CTI Link Programmer's Manual

Avaya IP Office CTI Link Programmer's Manual

Devlink
Hide thumbs Also See for IP Office CTI Link:

Advertisement

IP Office CTI Link
DevLink Programmer's Guide
40DHB0002UKAD Issue 11a (14th June 2005)

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the IP Office CTI Link and is the answer not in the manual?

Questions and answers

Summary of Contents for Avaya IP Office CTI Link

  • Page 1 IP Office CTI Link DevLink Programmer’s Guide 40DHB0002UKAD Issue 11a (14th June 2005)
  • Page 3: Table Of Contents

    Table Of Contents CTI DevLink ..........................5 Overview..............................5 IP Office CTI Link Lite..........................5 IP Office CTI Link Pro..........................5 DevLink............................... 6 Using the DevLink DLL..........................6 Using DevLink with Microsoft Visual C++ ....................6 Using DevLink with Borland Delphi......................6 Connecting to an IP Office using DevLink................
  • Page 5: Cti Devlink

    CTI DevLink Overview IP Office DevLink is part of the IP Office CTI Link Software Development Kit. The IP Office CTI Link is available in Lite and Pro versions, which provide run-time interfaces for applications to use. The Software Development Kit (SDK) provides documentation on both Lite and Pro interfaces for software developers.
  • Page 6: Devlink

    DevLink enables third-party applications, such as call recorders to use information provided by the telephone system. Please refer to the IP Office CTI Link Installation Manual for installation instructions. When the DevLink component is installed, a Windows Dynamic Link Library, DEVLINK.DLL is installed, by default, into "Program Files/Avaya/IP Office/DEV Link"...
  • Page 7: Connecting To An Ip Office Using Devlink

    3. The pbx_password parameter should be the monitor password of the switch, not the system password. 4. The reserved1 and reserved2 parameters are for future expansion, and should be set to NULL (nil in Delphi). DevLink Programmer’s Guide Page 7 IP Office CTI Link 40DHB0002UKAD Issue 11a (14th June 2005)
  • Page 8: Example: Connecting To Ip Office In "C

    = FALSE; if( dwCommsEvent == DEVLINK_COMMS_OPERATIONAL ) { printf("Connected OK\n"); else { printf("Error connecting to IP Office\n"); DLClose( 0 ); CloseHandle( hEvent ); return 0; DevLink Programmer’s Guide Page 8 IP Office CTI Link 40DHB0002UKAD Issue 11a (14th June 2005)
  • Page 9: Example: Connecting To Ip Office In Delphi

    DLOpen( 0, '255.255.255.255', 'systempassword', nil, nil, - HandleCommsEvent dwCommsEvent := DEVLINK_COMMS_NORESPONSE; WaitForSingleObject( hEvent, 10000 ); // 10-second timeout bStarting := FALSE; if dwCommsEvent = DEVLINK_COMMS_OPERATIONAL then begin ShowMessage('Connected OK'); else begin DevLink Programmer’s Guide Page 9 IP Office CTI Link 40DHB0002UKAD Issue 11a (14th June 2005)
  • Page 10: Disconnecting

    To disconnect from IP Office, use the DLClose() routine, passing the same application-supplied handle that was used to open the connection: LONG PASCAL DLClose( LONG pbxh ); DevLink Programmer’s Guide Page 10 IP Office CTI Link 40DHB0002UKAD Issue 11a (14th June 2005)
  • Page 11: Devlink Real-Time Event Stream

    The second parameter is a string, containing the call record. The call record is a comma-separated string, with variable width fields. The string will always be less than 1500 bytes in length inclusive of a terminating NULL character. DevLink Programmer’s Guide Page 11 IP Office CTI Link 40DHB0002UKAD Issue 11a (14th June 2005)
  • Page 12: S Events

    This field contains two numbers: 1) an indicator of how the called presentation & party details should be presented, and 2) the type of data to be DevLink Programmer’s Guide Page 12 IP Office CTI Link 40DHB0002UKAD Issue 11a (14th June 2005)
  • Page 13 Non-zero indicates that the call is being transferred. Service active Number Non-zero if the service is active. Service quota Number Non-zero if the service quota is used. DevLink Programmer’s Guide Page 13 IP Office CTI Link 40DHB0002UKAD Issue 11a (14th June 2005)
  • Page 14 Service quota time Number The service quota time. Account code String The account code of the call, if any CallID Number Unique call id DevLink Programmer’s Guide Page 14 IP Office CTI Link 40DHB0002UKAD Issue 11a (14th June 2005)
  • Page 15: Field 25 Cause Codes

    The call is no longer the primary call, i.e. it is now a waiting call CMCauseLineAppearanceCall CMCauseUnheldCall CMCauseReplaceCurrentCall CMCauseGlare CMCauseR21CompatConfMove The call has been placed into a conference DevLink Programmer’s Guide Page 15 IP Office CTI Link 40DHB0002UKAD Issue 11a (14th June 2005)
  • Page 16: D Events

    Call id for the A end of the call B call id String Call id for the B end of the call CallID Number Unique call id DevLink Programmer’s Guide Page 16 IP Office CTI Link 40DHB0002UKAD Issue 11a (14th June 2005)
  • Page 17: Devlink Reference

    , TEXT * reserved1 , TEXT * reserved2 , COMMSEVENT cb Delphi function DLOpen(pbxh: LongInt; pbx_address: PChar; pbx_password: PChar; reserved1: PChar; reserved2: PChar; cb: TCommsEvent): LongInt; stdcall; DevLink Programmer’s Guide Page 17 IP Office CTI Link 40DHB0002UKAD Issue 11a (14th June 2005)
  • Page 18: Dlclose

    This routine may return 0 (DEVLINK_SUCCESS) or 1 (DEVLINK_UNSPECIFIEDFAIL) in the event of an error. C / C++ LONG PASCAL DLClose( LONG pbxh ); Delphi function DLClose(pbxh: LongInt): LongInt; stdcall; DevLink Programmer’s Guide Page 18 IP Office CTI Link 40DHB0002UKAD Issue 11a (14th June 2005)
  • Page 19: Dlregistertype2Calldeltas

    2 = DEVLINK_LICENCENOTFOUND - If no CTI licence is activated on the IP Office system. C / C++ LONG PASCAL DLRegisterType2CallDeltas( LONG pbxh, CALLLOGEVENT cb ); Delphi function DLRegisterType2CallDeltas(pbxh: LongInt; cb: TCallLogEvent): LongInt; stdcall; DevLink Programmer’s Guide Page 19 IP Office CTI Link 40DHB0002UKAD Issue 11a (14th June 2005)
  • Page 20: Callbacks

    (CALLBACK * COMMSEVENT)( LONG pbxh, DWORD comms_state, DWORD parm1 Delphi type TCommsEvent = procedure( pbxh : LongInt; comms_state : DWORD; Parm1 : DWORD ); DevLink Programmer’s Guide Page 20 IP Office CTI Link 40DHB0002UKAD Issue 11a (14th June 2005)
  • Page 21: Calllogevent

    C / C++ typedef void (CALLBACK * CALLLOGEVENT)( Long pbxh, TEXT * info Delphi type TCallLogEvent = procedure( pbxh : LongInt; info : PChar ); DevLink Programmer’s Guide Page 21 IP Office CTI Link 40DHB0002UKAD Issue 11a (14th June 2005)
  • Page 23: Appendices

    This appendix contains a copy of the DEVLINK.PAS file, used for Borland Delphi programs. unit DEVLINK; {**************************************************************************} { Delphi unit for DevLink (c) 2001 Avaya Global SME Solutions { Contents:- } { IP Office DevLink DLL provides an interface for managing }...
  • Page 24: Devlink.h

    This appendix contains a copy of the DEVLINK.H header file, used for C and C++ programs. /********************************************************************/ /* */ /* C/C++ Header File (c) 2001 Avaya Global SME Solutions */ /* */ /* Contents:- */ /* IP Office Dev link DLL provides an interface for managing /* the IP Office product ranges from a Windows PC.
  • Page 25: Index

    DevLink Pro 5 DLRegisterCallDelta Cb 7, 17, 19, 23 CD 5 DevLink Real-Time 2 11 Classes 9 IP Office CTI Link 5 Event Stream 11 DLRegisterType2Cal CLI/ANI 5 IP Office CTI Link DEVLINK.DLL 6, 23 lDeltas 19, 23 CloseHandle 8, 9 Installation Manual DEVLINK.H 6, 8, 24...
  • Page 26 Printed Documentation IP Office CTI Link terminating 11 Reserved1 7, 17, 23, identify 12 Installation Manual 6 NULL 7, 8, 11, 17, TDM 12 IP Office CTI Link Reserved2 7, 17, 23, Terminating Lite 5 Number NULL 11 IP Office CTI Link...
  • Page 28: Ip Office Cti Link 40Dhb0002Ukad Issue 11A (14Th June

    Performance figures and data quoted in this document are typical, and must be specifically confirmed in writing by Avaya before they become applicable to any particular order or contract. The company reserves the right to make alterations or amendments to the detailed specifications at its discretion.

Table of Contents