Avaya-devlink-Ipoffi..
Contents
1. dwCommsEvent comms evt SetEvent hEvent else insert your code here break case DEVLINK COMMS MISSEDPACKETS Indicates that the system is under heavy load IP Office always prioritises data routing and call handling above CTI events parml contains the number of packets missed break int main int argc char argv printf connecting bStarting TRUE hEvent CreateEvent NULL FALSE FALSE NULL DLOpen 0 255 255 255 255 systempassword NULL NULL HandleCommsEvent dwCommsEvent DEVLINK COMMS NORESPONSE WaitForSingleObject hEvent 10000 10 seconds bStarting FALSE if dwCommsEvent EVLINK 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 Connecting to an IP Office using DevLink Example Connecting to IP Office in Delphi Note that the systempassword in the call to DLOpen should be replaced with your unit s actual system password unit Unitl interface uses Windows Messages SysUtils Classes Graphics Controls Forms Dialogs StdCtrls type TForml class TForm2. Buttonl TButton procedure ButtonlClick Sender TObject procedure Button2Click Sender TObject private Private declarations public Public declarations end var Forml TForml implementation uses devlink SR DFM var hEvent THANDLE dwCommsEvent DWORD bStarting boolean procedure HandleCommsEvent pbxh LongInt Comms status DWORD Parml DWORD stdcall begin case Comms status of DEVLINK COMMS OPERATIONAL DEVLINK COMMS NORESPONSE DEVLINK COMMS REJECTED begin if bStarting then begin dwCommsEvent comms status SetEvent hEvent end end DEVLINK COMMS MISSEDPACKETS begin parml indicates the number of packets missed end end end procedure TForml ButtonlClick Sender TObject begin bStarting TRUE hEvent CreateEvent nil FALSE FALSE nil 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 end else begin DevLink Programmer s Guide Page 9 IP Office CTI Link 40DHB0002UKAD Issue 11a 14th June 2005 Printed Documentation ShowMessage Error connect
3. 2 calling 11 DLRegisterCallDelta 2 11 DLRegisterType2Cal IDeltas 19 23 DwCommsEvent 8 9 DWORD 9 20 23 DWORD comms evt 8 DWORD comms state 20 24 DWORD dwCommsEvent 8 DWORD parm 8 20 24 Dynamic Link Libraries 6 E EConsole 12 Endif 24 Events 16 Example 8 9 F Field1 gt lt field2 12 Field1 gt lt field2 gt lt f ield3 16 Field50 12 Form1 9 Forms 9 G Graphics 9 H HANDLE pbxh 11 24 HandleCommsEvent 8 9 Hangup 5 Header File 24 HEvent 8 9 Identify TDM 12 Identify 12 Ifdef 24 Ifndef 24 Installing CTI Pro 6 Installing 6 Int 8 Int argc 8 IP specify 17 IP 7 17 IP Office connect 7 8 9 17 20 21 releases 12 IP Office 7 8 9 10 11 12 17 18 19 20 21 23 24 IP Office 1 3 Admin CD 5 IP Office CTI Link 5 IP Office CTI Link Installation Manual refer 6 Page 25 40DHB0002UKAD Issue 11a 14th June 2005 Printed Documentation IP Office CTI Link Installation Manual 6 IP Office CTI Link Lite 5 IP Office CTI Link Pro5 IP Office CTI Link Software Development Kit part 5 IP Office CTI Link Software Development Kit 5 IP Office Dev 24 IP Office DevLink 5 IP Office DevLink DLL 23 IP Office SMDR 5 IP Office System 7 IP Office n connecting 8 IP Office n 8 ISDN 11 IsInternalCall 12 L Link DEVLINK LIB 6 Link 6 Lite 5 Local Dial 12 LONG DLOpen 7 LONG hEvent 8 LONG PASCAL DLClose 10 18 24 LONG PASCAL DLOpen 17 24 LONG PASCAL DLRegisterTy
4. The DLOpen routine is used to connect to an IP Office system Parameters pbxh A number used to identify the system This is a user supplied parameter that must remain consistent across all calls to DevLink pbx_address The IP address of the IP Office system either a IP address or a host name can be used This may be set to 255 255 255 255 in which case DevLink will make a network broadcast to locate the system unit Please note that only the first unit to respond will be connected to if you wish to connect to multiple system units you must specify the IP address or host name of the unit here pbx_password The password of the IP Office system reserved This parameter should be set to NULL nil in Delphi reserved2 This parameter should be set to NULL nil in Delphi cb This is the address of a call back function to which connection status events will be sent This parameter is mandatory Return value This routine may return either 0 DEVLINK SUCCESS or 1 DEVLINK UNSPECIFIEDFAIL Note that a return value of DEVLINK SUCCESS only indicates that communications with the unit has been initiated the subsequent connection may fail for several reasons Further information will be provided to the COMMSEVENT callback function specified in the cb parameter C C LONG PASCAL DLOpen LONG pbxh MSN ON gt TEXT pbx address TEXT pbx password TEXT reservedl TEXT reserved2 COMMSEVENT cb Delp
5. function DLOpen external DEVLINK DLL function DLClose external DEVLINK DLL function DLRegisterType2Call end DevLink Programmer s Guide IP Office CTI Link LongInt info PChar stdcall stdcall LongInt Deltas external DEVLINK DLL Page 23 40DHB0002UKAD Issue 11a 14th June 2005 Printed Documentation DEVLINK H This appendix contains a copy of the DEVLINK H header file used for C and C programs RRR KK RK k kk IK KK KK k kk RR k kk k kk RR 2 2 2 2 2 2 2 2 22 RK k X RK ke e ke kv FE EA C C Header File c 2001 Avaya Global SME Solutions PERES Contents IP Office Dev link DLL provides an interface for managing the IP Office product ranges from a Windows PC RRR KKK k k kk IK KKK I RK k kk k kk 2 22 2 22 2 2 2 2 2 2 2 2 22 RK 2 2 2 2 2 2 RK ke ke kv ifndef DEVLINK HO define DEVLINK H_ typedef char TEXT define DEVLINK SUCCESS 0 define DEVLINK UNSPECIFIEDFAIL 1 define DEVLINK LICENCENOTFOUND 2 define DEVLINK COMMS OPERATIONAL 0 define DEVLINK COMMS NORESPONSE 1 define DEVLINK COMMS REJECTED 2 define DEVLINK COMMS MISSEDPACKETS 3 ifdef cplusplus extern C endif typedef void CALLBACK CALLLOGEVENT LONG pbxh TEXT info typedef void CAL
6. eas ek Aad 24 i a 25 DevLink Programmer s Guide Page iii IP Office CTI Link 40DHB0002UKAD Issue 11a 14th June 2005 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 Both the Lite and Pro offerings are the same program The additional functionality provided by IP Office CTI Link Pro is enabled when the CTI Link Pro licence key is installed This manual provides a tutorial and reference to the DevLink Pro interface as well as providing example source code IP Office CTI Link Lite IP Office CTI Link Lite is a free of charge offering and contains the following component e TAPILink Lite This component implements Microsoft TAPI and allows programs to control one telephone line per PC It provides simple CTI including answer hangup make call transfer and provides CLI ANI for screen popping Please see the TAPILink Developers Guide for more details on TAPILink Lite and TAPILink Pro Note that the first version of CTI Link Lite contained DevLink Lite DevLink version 1 0 0 3 which provided a Call Logging interface This has been superseded by IP Office SMDR which is available on the IP Office 1 3 Admin CD DevLink version 1 0 0 4 no longer exports t
7. this may happen include e When a parked party hangs up e When an outgoing call is transferred e When a call is un parked The format and information contained in these events are described in more detail below Applications request information real time events by calling the DLRegisterCallDelta2 function after they have connected to the IP Office system LONG PASCAL DLRegisterType2CallDeltas HANDLE pbxh CALLLOGEVENT cb This registers a function provided by the application of type CALLLOGEVENT which will be called by DevLink whenever a real time event is generated typedef void CALLBACK CALLLOGEVENT LONG pbxh TEXT info The two parameters pbxh and info are provided to the application The pbxh parameter is the identifier that was used in the call to DLOpen and can be used to identify the system when the application is connected to multiple IP Office systems 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 Printed Documentation S events S events are sent whenever a call is first created and whenever any part of the call changes state The format of an S event is as follows CALL S lt
8. AVAYA IP Office CTI Link DevLink Programmer s Guide 40DHB0002UKAD Issue 11a 14th June 2005 Table Of Contents A eccL PEE 5 OVE IVIOW sis itte ll ERE HE b dis 5 IP Oities GTI Ek Bite ue Be aaa re E E RM eue ia va E A Es e E 5 IP OTce GTHENK PO EEUU 5 BIS 9 CIE 6 Using the Dey B deu EE 6 Using DevLink with Microsoft Visual CHF nenn 6 Using DevLink with Borland Delphi teet een 6 Connecting to an IP Office using DevLink ccccccccccccccccccccccccccncncncncnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnns 7 eue 7 Example Connecting to IP Official 8 Example Connecting to IP Office in Delphi eR 9 DISCOMME CHING seas eode aa tatu as E a Lue cu o d a ecc aplican ic iud 10 DevLink Real Time Event Stream uuuu0000000000000nnnnnnnnnnnn nun 11 DevLink Real Time Event Stream cccccccccccceccccceceeeceeccaeeeeeceaeceaeceaeceaeceaecaaeceaeenaeeeaeeaaaeeaaeaaaeeeeeseeeaes 11 SM M LR M 12 Field 25 Cause Codes toD Pe e eere to v er En 15 Di OVENS ne 16 nuugccfte 16 Devlink reference cast tect ces a 17 FUNCUONS css EE 17 DE OD ET 17 DEG Em 18 DEBRegisterType2GallDeltas 12 3 9 aiii tieu deis trente iud 19 CalIDACKS iii a anat o nas t cinco an s 20 GOMMSEVENT 1 08 gico nl ncaa Gates 20 BALLLOGEVENT ci A E el 21 APpendiceS A A A A A ob a a u a in 23 Biz NI du cc ent een er es 23 B Bel EE RA o hae oo
9. DevLink 18 19 IP Office 7 8 9 17 20 21 IP Office n 8 Connect 7 8 9 17 18 19 20 21 Connected OK 9 Connected OK n 8 Const 23 Contains DEVLINK H file 6 DEVLINK PAS file 6 Contains 6 Controls 9 Cplusplus 24 CreateEvent 8 9 CTI 5 8 19 21 CTI Link Lite 5 CTI Link Pro 5 CTI Pro installing 6 CTI Pro 6 D D 11 16 D events 16 Delphi 7 9 17 18 19 20 21 23 Delta2 returning 21 Delta2 21 DevLink calls 17 connect 18 19 DevLink 5 6 7 9 11 17 18 19 20 21 23 DevLink DLL uses 6 Using 6 DevLink DLL 6 DevLink Lite 5 DevLink Pro 5 DevLink Real Time Event Stream 11 DEVLINK DLL 6 23 DEVLINK H 6 8 24 DEVLINK H file DevLink Programmer s Guide IP Office CTI Link contains 6 DEVLINK H file 6 Devlink lib link 6 Devlink lib 6 DEVLINK PAS 6 23 DEVLINK PAS file contains 6 DEVLINK PAS file 6 23 DEVLINK COMMS MISSEDPACKETS 8 9 20 23 24 DEVLINK COMMS NORESPONSE 8 9 20 23 24 DEVLINK COMMS OPERATIONAL 8 9 20 23 24 DEVLINK COMMS REJECTED 8 9 20 23 24 DEVLINK H 24 DEVLINK LICENCE NOTFOUND 19 23 24 DEVLINK SUCCES S value 17 DEVLINK SUCCES S 17 18 19 23 24 DEVLINK UNSPECI FIEDFAIL 17 18 19 23 24 Devlinkomf lib 6 DFM 9 Dialling number 12 Dialling 12 Dialogs 9 Dialtone receiving 12 Dialtone 12 DLClose 8 9 10 18 23 DLL uses 6 DLL 6 24 DLOpen call 8 9 11 18 19 20 DLOpen 7 8 9 11 17 18 19 20 21 23 DLRegisterCallDelta
10. LBACK COMMS LONG pbxh DWORD comms state DWORD parmi LONG PASCAL DLOpen HANDLE pbxh TEXT pbx address TEXT pbx password TEXT reservedl TEXT reserved2 COMMSEVENT cb LONG PASCAL DLClose LONG pbxh LONG PASCAL DLRegisterType2CallDeltas LONG pbxh CALLLOGEVENT cb ifdef _ cplusplus y endif endif _DEVLINK H_ T VENT DevLink Programmer s Guide Page 24 IP Office CTI Link 40DHB0002UKAD Issue 11a 14th June 2005 Index A ACD 5 Achannel 12 Aconnected 12 Aname 12 Application supplied 10 Application supplied pbxh 7 Argv 8 ASCII 12 Aslot 12 Astate 12 B B number 12 State 12 B 11 12 16 B calld 12 Bchannel 12 Bconnected 12 Blist 12 Bname 12 BOOL bStarting 8 Borland Delphi 6 23 Bslot 12 BStarting 8 9 Bstate 12 Button1 9 Button1 Click 9 Button2Click 9 C C 8 17 18 19 20 21 23 24 C C 24 Call DevLink 17 DLOpen 8 9 11 18 19 20 DL RegisterCallDe Ita2 11 Call 8 9 11 12 16 17 18 19 20 Call Delta 19 Call Logging 5 CALLBACK 11 20 21 24 CALLBACK HandleCommsEvent 8 CalllD 12 16 CALLLOGEVENT 11 21 24 CALLLOGEVENT cb 11 19 24 Cb 7 17 19 23 Classes 9 CLI ANI 5 CloseHandle 8 9 COFF 6 COM 6 Comma separated 11 Comms evt 8 Comms state 20 Comms status 9 23 COMMSEVENT 7 17 20 24 COMMSEVENT cb 7 17 24 Communications Status Callback 7 Connect
11. UKAD Issue 11a 14th June 2005 Appendices DEVLINK PAS This appendix contains a copy of the DEVLINK PAS file used for Borland Delphi programs un it DEVLINK ELSE 2 5 kk 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 22 2 2 2 2 2 2 2 2 2 2 2 2 2 2 22 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 x x 2001 Avaya Global SME Solutions Delphi unit for Dev Contents IP Office DevLink D Link c L provides an interface for managing the IP Office product ranges from a Windows PC CK 5 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 22 2 2 2 2 2 2 2 2 2 2 2 2 2 2 kk kk koc kk kc kk e ke ke ke e A x interface uses Windows const DEVLINK SUCCESS 0 DEVLINK UNSPECIFIEDFAIL 1 DEVLINK LICENCENOTFOUND 2 const DEVLINK COMMS OPERATIONAL 0 DEVLINK COMMS NORESPONSE 1 DEVLINK COMMS REJECTED 2 DEVLINK COMMS MISSEDPACKETS 3 type TCallLogEvent procedure pbxh type TCommsEvent procedure pbxh LongInt Comms status DWORD Parml DWORD stdcall function DLOpen pbxh LongInt pbx address PChar pbx password PChar reservedl PChar reserved2 PChar cb TCommsEvent LongInt stdcall function DLClose pbxh THandle LongInt function DLRegisterType2CallDeltas pbxh cb TCallLogEvent LongInt stdcall implementation
12. an error e 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 Printed Documentation Callbacks COMMSEVENT The COMMSEVENT callback is called by DevLink whenever the state of the communication with the IP Office system unit changes Parameters e pbxh A number used to identify the system This is the user supplied parameter used to connect to the IP Office system unit in DLOpen e comms state A number indicating the state of the communications Valid values are Value Description Communications established This occurs either after the initial call to DLOpen or after the system unit has come back on line after being powered off or rebooted INK COMMS NORESPONSE E response from system unit This occurs either after the INK COMMS OPE initial call to DLOpen or if the system unit is powered off or rebooted It can also occur if network problems prevent communications INK COMMS REJECTE 2 Reserved for future use JINK COMMS M F Packets were generated by the IP Office system unit but ere not received by DevLink This can occur either because the IP Offic
13. colons and if there are more than four the list is terminated after 4 elements with an ellipsis Aslot is the slot number of the A side of the call and is the identify of the TDM trunk Achannel is the channel number within the Aslot The format of the string is Number Number 13 Bslot is the slot number of the B side of the call and is the identify Bchannel of the TDM trunk 4 Bchannel is the channel number within the Bslot The format of the string is Number Number 1 Called party String This field contains two numbers 1 an indicator of how the called presentation amp 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 DevLink Real Time Event Stream ype ound in the called party number field The format of the string is Number Number 5 Called party String The identifier or number of the called party number Calling party String This field contains two numbers 1 an indicator of how the presentation amp calling party details should be presented and 2 the type of data to be found in the calling party number field The format of the string is Number Number String The identifier or number of the calling party number Called sub String The sub address of the called party address String The sub address of the calling party address ialled party type Number The type of data to be found in the dia
14. cted The call was barred The call has been forwarded to voicemail The call has been answered by someone else The call has not been allowed because a valid account code has not been provided The call has been transferred The call has been placed into a conference The call was answered on an appearance button on another phone The call is no longer the primary call i e itis now a waiting call The call has been placed into a conference Page 15 40DHB0002UKAD Issue 11a 14th June 2005 Printed Documentation D events D events signify that the call is deleted The format of a D event is as follows CALL D fieldl field2 field3 The fields are Field Name Type Description 1 fAcallid Sting al id for the A end of the call 2 OB call id String Call id for the B end of the call 3 e Number Unique call id A events A events indicate that the call ends have been swapped This occurs for example when the originating extension unparks an external call The format of an A event is very similar to that for a D event CALL A lt field1 gt lt field2 gt lt field3 gt The fields are Field Name Type Description eid Sting Call id for the A end of the call P call id String al id for the B end of the call 3 CalllD Number Unique call id DevLink Programmer s Guide Page 16 IP Office CTI Link 40DHB0002UKAD Issue 11a 14th June 2005 DevLink reference Functions DLOpen
15. d or used except in accordance with applicable agreements Any comments or suggestions regarding this document should be sent to wgctechpubs avaya com 2005 Avaya Inc All rights reserved Avaya Sterling Court 15 21 Mundells Welwyn Garden City Hertfordshire AL7 1LZ England Tel 44 0 1707 392200 Fax 44 0 1707 376933 Web http www avaya com DevLink Programmer s Guide Page 28 IP Office CTI Link 40DHB0002UKAD Issue 11a 14th June 2005
16. e system unit is under heavy load or because the application using DevLink did not return from a callback quickly enough Applications should ensure hat they do not take more than 100 milliseconds to process events e parm This value is only defined for DEVLINK_COMMS_MISSEDPACKETS events in which case it indicates the number of packets dropped Return value e Noreturn value C C typedef void CALLBACK COMMSEVENT LONG pbxh DWORD comms state DWORD parml Delphi type TCommsEvent procedure pbxh LongInt comms state DWORD Parml DWORD DevLink Programmer s Guide Page 20 IP Office CTI Link 40DHB0002UKAD Issue 11a 14th June 2005 DevLink reference CALLLOGEVENT The CALLLOGEVENT callback is called by DevLink to deliver a real time Delta2 event e Note ACTI license is required for returning Delta2 events Parameters pbxh A number used to identify the system This is the user supplied parameter used to connect to the IP Office system unit in DLOpen info Text string containing the event Please see the previous section on real time events for more details Return value e Noreturn value 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 40DHB0002
17. field1 gt lt field2 gt lt field50 gt All of the information is provided in the character string Thus numbers are represented in ASCII form All numbers are integers and do not contain a decimal point Each string field has a maximum of 128 characters in length The field definitions are documented in the following table Please note that fields marked as lt reserved gt may contain information but their contents and meaning will change between releases of the IP Office core software Field Name Type Description 1 fAcallid Sting Call id for the A end of the call 2 Bcalld id String Call id for the B end of the call 3 Astate Number State of the A end of the call Valid numbers are 0 Idle 1 Ringing 2 Connected 3 Disconnected 4 Suspending 5 Suspended 6 Resuming 7 Dialling 8 Dialled 9 Local Dial 10 Queued 11 Parked 12 Held 13 Redialling 4 Bstate Number State of the B end of the call see above for values If there is no B end this will be O Idle 5 Aconnected Number 0 indicates not connected to the switch e g If receiving dialtone a E a whether the A end of the call is listening to music on hold As in field 5 above but for the B end ee VES d whether the B end of the call is listening to music on hold Name of the A end of the call The format of this string is For extensions Name Number For trunks Line number List of possible targets for the call Targets are separated by semi
18. he Call Logging interface IP Office CTI Link Pro IP Office CTI Link Pro includes all of the Lite functionality and is accessed via a licence key It contains the following components e TAPILink Pro This component provides both first party and third party TAPI control of telephony devices In addition to the functionality provided by TAPILink Lite it also adds the ability to receive information on ACD queues hunt groups and provides additional advanced functionality Please see the TAPILink Developers Guide for more details on TAPILink Lite and TAPILink Pro e DevLink Pro This component provides a real time event stream The real time event stream provides information on telephone activity as and when that activity occurs and also provides information on trunk activity DevLink Programmer s Guide Page 5 IP Office CTI Link 40DHB0002UKAD Issue 11a 14th June 2005 Printed Documentation DevLink DevLink provides a programming interface which complements the Microsoft TAPI interfaces provided by TAPILink Lite and Pro e Real time event stream The Real time event stream is enabled by installing the CTI Pro licence key onto the system unit The DevLink DLL which is included on the User CD ROM should be installed with the licence key 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 instructio
19. hi function DLOpen pbxh LongInt pbx address PChar pbx password PChar reservedl PChar reserved2 PChar cb TCommsEvent LongInt stdcall DevLink Programmer s Guide Page 17 IP Office CTI Link 40DHB0002UKAD Issue 11a 14th June 2005 Printed Documentation DLClose The DLClose routine is used to disconnect from an IP Office system Parameters e pbxh A number used to identify the system This is the user supplied parameter used to connect to DevLink in the call to DLOpen Return value e 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 DevLink reference DLRegisterType2CallDeltas The DLRegisterType2CallDeltas routine is used to request Call Delta information Parameters e pbxh A number used to identify the system This is the user supplied parameter used to connect to DevLink in the call to DLOpen e cb The address of the callback function that will receive real time events Only one callback can receive real time events at one time and if this parameter is NULL then real time events will no longer be sent to the application Return value e This routine may return e O DEVLINK SUCCESS e 1 DEVLINK_UNSPECIFIEDFAIL Returned in the event of
20. inating NULL 11 Terminating 11 TEXT 7 11 17 21 24 TForm 9 TForm1 9 TForm1 Button1Click 9 TForm1 Button2Click 9 THANDLE 9 23 The IP 17 TObject 9 Transport 12 Typedef 11 20 21 24 U Unit1 9 Unparks 16 User CD ROM 6 Uses DevLink DLL 6 DLL 6 Uses 6 Using DevLink DLL 6 Using 6 Using DevLink 6 V Value DEVLINK_SUCC ESS 17 Value 17 Var 9 Visual C 6 Voice Mail Pro 12 Voicemail 12 VoIP 11 W WaitForSingleObject 8 9 Windows Dynamic Link Library 6 Windows PC 23 24 Windows Messages 9 Windows h 8 Page 26 40DHB0002UKAD Issue 11a 14th June 2005 Printed Documentation 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 The publication of information in this document does not imply freedom from patent or other protective rights of Avaya or others Intellectual property related to this product including trademarks and registered to Lucent Technologies have been transferred or licensed to Avaya All trademarks identified by the or are registered trademarks or trademarks respectively of Avaya Inc All other trademarks are the property of their respective owners This document contains proprietary information of Avaya and is not to be disclose
21. ing to IP Office end end procedure TForml Button2Click Sender TObject begin DLClose 0 CloseHandle hEvent end end 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 DevLink Real Time Event Stream DevLink Real Time Event Stream Calls in IP Office are modelled as being a communications line between two end points called A and B respectively An A end is always present but a B end may or may not be present depending on the state of the call A and B are typically extensions or trunks but they may also be connected to the voice mail system or parked Three different types of real time events are generated by DevLink These are used to track the call throughout its lifetime e Sevents S events give information on the status of a call S events are generated when calls are first created answered or the status of a device involved in the call changes e D events D events are generated when the call is completed or abandoned They indicate that the call no longer exists e A events A events are generated when one end of a call is connected to a line such as an ISDN QSig or VolP line and the IP Office decides to swap the A end and the B end of the call Examples of when
22. lled party number field String The identifier or number of the dialled party number eypad type Number The type of data to be found in the keypad number field eypad number String The dialled digits N ing attempt countINumber The number of times this call has been presented to a target The reason the call is in it s current state See the table below for urther details oicemail disallow if the call cannot divert to voice mail ending complete if overlap dialling is complete all type amp String This field contains two numbers 1 call type e g speech video ransport type and 2 the transport type O circuit 2 packet The format of the string is Number Number The name of the hunt group where the call is currently queued name riginal hunt The name of the hunt group where the call was originally roup name targeted riginal user name String The name of the user where the call was originally targeted arget hunt group String The name of the hunt group where the call has been targeted at name Zz c 3 o 2 D O Z 2 2 O O 8 O O15 D D D z o D o Q Q n ted c ted gt o gt lt lt oo O O e 3 3 Q CD arget user name String Name of user to which the call is being targeted arget RAS name String The name of the internal port where the call is being targeted sInternalCall Number 1 the call is internal otherwise 0 CD Z ime stamp z o zZ i
23. ng time Number The time the call started ringing Q Z c 3 o 2 onnected E duration the call has been connected or was connected for uration ing duration Number The duration the call has been ringing or was ringing for ocale String Locale identifier same as the locale setting in Manager When the call is parked the B end is undefined and this field contains the park slot number DI CD tring The time the call was created internal tick count onnected time Number The time the call was connected DIT o E o o mt Z c 3 c O 0 p 2 o O CD all waiting Sting 1 if the call is a call waiting call String Contains the tag which may be applied through TAPI Voice Mail Pro or SoftConsole ransferring Number Non zero indicates that the call is being transferred ervice active Number Non zero if the service is active ervice 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 Printed Documentation Service quota time Number The service quota time Account code String The account code of the call if any CalllD None BS call id DevLink Programmer s Guide Page 14 IP Office CTI Link 40DHB0002UKAD Issue 11a 14th June 2005 Field 25 Cause Codes 0 CMCauseUnknown 1 CMCauseUnallocatedNumber 2 CMCauseForceldle 3 CMCauseUnregister 16 CMCauseNormal 17 CMCauseBusy 18 CMCauseNoUserRe
24. ns 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 directory Programs using this interface simply need to link to this library and use it s functions Notes 1 Any application that uses the DevLink DLL should include it in the application installation script As the DLL is nota COM component no registration is necessary The DLL does not require any registry settings or supporting files 2 When developing an application that uses the DLL the DevLink header file devlink h and appropriate library file devlink lib or devlinkomf lib should be copied to the same directory as the project source files The devlink lib library file contains export symbols in COFF format which can be used with projects written in Visual C The devlinkomf lib library file contains export symbols in OMF format for other linkers Using the DevLink DLL DEVLINK DLL can be used in any language that supports Dynamic Link Libraries DLLs e g Microsoft Visual C or Borland Delphi DevLink allows developers to request call backs which will be generated when significant events occur For the real time event stream this occurs at various stages throughout a call s lifetime Both telephony calls and data calls are included in the events generated Please note that all application call backs made on a thread which DevLink creates As a result considerati
25. on must be given by programmers to ensure that all functions called from within a call back are thread safe Using DevLink with Microsoft Visual C Appendix A contains the DEVLINK H file which should be used with Microsoft Visual C Programs written in Microsoft Visual C should link to the DEVLINK LIB library Using DevLink with Borland Delphi Appendix B contains the DEVLINK PAS file which should be used with Borland Delphi Programs written using Borland Delphi should use DEVLINK PAS which links directly to the DEVLINK DLL library DevLink Programmer s Guide Page 6 IP Office CTI Link 40DHB0002UKAD Issue 11a 14th June 2005 Connecting to an IP Office using DevLink Connecting DevLink supports connection to multiple IP Office systems at the same time To connect to an IP Office system the DLOpen function must be called LONG DLOpen LONG pbxh TEXT pbx address TEXT pbx password TEXT reservedl TEXT reserved2 COMMSEVENT cb The application supplied pbxh handle is used internally by DevLink to track the connected IP Office System Each connected system must have a different pbxh handle supplied by the application The pbx address field is the IP address of the IP Office system unit A value of 255 255 255 255 can be used in which case DevLink will broadcast to locate an IP Office system unit Notes 1 If DevLink is being used to control more than one IP Office system at the same time then
26. pe2Cal IDeltas 11 19 24 LONG pbxh 7 8 10 11 17 18 19 20 21 24 Longlnt 9 17 18 19 20 21 23 M Manager 12 Microsoft TAPI 5 6 Microsoft Visual C 6 More S 11 N NULL set 7 17 terminating 11 NULL 7 8 11 17 19 Number B 12 dialled 12 Number 12 Number Number 12 O OMF 6 Overview 5 P ParkslotNumber 12 Parm1 8 9 20 23 Part IP Office CTI Link Software Development Kit 5 Part 5 Pbx address 7 17 23 24 Pbx password 7 17 23 24 Pbxh 7 9 11 17 18 19 20 21 23 PC5 PChar 17 21 23 Printf 8 Prioritises 8 Pro 5 6 Program Files Avaya IP Office DEV Link 6 Q QSig 11 R R9 Real time 6 Receiving dialtone 12 Receiving 12 Redialling 12 Refer IP Office CTI Link Installation Manual 6 Refer 6 Releases IP Office 12 Releases 12 DevLink Programmer s Guide IP Office CTI Link Reserved1 7 17 23 24 Reserved 7 17 23 24 Returning Delta2 21 Returning 19 21 S S 11 12 S events 12 SDK 5 See TAPILink Developers Guide 5 See 5 Set NULL 7 17 Set 7 17 SetEvent 8 9 ShowMessage 9 Software Development Kit 5 Specify IP 17 Specify 17 State B 12 State 12 Stdcall 9 17 18 19 23 StdCtris 9 Stdio h 8 Systempassword 8 9 SysUtils 9 T TAPI 5 12 TAPILink Developers Guide see 5 TAPILink Developers Guide 5 TAPILink Lite 5 6 TAPILink Pro 5 Target RAS 12 TButton 9 TCallLogEvent 19 21 23 TCommsEvent 17 20 23 TDM identify 12 TDM 12 Term
27. sponding 21 CMCauseCallRejected 31 CMCauseNormalUnspecified 34 CMCauseNoChannel 38 CMCauseNetworkOOO 88 CMCauselncompatible 113 CMCausePhonelnfo 114 CMCauseReminderFree 115 CMCauseReminderNoAns 116 CMCauseE911Emergency 117 CMCauseParked 118 CMCauseUnParked 119 CMCausePickup 120 CMCauseReminder 121 CMCauseRedirect 122 CMCauseCallBarred 123 CMCauseForwardToVoicemail 124 CMCauseAnsweredByOther 125 CMCauseNoAccountCode 126 CMCauseTransfer 127 CMCauseConferencingMove 128 CMCauseRestrictedToPartner 129 CMCauseHeldCall 130 CMRingBackCheck 131 CMCauseAppearanceCallSteal 132 CMCauseAppearanceBridgelnto 133 CMCauseBumpedCall 134 CMCauseLineAppearanceCall 135 CMCauseUnheldCall 136 CMCauseReplaceCurrentCall 137 CMCauseGlare 138 CMCauseR21CompatConfMove DevLink Programmer s Guide IP Office CTI Link DevLink Real Time Event Stream The number is not in the dial plan Force clear down unconditionally Indicate the operation is for unregistration procedure The call target is busy The call has not been permitted e g call barring There is no available external line Problem with the external network The call has returned because it was parked against a busy extension that is now free The call has returned because it was not answered within the transfer return timeout A held or parked call is returning due to a hold park timeout The call has been redire
28. the specific IP address of the IP Office must be used 2 The cb parameter Communications Status Callback is required and must not be set to NULL The return result from DLOpen does not necessarily indicate whether or not the connection to the system unit was successful If the connection attempt succeeds then a COMMSEVENT callback will be generated indicating that connection to the system has succeeded 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 Printed Documentation Example Connecting to IP Office in C Note that the systempassword in the call to DLOpen should be replaced with your unit s actual system password include lt windows h gt include lt stdio h gt include devlink h LONG hEvent DWORD dwCommsEvent BOOL bStarting void CALLBACK HandleCommsEvent LONG pbxh DWORD comms evt DWORD parml switch comms evt case DEVLINK COMMS OPERATIONAL we are working fine fall through case DEVLINK COMMS NORESPONSE system not found initial connection or network connection lost rebooted fall through case DEVLINK COMMS REJECTED incorrect system password specified if bStarting
Download Pdf Manuals
Related Search
Avaya devlink Ipoffi..