IP Office 4.0 DevLink Programmierhandbuch

Transkript

1 IP Office 4.0 DevLink Programmierhandbuch Version 10 ( )

2

3 2006 Avaya Inc. Alle Rechte vorbehalten. Hinweis Während redliche Bemühungen gemacht wurden, um sicherzustellen, dass die Information in diesem Dokument zur Zeit der Drucklegung vollständig und akkurat war, kann Avaya Inc. keine Haftung für irgendwelche Fehler übernehmen. Änderungen und Korrekturen an der Information in diesem Dokument können in zukünftigen Versionen eingefügt werden. Haftungsausschluss für die Dokumentation Avaya Inc. übernimmt keine Haftung für Änderungen, Zusätze oder Löschungen an der ursprünglich veröffentlichten Version dieser Dokumentation, außer wenn diese von Avaya durchgeführt wurden. Haftungsausschluss für Links Avaya Inc. übernimmt keine Verantwortung für den Inhalt oder die Zuverlässigkeit von durch Links verknüpften Websites und billigt nicht unbedingt die darin beschrieben oder angebotenen Produkte, Dienste oder Informationen. Wir können nicht garantieren, dass diese Links immer funktionieren werden, und wir haben keine Kontrolle über die Verfügbarkeit der gelinkten Seiten. Lizenz MIT DER INSTALLATION UND NUTZUNG DES PRODUKTS STIMMT DER ENDBENUTZER DEN IM FOLGENDEN DARGELEGTEN VERTRAGSBEDINGUNGEN UND DEN ALLGEMEINEN LIZENZVEREINBARUNGEN AUF DER AVAYA- WEBSITE UNTER ZU ("ALLGEMEINE LIZENZVEREINBARUNG"). WENN SIE NICHT MIT DIESEN BEDINGUNGEN EINVERSTANDEN SIND, GEBEN SIE DAS PRODUKT INNERHALB VON ZEHN (10) TAGEN NACH LIEFERUNG AN DEN HÄNDLER ZURÜCK, UM EINE ERSTATTUNG ODER GUTSCHRIFT ZU ERHALTEN. Avaya gewährt dem Endbenutzer eine Lizenz im Rahmen der nachfolgend beschriebenen Lizenztypen. Die anwendbare Anzahl von Lizenzen und Kapazitätseinheiten, für die eine Lizenz gewährt wird, beläuft sich auf eine Lizenz (1), sofern in der Dokumentation oder in anderen Dokumenten, die dem Endbenutzer zur Verfügung stehen, nicht eine andere Anzahl angegeben ist. "Designierter Prozessor" ist ein einzelner Standalone-Computer. "Server" ist ein designierter Prozessor, auf dem eine Softwareanwendung ausgeführt, auf die mehrere Benutzer zugreifen können. Bei "Software" handelt es sich um Computer- Programme im Objekt-Code, die ursprünglich von Avaya lizenziert sind und von Endbenutzern als Standalone-Produkte oder vorinstalliert auf Hardware verwendet werden. Bei "Hardware" handelt es sich um die standardmäßigen Hardware-Produkte, die ursprünglich von Avaya verkauft und vom Endbenutzer verwendet werden. Lizenztypen: Lizenz für designierte Systeme (DS). Der Endbenutzer darf jede Kopie der Software jeweils auf nur einem designierten Prozessor installieren und verwenden, sofern in der Dokumentation oder in anderen Dokumenten, die dem Endbenutzer vorliegen, nicht eine andere Anzahl angegeben ist. Avaya hat Anspruch darauf, dass der (die) designierte(n) Prozessor(en) durch Typ-, Seriennummer, Funktionsschlüssel, Standort oder andere spezifische Angaben identifiziert wird (werden); Diese Informationen kann der Endbenutzer Avaya auch mithilfe von elektronischen Mitteln mitteilen, die Avaya speziell zu diesem Zweck bereitstellt. Copyright Sofern nicht explizit anders angegeben, ist das Produkt durch Urheber- und andere Eigentumsrechte geschützt. Unerlaubte Vervielfältigung, Übertragung, und/oder Nutzung kann eine kriminelle sowie zivilrechtliche Verletzung unter zutreffenden Gesetzen darstellen. Komponenten anderer Hersteller Bestimmte in dem Produkt enthaltene Softwareprogramme oder Teile davon beinhalten Software, die unter Vertragsbedingungen anderer Hersteller ("Komponenten anderer Hersteller") vertrieben wird. Diese Bedingungen können die Nutzungsrechte bestimmter Teile des Produkts einschränken oder erweitern ("Bedingungen anderer Hersteller"). Avaya-Betrugsintervention Wenn Sie meinen, dass Sie das Opfer von Gebührenhinterziehung sind und technische Hilfe oder Support benötigen, wenden Sie sich an die Betrugsinterventions-Hotline unseres technischen Servicecenters ( für USA und Kanada. Vermutete Sicherheitsrisiken bei Avaya-Produkten sollten Avaya unter folgender -Adresse mitgeteilt werden: Weitere Support-Telefonnummern finden Sie auf der Support-Website von Avaya unter

4

5 Inhaltsverzeichnis CTI DevLink... 1 Überblick... 1 IP Office CTI Link Lite... 1 IP Office CTI Link Pro... 1 DevLink... 2 Verwenden der DevLink-DLL... 2 Verwenden von DevLink mit Microsoft Visual C Verwenden von DevLink mit Borland Delphi... 2 Herstellen einer IP Office-Verbindung mit DevLink... 3 Verbinden... 3 Beispiel: Herstellen einer IP Office-Verbindung in "C"... 4 Beispiel: Herstellen einer IP Office-Verbindung in Delphi... 6 Trennen der Verbindung... 7 DevLink-Ereignisfluss in Echtzeit... 9 DevLink-Ereignisfluss in Echtzeit... 9 S-Ereignisse Ursachencodes für Feld D-Ereignisse A-Ereignisse DevLink-Referenz Funktionen DLOpen DLClose DLRegisterType2CallDeltas Rückrufe COMMSEVENT CALLLOGEVENT Anhänge DEVLINK.PAS DEVLINK.H Index DevLink Programmierhandbuch Seite iii

6

7 CTI DevLink Überblick IP Office DevLink ist Teil des IP Office CTI Link Software Development Kit. IP Office CTI Link ist verfügbar in Lite- und Pro-Versionen, die den Anwendungen zur Ausführungszeit Schnittstellen zur Verfügung stellen. Das Software Development Kit (SDK) beinhaltet eine Dokumentation der Lite- und Pro-Schnittstellen für die Softwareentwickler. Both the Lite and Pro are the same program. Die zusätzlichen Funktionen von IP Office CTI Link Pro werden aktiviert, wenn der CTI Link Pro-Lizenzschlüssel installiert ist. Dieses Handbuch dient als Lernprogramm und Referenz für die DevLink Pro-Schnittstelle und enthält darüber hinaus Beispielquellcode. IP Office CTI Link Lite IP Office CTI Link Lite ist eine kostenfreie Komponente und umfasst die folgende Komponente: TAPILinkLite Diese Komponente implementiert Microsoft TAPI und ermöglicht es Programmen, eine Telefonleitung pro PC zu kontrollieren. Bietet einfache CTI, einschließlich folgender Funktionen: Antworten, Auflegen, Anrufen, Weiterleiten und CLI/ANI für die Bildschirmanzeige. Weitere Informationen zu TAPILink Lite und TAPILink Pro finden Sie im TAPILink Entwicklerhandbuch. Hinweis The first version of CTI Link Lite contained DevLink Lite (DevLink version ) which provided a Call Logging interface. Diese Funktion wurde durch IP Office SMDR ersetzt, verfügbar auf der Admin-CD für IP Office 1.3. Die Schnittstelle zur Anrufprotokollierung wird in DevLink Version nicht mehr exportiert. IP Office CTI Link Pro IP Office CTI Link Pro bietet alle Funktionen der Lite-Version und erfordert einen Lizenzschlüssel. Es umfasst die folgenden Komponenten: TAPILinkPro Diese Komponente ermöglicht die TAPI-Kontrolle von Telefoniegeräten des Erst- als auch von Drittanwendern. Außer den Funktionen von TAPILink Lite bietet es darüber hinaus die Möglichkeit, Informationen über ACD-Warteschlagen und Sammelanschlüsse zu empfangen und verfügt über zusätzliche erweiterte Funktionen. Weitere Informationen zu TAPILink Lite und TAPILink Pro finden Sie im TAPILink Entwicklerhandbuch. DevLinkPro Diese Komponente bietet einen Echtzeit-Ereignisfluss. Der Echtzeit-Ereignisfluss liefert Informationen über Telefonaktivitäten (z.b. deren Zeitpunkt) und über Amtsleitungsaktivitäten. DevLink Programmierhandbuch Seite 1

8 DevLink Programmierhandbuch DevLink DevLink bietet eine Programmierschnittstelle, die die von TAPILink Lite und Pro bereitgestellten Microsoft TAPI-Schnittstellen ergänzt: Ereignisfluss in Echtzeit Der Ereignisfluss in Echtzeit wird durch die Installation des CTI Pro-Lizenzschlüssels auf der Geräteeinheit aktiviert. Die auf der Benutzer-CD enthaltene DevLink-DLL sollte mit dem Lizenzschlüssel installiert werden. DevLink ermöglicht Anwendungen von Drittanbietern, wie beispielsweise Aufzeichnungsgeräten, die Verwendung der über das Telefonsystem bereitgestellten Informationen. Eine Installationsanleitung finden Sie im Installationshandbuch zu IP Office CTI Link. Bei der Installation der Komponente DevLink wird standardmäßig die Windows-DLL (Dynamic Link Library) DEVLINK.DLL im Verzeichnis "Programme/Avaya/IP Office/DEV Link" installiert. Programme, die diese Schnittstelle nutzen, müssen lediglich eine Verbindung zu dieser Bibliothek herstellen und können ihre Funktionen verwenden. Hinweise Wenn eine Anwendung die DevLink-DLL verwendet, sollte die Skriptdatei für die Installation dieser Anwendung einen entsprechenden Verweis enthalten. Da es sich bei der DLL nicht um eine COM-Komponente handelt, ist keine Registrierung erforderlich. Die DLL erfordert keine Registrierungseinstellungen oder unterstützenden Dateien. Wenn Sie eine Anwendung entwickeln, die die DLL verwendet, müssen Sie die DevLink- Headerdatei (devlink.h) und die entsprechende Bibliotheksdatei (devlink.lib oder devlinkomf.lib) in das Verzeichnis mit den Projektquelldateien kopieren. Die Bibliotheksdatei Die Bibliotheksdatei Verwenden der DevLink-DLL Die DEVLINK.DLL kann mit allen Sprachen verwendet werden, die dynamische Verbindungsbibliotheken (Dynamic Link Libraries, DLLs) unterstützen, beispielsweise Microsoft Visual C++ oder Borland Delphi. DevLink ermöglicht Entwicklern das Anfordern von Rückrufen, die bei wichtigen Ereignissen generiert werden. Beim Ereignisstrom in Echtzeit kommt dies während der Lebensdauer eines Anrufs mehrfach vor. Die generierten Ereignisse umfassen sowohl Telefonanrufe als auch Datenübertragungen. Beachten Sie, dass alle Anwendungs-Rückrufe auf einem von DevLink erstellten Thread basieren. Aus diesem Grund müssen Entwickler darauf achten, dass alle innerhalb eines Rückrufs aufgerufenen Funktionen threadsicher sind. Verwenden von DevLink mit Microsoft Visual C++ Anhang A enthält die Datei DEVLINK.H für die Verwendung mit Microsoft Visual C++. In Microsoft Visual C++ geschriebene Programme sollten mit der Bibliothek DEVLINK.LIB verbunden werden. Verwenden von DevLink mit Borland Delphi Anhang B enthält die Datei DEVLINK.PAS für die Verwendung mit Borland Delphi. Mit Borland Delphi geschriebene Programme sollten DEVLINK.PAS verwenden, die direkt mit der Bibliothek DEVLINK.DLL verknüpft ist. Seite 2 DevLink Programmierhandbuch

9 Herstellen einer IP Office-Verbindung mit DevLink Verbinden DevLink unterstützt die gleichzeitige Verbindung zu mehreren IP Office-Systemen. Zum Herstellen einer Verbindung zu einem IP Office-System muss die Funktion DLOpen() aufgerufen werden: LONG DLOpen( LONG pbxh, TEXT *pbx_address, TEXT *pbx_password, TEXT *reserved1, TEXT *reserved2, COMMSEVENT cb); Das im Lieferumfang der Anwendung enthaltene Handle pbxh wird intern von DevLink zur Verfolgung des verbundenen IP Office-Systems verwendet. Für jedes verbundene System muss durch die Anwendung ein anderes pbxh-handle bereitgestellt werden. Im Feld Wenn der Wert Hinweise Wenn DevLink zur gleichzeitigen Steuerung mehrerer IP Office-Systeme verwendet wird, muss die spezifische IP-Adresse der IP Office-Geräteeinheit verwendet werden. Der Parameter Aus dem von Wenn der Verbindungsversuch erfolgreich ist, wird ein COMMSEVENT-Rückruf generiert, der angibt, dass die Verbindung zum System erfolgreich hergestellt werden konnte. Der Parameter Die Parameter reserved2 DevLink Programmierhandbuch Seite 3

10 DevLink Programmierhandbuch Beispiel: Herstellen einer IP Office-Verbindung in "C" Beachten Sie, dass Sie DLOpen() #include <windows.h> #include <stdio.h> #include "devlink.h" LONG hevent; DWORD dwcommsevent; BOOL bstarting; void CALLBACK HandleCommsEvent( LONG pbxh, DWORD comms_evt, DWORD parm1 ) { 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 ) { 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. // (parm1 contains the number of packets missed) Seite 4 DevLink Programmierhandbuch

11 Herstellen einer IP Office-Verbindung mit DevLink break; } } int main(int argc, char* argv[]) { printf( "connecting..."); bstarting = TRUE; hevent = CreateEvent( NULL, FALSE, FALSE, NULL ); DLOpen( 0, " " "systempassword", NULL, NULL, HandleCommsEvent ); dwcommsevent = DEVLINK_COMMS_NORESPONSE; WaitForSingleObject( hevent, ); // 10 seconds bstarting = 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 Programmierhandbuch Seite 5

12 DevLink Programmierhandbuch Beispiel: Herstellen einer IP Office-Verbindung in Delphi Beachten Sie, dass Sie DLOpen() unit Unit1; interface uses Windows, Messages, SysUtils, Classes, Graphics, Controls, Forms, Dialogs, StdCtrls; Typ TForm1 = class(tform) Button1: TButton; procedure Button1Click(Sender: TObject); procedure Button2Click(Sender: TObject); private { Private declarations } public { Public declarations } end; var Form1: TForm1; Implememtierung uses devlink; {$R *.DFM} var hevent : THANDLE; dwcommsevent : DWORD; bstarting: boolean; procedure HandleCommsEvent( pbxh : LongInt; Comms_status : DWORD; Parm1 : 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: Seite 6 DevLink Programmierhandbuch

13 Herstellen einer IP Office-Verbindung mit DevLink begin // parm1 indicates the number of packets missed... end; end; end; procedure TForm1.Button1Click(Sender: TObject); begin bstarting := TRUE; hevent := CreateEvent( nil, FALSE, FALSE, nil ); DLOpen( 0, ' ', 'systempassword', nil, nil, - HandleCommsEvent ); dwcommsevent := DEVLINK_COMMS_NORESPONSE; WaitForSingleObject( hevent, ); // 10-second timeout bstarting := FALSE; if dwcommsevent = DEVLINK_COMMS_OPERATIONAL then begin ShowMessage('Connected OK'); end else begin ShowMessage('Error connecting to IP Office'); end; end; procedure TForm1.Button2Click(Sender: TObject); begin DLClose( 0 ); CloseHandle( hevent ); end; end. Trennen der Verbindung Verwenden Sie zum Trennen der IP Office-Verbindung die Routine LONG PASCAL DLClose( LONG pbxh ); DevLink Programmierhandbuch Seite 7

14

15 DevLink-Ereignisfluss in Echtzeit DevLink-Ereignisfluss in Echtzeit Anrufe werden in IP Office als Kommunikationsverbindungen zwischen den beiden Endpunkten A und B dargestellt. Punkt A ist immer vorhanden; das Vorhandensein von Punkt B ist vom Status des Anrufs abhängig (A und B sind in der Regel Nebenstellen oder Amtsleitungen, aber sie können auch mit Voic -Systemen verbunden oder geparkt sein). Durch DevLink werden drei verschiedene Arten von Echtzeit-Ereignissen erstellt. Diese dienen zur Aufzeichnung von Anrufinformationen. S-Ereignisse Ereignisse vom Typ S enthalten Informationen zum Status eines Anrufs. S-Ereignisse werden erstellt, wenn ein Anruf getätigt bzw. beantwortet wird oder wenn sich der Status eines am Anruf beteiligten Geräts ändert. D-Ereignisse Ereignisse vom Typ D werden erstellt, wenn ein Anruf beendet oder abgebrochen wird. Sie weisen darauf hin, dass der Anruf nicht mehr existiert. A-Ereignisse Ereignisse vom Typ A werden erstellt, wenn ein Endpunkt eines Anrufs mit einer Leitung verbunden wird (z.b. ISDN, QSig oder VoIP) und wenn IP Office die Endpunkte A und B des Anrufs vertauscht. Dies kann in den folgenden Fällen passieren: Wenn ein geparkter Teilnehmer auflegt Wenn ein ausgehender Anruf vermittelt wird Wenn ein Anruf entparkt wird Das Format und die in diesen Ereignissen enthaltenen Informationen werden weiter unten im Detail beschrieben. Echtzeit-Ereignisse werden von Anwendungen über die Funktion LONG PASCAL DLRegisterType2CallDeltas( HANDLE pbxh, CALLLOGEVENT cb ); Hiermit wird eine von der Anwendung bereitgestellte Funktion vom Typ CALLLOGEVENT registriert, die von DevLink aufgerufen wird, sobald ein Echtzeit-Ereignis generiert wird. typedef void (CALLBACK * CALLLOGEVENT)( LONG pbxh, TEXT * info ); Die beiden Parameter (info Der Parameter DLOpen() Beim zweiten Parameter handelt es sich um eine Zeichenfolge, die den Anruf-Datensatz enthält. Hierbei handelt es sich um eine Zeichenfolge mit Kommas als Trennzeichen und Feldern variabler Breite. Die Zeichenfolge ist (einschließlich des NULL-Zeichens) immer unter 1500 Byte lang. DevLink Programmierhandbuch Seite 9

16 DevLink Programmierhandbuch S-Ereignisse Ereignisse des Typs S werden gesendet, sobald ein Anruf erstellt wird und wenn sich der Status einer Komponente des Anrufs ändert. S-Ereignisse weisen das folgende Format auf: ANRUF: S <Feld1>,<Feld2>, <Feld50> Alle Informationen befinden sich in der Zeichenfolge. Zahlen werden daher im ASCII-Format dargestellt. Alle Zahlen sind Ganzzahlen ohne Dezimalstelle. Die maximale Länge der einzelnen Zeichenfolgen- Felder liegt bei 128 Zeichen. Die Felddefinitionen sind in der folgenden Tabelle dokumentiert. Als Feld Name Typ Beschreibung 1 Anruf-ID A Zeichenfolge Anruf-ID für das Ende A des Anrufs 2 Anruf-ID B Zeichenfolge Anruf-ID für das Ende B des Anrufs 3 A-Status Nummer Status des Endpunkts A des Anrufs. Es werden folgende Werte unterschieden: 0 Ruhend 1 Klingeln 2 Verbunden 3 Getrennt 4 Wird ausgesetzt 5 Ausgesetzt 6 Zurück 7 Wählen 8 Gewählt 9 Lokales Wählen 10 In Warteschlange 11 Geparkt 12 Gehalten 13 Wahlwiederholung 4 B-Status Nummer Status des Endpunkts B des Anrufs (Werte wie oben). Falls kein Endpunkt B vorhanden ist, wird 0 (Ruhend) angezeigt. 5 Verbindung A Nummer 0 bedeutet, dass keine Verbindung zur Vermittlung besteht (z.b. beim Empfang eines Wähltons). 6 Musik A Nummer Gibt an, ob der Endpunkt A des Anrufs Wartemusik hört. 7 Verbindung B Nummer Wie in Feld 5 oben, nur für Endpunkt B. 8 Musik B Nummer Gibt an, ob der Endpunkt B des Anrufs Wartemusik hört. 9 Name A Zeichenfolge Name des Endpunkts A des Anrufs. Das Format dieser Zeichenfolge lautet: Für Nebenstellen: Name (Nummer) Für Amtsleitungen: Leitungsnummer 10 Name B Zeichenfolge Wie in Feld 9 oben. Falls kein Endpunkt B vorhanden ist, ist dieses Feld leer. Seite 10 DevLink Programmierhandbuch

17 DevLink-Ereignisfluss in Echtzeit 11 Liste B Zeichenfolge Liste möglicher Ziele für den Anruf Die einzelnen Zielnummern sind durch Semikolon voneinander abgetrennt. Es werden maximal 4 Elemente angezeigt; falls mehr Elemente vorhanden sind, ist dies durch Auslassungspunkte kenntlich gemacht. 12 Bereich A Kanal A 13 Bereich B Kanal B 14 Anzeige und Typ des angerufenen Teilnehmers 15 Nummer des angerufenen Teilnehmers 16 Anzeige und Typ des anrufenden Teilnehmers 17 Nummer des anrufenden Teilnehmers 18 Angerufene Sub- Adresse 19 Anrufende Sub- Adresse Zeichenfolge Der Bereich A ist die Bereichsnummer der Seite A des Anrufs, d.h. die ID der TDM-Leitung. Kanal A ist die Kanalnummer innerhalb des Bereichs. Das Format dieser Zeichenfolge lautet Zeichenfolge Der Bereich B ist die Bereichsnummer der Seite B des Anrufs, d.h. die ID der TDM-Leitung. Kanal B ist die Kanalnummer innerhalb des Bereichs. Das Format dieser Zeichenfolge lautet Zeichenfolge Dieses Feld enthält zwei Zahlen: 1) einen Hinweis zu Präsentation der Details des angerufenen Teilnehmers und 2) die Art der im Nummernfeld für den angerufenen Teilnehmer verwendeten Daten. Das Format dieser Zeichenfolge lautet Zeichenfolge Die ID bzw. Nummer des angerufenen Teilnehmers. Zeichenfolge Dieses Feld enthält zwei Zahlen: 1) einen Hinweis zu Präsentation der Details des Anrufers und 2) die Art der im Nummernfeld für den Anrufer verwendeten Daten. Das Format dieser Zeichenfolge lautet Zeichenfolge Die ID bzw. Nummer des Anrufers. Zeichenfolge Die Sub-Adresse des angerufenen Teilnehmers. Zeichenfolge Die Sub-Adresse des Anrufers. 20 Angerufener Teilnehmertyp Nummer Der Datentyp im Feld für den angerufenen Teilnehmer. 21 Gewählte Teilnehmernummer Zeichenfolge Die ID bzw. Nummer des angerufenen Teilnehmers. 22 Tastenblocktyp Nummer Der Datentyp im Feld für die Tastenblocknummer. 23 Tastenblocknummer Zeichenfolge Die gewählten Ziffern. 24 Anzahl der Klingelversuche Nummer Die Anzahl der Versuche, diesen Anruf einer Zielnummer zu präsentieren. 25 Ursache Nummer Der Grund für den aktuellen Status des Anrufs. Nähere Einzelheiten finden Sie in der Tabelle unten. 26 Voic verweigert Nummer 1, wenn der Anruf nicht an die Voic umgeleitet werden kann. 27 Senden abgeschlossen Nummer 1, wenn überlappendes Wählen abgeschlossen wurde. 28 Anruf- und Übertragungstyp 29 Gruppenname des Besitzers Zeichenfolge Dieses Feld enthält zwei Zahlen: 1) den Anruftyp (z.b. Video Das Format dieser Zeichenfolge lautet Zeichenfolge Der Name des Sammelanschlusses, an dem sich der Anruf zurzeit in der Warteschlange befindet. DevLink Programmierhandbuch Seite 11

18 DevLink Programmierhandbuch 30 Ursprünglicher Gruppenname 31 Urspünglicher Benutzername Zeichenfolge Der Name des Sammelanschlusses, an den der Anruf ursprünglich gerichtet war. Zeichenfolge Der Name des Benutzers, an den der Anruf ursprünglich gerichtet war. 32 Zielgruppenname Zeichenfolge Der Name des Sammelanschlusses, an den der Anruf gerichtet wurde. 33 Zielbenutzername Zeichenfolge Der Name des Benutzers, an den der Anruf gerichtet ist. 34 Ziel-RAS-Name Zeichenfolge Der Name des internen Ports, an den der Anruf gerichtet ist. 35 Interner Anruf Nummer 1, wenn der Anruf intern ist, ansonsten Zeitmarkierung Zeichenfolge Der Zeitpunkt, zu dem der Anruf erstellt wurde (interner Tick-Zähler). 37 Verbindungszeit Nummer Die Uhrzeit, zu der eine Verbindung für den Anruf hergestellt wurde. 38 Wartezeit Nummer Die Uhrzeit, zu der der angerufene Apparat zu klingeln begann. 39 Verbindungsdauer Nummer Die Dauer der Verbindung für den Anruf. 40 Klingeldauer Nummer Die Dauer des Klingelns für diesen Anruf. 41 Länderkennung Zeichenfolge Länderkennungs-ID (identisch mit der Länderkennungseinstellung in Manager). 42 Parkbereichsnummer Zeichenfolge Für geparkte Anrufe ist Endpunkt B nicht definiert. Dieses Feld enthält die Nummer des Parkbereichs. 43 Anklopfen Zeichenfolge 1, wenn es sich um einen anklopfenden Anruf handelt 44 Bemerkung Zeichenfolge Enthält die Bemerkung, die über TAPI, Voice Mail/Pro oder SoftConsole angewendet werden kann. 45 Vermittlung Nummer Wenn hier ein anderer Wert als 0 angegeben ist, wird der Anruf vermittelt. 46 Dienst aktiv Nummer Ein Wert ungleich 0 bedeutet, dass der Dienst aktiv ist. 47 Verwendete Dienstquoten Nummer Ein Wert ungleich 0 bedeutet, dass die Dienstquote verwendet wird. 48 Dienstquotenzeit Nummer Die Dienstquotenzeit. 49 Verrechnungscode Zeichenfolge Der Verrechnungscode des Anrufs (falls verfügbar). 50 AnrufID Nummer Eindeutige Anruf-ID Seite 12 DevLink Programmierhandbuch

19 DevLink-Ereignisfluss in Echtzeit Ursachencodes für Feld 25 0 CMCauseUnknown 1 CMCauseUnallocatedNumber Die Nummer steht nicht in der Telefonübersicht. 2 CMCauseForceIdle Beenden ohne Bedingung erzwingen 3 CMCauseUnregister Gibt an, dass der Vorgang für die Deregistrierung erforderlich ist. 16 CMCauseNormal 17 CMCauseBusy Die angerufene Nummer ist besetzt 18 CMCauseNoUserResponding 21 CMCauseCallRejected Der Anruf wurde nicht durchgestellt (z.b. aufgrund einer Anrufsperre) 31 CMCauseNormalUnspecified 34 CMCauseNoChannel Es ist keine externe Leitung verfügbar 38 CMCauseNetworkOOO Es gibt ein Problem mit dem externen Netz 88 CMCauseIncompatible 113 CMCausePhoneInfo 114 CMCauseReminderFree Der Anruf wurde zurückgestellt, weil er an einer Nebenstelle geparkt wurde, die besetzt war, aber jetzt frei ist 115 CMCauseReminderNoAns Der Anruf wurde zurückgestellt, weil er nicht innerhalb der Weiterleitungs-Rückschaltzeit beantwortet wurde 116 CMCauseE911Emergency 117 CMCauseParked 118 CMCauseUnParked 119 CMCausePickup 120 CMCauseReminder Ein gehaltener oder geparkter Anruf wird aufgrund einer Zeitüberschreitung zurückgestellt 121 CMCauseRedirect Der Anruf wurde umgeleitet 122 CMCauseCallBarred Der Anruf wurde blockiert 123 CMCauseForwardToVoic Der Anruf wurde an die Voic weitergeleitet 124 CMCauseAnsweredByOther Der Anruf wurde von jemand anderem entgegengenommen 125 CMCauseNoAccountCode Der Anruf war nicht zulässig, weil kein gültiger Verrechnungscode angegeben wurde 126 CMCauseTransfer Der Anruf wurde vermittelt 127 CMCauseConferencingMove Der Anruf wurde in eine Konferenz geschaltet 128 CMCauseRestrictedToPartner 129 CMCauseHeldCall DevLink Programmierhandbuch Seite 13

20 DevLink Programmierhandbuch 130 CMRingBackCheck 131 CMCauseAppearanceCallSteal Der Anruf wurde an einer Anrufpräsentationstaste an einem anderen Apparat beantwortet 132 CMCauseAppearanceBridgeInto 133 CMCauseBumpedCall Der Anruf ist nicht mehr der primäre Anruf, sondern ein wartender Anruf 134 CMCauseLineAppearanceCall 135 CMCauseUnheldCall 136 CMCauseReplaceCurrentCall 137 CMCauseGlare 138 CMCauseR21CompatConfMove Der Anruf wurde in eine Konferenz geschaltet D-Ereignisse Ereignisse vom Typ D weisen darauf hin, dass der Anruf gelöscht wurde. D-Ereignisse weisen das folgende Format auf: ANRUF: D <Feld1>,<Feld2>, <Feld3> Hierbei handelt es sich um folgende Felder: Feld Name Typ Beschreibung 1 Anruf-ID A Zeichenfolge Anruf-ID für das Ende A des Anrufs 2 Anruf-ID B Zeichenfolge Anruf-ID für das Ende B des Anrufs 3 AnrufID Nummer Eindeutige Anruf-ID A-Ereignisse Ereignisse vom Typ A weisen darauf hin, dass die Anruf-Endpunkte vertauscht wurden. Dies kommt z.b. vor, wenn die ursprüngliche Nebenstelle einen externen Anruf entparkt. Das Format eines A-Ereignisses ist mit dem eines D-Ereignisses vergleichbar: ANRUF: A <Feld1>,<Feld2>, <Feld3> Hierbei handelt es sich um folgende Felder: Feld Name Typ Beschreibung 1 Anruf-ID A Zeichenfolge Anruf-ID für das Ende A des Anrufs 2 Anruf-ID B Zeichenfolge Anruf-ID für das Ende B des Anrufs 3 AnrufID Nummer Eindeutige Anruf-ID Seite 14 DevLink Programmierhandbuch

21 DevLink-Referenz Funktionen DLOpen Die Routine DLOpen() dient zum Herstellen einer Verbindung mit einem IP Office-System. Parameter pbxh - Eine Nummer zur Identifizierung des Systems. Hierbei handelt es sich um einen vom Benutzer angegebenen Parameter, der für alle Anrufe an DevLink gleich bleiben muss. pbx_address - Die IP-Adresse des IP Office-Systems (es kann eine IP-Adresse oder ein Hostname verwendet werden). Wenn dieser Wert auf gesetzt wird, sendet DevLink eine Broadcast-Anforderung zur Ermittlung der Geräteeinheit. Beachten Sie, dass in diesem Fall lediglich eine Verbindung zur ersten Einheit hergestellt wird, die antwortet. Wenn Sie eine Verbindung zu mehreren Geräteeinheiten herstellen möchten, müssen Sie hier die IP- Adresse bzw. den Hostnamen einer Einheit angeben. pbx_password - Das Kennwort des IP Office-Systems. reserved1 - Dieser Parameter muss auf NULL (nil in Delphi) gesetzt werden. reserved2 - Dieser Parameter muss auf NULL (nil in Delphi) gesetzt werden. cb - Hierbei handelt es sich um die Adresse einer Rückruffunktion, an die Verbindungsstatusereignisse gesendet werden. Dieser Parameter ist obligatorisch. Rückgabewert 0 (DEVLINK_SUCCESS) oder 1 (DEVLINK_UNSPECIFIEDFAIL). Hinweis: Der Rückgabewert DEVLINK_SUCCESS gibt lediglich an, dass die Kommunikation mit der Einheit initiiert wurde, die Verbindung kann zu einem späteren Zeitpunkt aus verschiedenen Gründen fehlschlagen. Die Rückruffunktion COMMSEVENT im Parameter C/C++ LONG PASCAL DLOpen( LONG pbxh, TEXT * pbx_address, TEXT * pbx_password, 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 Programmierhandbuch Seite 15

22 DevLink Programmierhandbuch DLClose Die Routine DLClose() dient zum Trennen der Verbindung mit einem IP Office-System. Parameter pbxh - Eine Nummer zur Identifizierung des Systems. Hierbei handelt es sich um den vom Benutzer angegebenen Parameter, der im Aufruf an DLOpen() zur Herstellung einer Verbindung mit DevLink verwendet wird. Rückgabewert 0 (DEVLINK_SUCCESS) oder, falls ein Fehler auftritt, 1 (DEVLINK_UNSPECIFIEDFAIL). C/C++ LONG PASCAL DLClose( LONG pbxh ); Delphi function DLClose(pbxh: LongInt): LongInt; stdcall; DLRegisterType2CallDeltas Die Routine Parameter pbxh - Eine Nummer zur Identifizierung des Systems. Hierbei handelt es sich um den vom Benutzer angegebenen Parameter, der im Aufruf an DLOpen() zur Herstellung einer Verbindung mit DevLink verwendet wird. cb - Die Adresse der Rückruffunktion zum Empfang von Ereignissen in Echtzeit. Es kann immer nur ein Rückruf Echtzeit-Ereignisse empfangen, so dass keine Echtzeit-Ereignisse an die Anwendung gesendet werden, wenn dieser Parameter auf NULL gesetzt ist. Rückgabewert Mögliche Werte: 0 = DEVLINK_SUCCESS 1 = DEVLINK_UNSPECIFIEDFAIL - Dieser Wert wird zurückgegeben, wenn ein Fehler auftritt. 2 = DEVLINK_LICENCENOTFOUND - Dieser Wert wird zurückgegeben, wenn im IP Office-System keine CTI-Lizenz aktiviert ist. C/C++ LONG PASCAL DLRegisterType2CallDeltas( LONG pbxh, CALLLOGEVENT cb ); Delphi function DLRegisterType2CallDeltas(pbxh: LongInt; cb: TCallLogEvent): LongInt; stdcall; Seite 16 DevLink Programmierhandbuch

23 Rückrufe DevLink-Referenz COMMSEVENT Der Rückruf COMMSEVENT wird von DevLink aufgerufen, wenn sich der Status der Kommunikation mit der IP Office-Geräteeinheit ändert. Parameter pbxh - Eine Nummer zur Identifizierung des Systems. Hierbei handelt es sich um den vom Benutzer angegebenen Parameter, der in DLOpen() zur Herstellung einer Verbindung mit der IP Office-Geräteeinheit verwendet wird. comms_state - Eine Zahl, die den Status der Kommunikation angibt. Gültige Werte: Name Wert Beschreibung DEVLINK_COMMS_OPERATIONAL 0 Kommunikation hergestellt. Diese Situation kann nach dem ersten Aufruf von DEVLINK_COMMS_NORESPONSE 1 Keine Antwort von Geräteeinheit. Diese Situation kann nach dem ersten Aufruf von Es ist auch möglich, dass diese Situation eintritt, wenn die Kommunikation durch Netzwerkprobleme verhindert wird. DEVLINK_COMMS_REJECTED 2 Zur späteren Verwendung DEVLINK_COMMS_MISSEDPACKETS 3 Es wurden Pakete von der IP Office-Geräteeinheit generiert, jedoch nicht von DevLink empfangen. Diese Situation kann eintreten, wenn die IP Office-Geräteeinheit überlastet ist, oder wenn die Anwendung, die DevLink verwendet, den Rückruf nicht schnell genug verarbeitet. Anwendungen sollten für die Verarbeitung von Ereignissen nicht mehr als 100 Millisekunden benötigen. parm1 - Dieser Wert ist nur für folgende Ereignisse definiert: Ereignisse vom Typ DEVLINK_COMMS_MISSEDPACKETS. In diesem Fall gibt er die Anzahl der verworfenen Pakete an. Rückgabewert Es wird kein Wert zurückgegeben. DevLink Programmierhandbuch Seite 17

24 DevLink Programmierhandbuch C/C++ typedef void (CALLBACK * COMMSEVENT)( LONG pbxh, DWORD comms_state, DWORD parm1 ); Delphi Typ TCommsEvent = procedure( pbxh : LongInt; comms_state : DWORD; Parm1 : DWORD ); CALLLOGEVENT Der Rückruf CALLLOGEVENT wird von DevLink zur Bereitstellung eines Ereignisses in Echtzeit (Delta2) aufgerufen. Hinweis Für die Rückgabe von Delta2-Ereignissen ist eine CTI-Lizenz erforderlich. Parameter pbxh - Eine Nummer zur Identifizierung des Systems. Hierbei handelt es sich um den vom Benutzer angegebenen Parameter, der in info - Eine Textzeichenfolge, die das Ereignis enthält. Nähere Informationen hierzu finden Sie im vorigen Abschnitt zu Echtzeit-Ereignissen. Rückgabewert Es wird kein Wert zurückgegeben. C/C++ typedef void (CALLBACK * CALLLOGEVENT)( Long pbxh, TEXT * info ); Delphi Typ TCallLogEvent = procedure( pbxh : LongInt; info : PChar ); Seite 18 DevLink Programmierhandbuch

25 Anhänge DEVLINK.PAS Dieser Anhang enthält eine Kopie der Datei DEVLINK.PAS, die für Borland Delphi-Programme verwendet wird. unit DEVLINK; {**************************************************************************} { Delphi unit for DevLink (c) 2001 Avaya Global SME Solutions } { Contents:- } { IP Office DevLink DLL provides an interface for managing } { the IP Office product ranges from a Windows PC } {**************************************************************************} 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; Typ TCallLogEvent = procedure( pbxh : LongInt; info : PChar ); stdcall; Typ TCommsEvent = procedure( pbxh : LongInt; Comms_status : DWORD; Parm1 : DWORD ); stdcall; function DLOpen(pbxh: LongInt; pbx_address: PChar; pbx_password: PChar; reserved1: PChar; reserved2: PChar; DevLink Programmierhandbuch Seite 19

26 DevLink Programmierhandbuch cb: TCommsEvent): LongInt; stdcall; function DLClose(pbxh: THandle): LongInt; stdcall; function DLRegisterType2CallDeltas(pbxh: LongInt; cb: TCallLogEvent): LongInt; stdcall; Implememtierung function DLOpen; external 'DEVLINK.DLL'; function DLClose; external 'DEVLINK.DLL'; function DLRegisterType2CallDeltas; external 'DEVLINK.DLL'; end. DEVLINK.H Dieser Anhang enthält eine Kopie der Headerdatei DEVLINK.H, die für Programme mit C und C++ verwendet wird. /********************************************************************/ /* */ /* 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. */ /********************************************************************/ #ifndef _DEVLINK_H_ #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 Seite 20 DevLink Programmierhandbuch

27 Anhänge extern "C" { #endif typedef void (CALLBACK * CALLLOGEVENT)( LONG pbxh, TEXT * info ); typedef void (CALLBACK * COMMSEVENT)( LONG pbxh, DWORD comms_state, DWORD parm1 ); LONG PASCAL DLOpen( HANDLE pbxh, TEXT * pbx_address, TEXT * pbx_password, TEXT * reserved1, TEXT * reserved2, COMMSEVENT cb ); LONG PASCAL DLClose( LONG pbxh ); LONG PASCAL DLRegisterType2CallDeltas( LONG pbxh, CALLLOGEVENT cb ); #ifdef cplusplus }; #endif #endif // _DEVLINK_H_ DevLink Programmierhandbuch Seite 21

28

29 Index A A-Ereignisse 9, 14 B Beispiele 4, 6 C call log event 18 commsevent 17 CTI lite 1 pro 1 D D-Ereignisse 9, 14 DevLink 2.h 20.pas 19 DLL 2 real-time event stream 9 DevLink 2 dlclose 16 dlopen 15 dlregistertype2calldeltas 16 S S-Ereignisse 9, 10 T Trennen der Verbindung 7 V Verbinden 3 DevLink Programmierhandbuch Seite 23

30 Die Leistungsdaten und Angaben in diesem Dokument sind typisch und müssen ausdrücklich schriftlich von Avaya bestätigt werden, bevor sie auf eine Bestellung oder einen Auftrag angewendet werden dürfen. Änderungen und Ergänzungen an den ausführlichen Spezifikationen vorbehalten. Die Veröffentlichung der Informationen in diesem Dokument entbindet den Leser nicht von den Patentrechten oder anderen Schutzrechten der Firma Avaya oder anderer Firmen. Das geistige Eigentum an diesem Produkt (einschließlich Marken), das für Lucent Technologies eingetragen wurde, ist an Avaya weitergegeben oder lizenziert. Alle durch oder gekennzeichneten Marken sind Marken bzw. eingetragene Marken von Avaya Inc. Alle anderen Marken sind das Eigentum ihrer jeweiligen Inhaber. Dieses Dokument enthält firmeneigene Informationen von Avaya, die nur vertragsgemäß weitergegeben und verwendet werden dürfen. Anmerkungen oder Vorschläge bezüglich dieses Dokuments können an gesendet werden Avaya Inc. Alle Rechte vorbehalten. Avaya Unit 1, Sterling Court Mundells Welwyn Garden City Hertfordshire AL7 1LZ England Tel: +44 (0) Fax: +44 (0) Seite 26 DevLink Programmierhandbuch