Share via

  • Artikel

Entwicklerreferenz

Letztes Änderungsdatum des Themas: 2009-05-14

Die Office Communications-Gruppe stellt die folgenden SDKs und API-Sätze bereit:

  • Office Communications Server 2007 R2-Server-SDK
  • Unified Communications Managed API 2.0 Core-SDK
  • Unified Communications Managed API 2.0-Sprach-SDK
  • Unified Communications Managed API 2.0 Windows Workflow Activities
  • Office Communicator 2007-Automatisierungs-API-SDK
  • Unified Communications Client 1.0-SDK
  • Unified Communications-AJAX 2007-SDK
  • Office Live Meeting-Dienst-API
  • Office Live Meeting-Dienstportal-API

In den folgenden Abschnitten finden Sie eine Übersicht über die SDKs und API-Sätze. Links zur MSDN-Dokumentation zu den SDKs und API-Sätzen finden Sie im Abschnitt Siehe auch am Ende dieses Themas.

Office Communications Server 2007 R2-Server-SDK

Das Microsoft () enthält zwei API-Sätze:

  • -Anwendungs-API
  • -Verwaltungs-API

Communications Server-Anwendungs-API

Entwickler können mit der -Anwendungs-API Anwendungen erstellen, die die SIP-Basisfunktionalität von erweitern und verbessern. Diese API-Sätze eignen sich für Entwickler, die individuelle Verhaltensweisen für implementieren möchten und dazu beispielsweise benutzerdefinierte Nachrichtenfilter- und Routinganwendungen, Transaktionsmodelle mit mehreren Threads und sichere Anmeldefunktionalität entwickeln. Diese APIs können SIP-Nachrichten überwachen und ändern, wenn diese durchlaufen. Mit ihnen können keine SIP-Nachrichten vom Server erstellt werden. Sie können keine Anwendungen schreiben, die Sofortnachrichten mit diesen APIs erstellen.

Die -Anwendungs-API bietet verschiedene Tools zur Implementierung benutzerdefinierter SIP-Nachrichtenfilter sowie zum Senden von Nachrichten an Anwendungen, die bei Office Communications Server registriert sind. Die drei wichtigsten Tools sind:

  • Das Anwendungsmanifest. Es definiert die grundlegenden Nachrichtenfilterungseinstellungen und Proxyverhalten.
  • MSPL (Microsoft SIP Processing Language). Dieses Tool ermöglicht eine genauere Steuerung des Filter- und Proxyverhaltens und bietet eine Funktion zum Weiterleiten bestimmter Nachrichten an transaktionsbasierte SIP-Anwendungen.
  • Der Microsoft.Rtc.Sip-Namespace. Mit diesem Tool können Anwendungen auf Ressourcen außerhalb von zugreifen und gleichzeitig Routing- und Filteraufgaben ausführen.

Mit MSPL können Anwendungen erstellt werden, die Routing- und Filterfunktionen bereitstellen und dazu lediglich die Ressourcen (z. B. Anwesenheit) von verwenden. Es ist möglich, eine Anwendung zum Blockieren aller Sofortnachrichten mit HTTP-Verweisen ausschließlich im MSPL zu schreiben.

Anwendungen, die Ressourcen außerhalb von benötigen (beispielsweise Domäneninformationen oder einen Datenbankzugriff), müssen dazu über den MSPL-Code SIP-Nachrichten zu einem separaten Prozess senden, der den Microsoft.Rtc.Sip-Namespace verwendet. Eine Anwendung, die Sofortnachrichten mit HTTP-Verweisen zu Websites zulässt, sofern diese vom Unternehmen als vertrauenswürdig eingestuft werden, jedoch Nachrichten mit Verweisen zu Websites blockiert, die nicht als vertrauenswürdig eingestuft werden oder extern sind, benötigt zusätzlich zu MSPL eine separate Anwendung.

Informationen zu den oben aufgeführten Tools finden Sie in folgenden Abschnitten dieser Dokumentation:

  • "SIP-Anwendungsmanifeste": XML-Dokumente, die eine Beschreibung einer SIP-Anwendung für den -Computer enthalten, auf dem die Anwendung ausgeführt wird.
  • "Verwenden der SIP-verwalteten Anwendungs-APIs": Dieser Abschnitt enthält genaue Angaben zum Erstellen transaktionsbasierter Anwendungen, die auf ausgeführt werden.
  • "Referenz zur API für SIP-verwaltete Anwendungen": Enthält die Referenzdokumentation für den Microsoft.Rtc.Sip-Namespace und andere SIP-spezifische Ressourcen.

Communications Server-Verwaltungs-API

Die -Verwaltungs-API besteht aus einer Gruppe von WMI-Klassen (Windows-Verwaltungsinstrumentation), mit denen -Komponenten verwaltet werden. WMI arbeitet mit dem Standardformat CIM (Common Information Model), um Systeme, Anwendungen, Netzwerke, Geräte und andere verwaltete Komponenten darzustellen. Die meisten Klasseneigenschaften sind über die -Verwaltungskonsole verfügbar. Auf alle Eigenschaften kann mit einer Skriptsprache zugegriffen werden, die ActiveX®-Scripthosting wie Microsoft Visual Basic Scripting Edition (VBScript) unterstützt.

Mit WMI-Skripting können Verwaltungsaufgaben in der -Bereitstellung automatisiert werden. Zusätzlich können Sie mit WMI die WMI-Eigenschaften remote lesen oder ändern. Dazu muss der Computer, auf dem das Skript ausgeführt wird, jedoch entweder ein Computer mit sein, oder es müssen die -Verwaltungstools installiert sein.

Weitere Informationen zu WMI finden Sie unter Windows-Verwaltungsinstrumentation (WMI) (möglicherweise in englischer Sprache) auf MSDN.

Unified Communications Managed API 2.0 Core-SDK

Das Microsoft Unified Communications Managed API 2.0 Core SDK ist eine Plattform mit verwaltetem Code und bietet Zugriff auf Sofortnachrichten, Telefonie, Audio-/Videokonferenzen und Anwesenheitsinformationen sowie die Steuerung über diese Funktionen. Es soll die Entwicklung von Anwendungen der mittleren Ebene für Microsoft Office Communicator und Microsoft Office Communications Server 2007 R2 unterstützen.

UCMA 2.0 Core SDK lässt die meisten der Office Communications Server-Protokolle außer Acht und bietet eine API, die beinahe alle der Protokollfeatures aufweist, jedoch einfacher verständlich und benutzerfreundlicher ist. Die Kontakte und Gruppen eines Benutzers können z. B. mit der ContactGroupServices-Klasse verarbeitet werden. Eine Konferenz kann mit der ConferenceServices-Klasse geplant werden. Ein Benutzer oder eine Anwendung kann eine Unterhaltung mit anderen Benutzern oder Anwendungen mit der Conversation-Klasse initiieren. Eine Anwendung kann Anwesenheitsinformationen von anderen Benutzern oder Anwendungen mit den LocalOwnerPresence- und RemotePresence-Klassen abonnieren.

Unified Communications Managed API 2.0-Sprach-SDK

Mit dem Microsoft Unified Communications Managed API 2.0-Sprach-SDK können Entwickler Office Communications Server-Anwendungen erstellen, die Spracherkennung und Text-zu-Sprache-Features nutzen.

Unified Communications Managed API 2.0 Windows Workflow Activities

UCMA 2.0 Windows Workflow Activities ermöglicht die schnelle Erstellung von Sprach- und Sofortnachrichtenanwendungen für OCS, die Workflows unterstützen. UCMA 2.0 Windows Workflow Activities eignet sich für einfache Szenarien, z. B. Anrufweiterleitung, ebenso wie für komplexe Szenarien in großen Unternehmen, z. B. Audio-Zusammenarbeit und die Integration von Geschäftsprozessworkflows.

Office Communicator 2007-Automatisierungs-API-SDK

Das Microsoft () enthält eine Gruppe von COM-Schnittstellen, -Objekten, -Ereignissen und -Aufzählungstypen sowie weitere damit zusammenhängende Programmierentitäten. Mit können Sie eine ()-Instanz der Anwendung eines Drittanbieters programmieren und Anwendungen schreiben, die eine erweiterte und angepasste Benutzererfahrung mit bieten.

Beispielsweise können Sie sich bei anmelden, indem Sie die IMessenger::Signin-Methode aufrufen. Dieser Prozess unterscheidet sich nur wenig vom Ausführen einer -Instanz durch Klicken auf Anmelden im Menü Verbinden. Zusätzlich können -Features in andere Anwendungen integriert und an besondere Anwendungsanforderungen angepasst bzw. erweitert werden. Eine Anwendung zur Terminplanung kann mithilfe von auf die vorhandene Kontaktverwaltung zugreifen und Features abfragen, um Benutzern das Organisieren, Anzeigen oder Abfragen ihrer Kontakte zu ermöglichen.

ist eine COM-basierte API, die Automatisierung unterstützt und von Anwendungen aufgerufen werden kann, die in Microsoft Visual Basic®, C/C++, VBScript und vielen anderen Skriptsprachen verfasst wurden. Aus Sicherheitsgründen sind einige API-Aufrufe für Skriptsprachen deaktiviert. Eine vollständige Erläuterung dieser Beschränkungen finden Sie in der -Referenz.

Mit dem System.Runtime.Interop-Namespace in .NET Framework kann die API auch von Anwendungen aufgerufen werden, die in einer .NET-basierten Programmiersprache wie den Entwicklersystemen Microsoft Visual C#®, Visual J#® oder Visual Basic .NET verfasst wurden.

Unified Communications Client 1.0-SDK

Anwendungsentwickler können folgende Arten von -API-Anwendungen zur Echtzeitkommunikation und -zusammenarbeit erstellen:

  • Ein Kommunikations-Client mit umfassenden Funktionen wie (). Tatsächlich beruht auf der -API. Dieser Anwendungstyp kann Sofortnachrichten, Konferenzen, VoIP oder Video over IP und Telefonieintegration unterstützen. Er kann auch dazu verwendet werden, die Anwesenheit der Benutzerkontakte und andere anwesenheitsspezifische Daten nachzuverfolgen, da die Plattform allgemeine Veröffentlichungs- und Abonnementrahmenbedingungen unterstützt.
  • Eine Anwendung mit vielen Features, die mit interagiert und erhöhte Funktionalität oder benutzerdefinierte Dienste bietet. Diese Art Anwendung ermöglicht es einem Dienstanbieter, eine bestehende -Installationsbasis innerhalb eines Unternehmens zu nutzen. Bei diesen Anwendungen ist jedoch Vorsicht geboten, damit keine Daten veröffentlicht oder Sitzungen erstellt bzw. angenommen werden, die sich störend auf auswirken.
  • Eine integrierte LOB-Anwendung (Line of Business), die Anwesenheits- und Kommunikationsfunktionen in bestehende LOB-Anwendungen einbettet. Beispielsweise kann eine CRM-Anwendung (Kundenbeziehungsverwaltung, Customer Relationship Management) die Anwesenheitsnachverfolgung integrieren und darauf basierend bestimmen, wie Kundenanforderungen an den richtigen Servicemitarbeiter weitergeleitet werden.

Entwickler können mit der -API eine Anwendung erstellen, die integrierte Echtzeitkommunikation mit mehreren Modi innerhalb eines Netzwerks oder über Netzwerkgrenzen hinweg ermöglichen. Die resultierende Anwendung unterstützt Sie dabei, den Computer zum Mittelpunkt der Geschäftskommunikation in Echtzeit zu machen. Audio- und Videoanrufe sowie Sofortnachrichten (IM) und Zusammenarbeit sind in einer Benutzersitzung auf dem Computer integriert. Benutzer können nicht nur Kommunikationssitzungen zwischen Computern abhalten, sondern auch Sitzungen von Computer zu Telefon, von Telefon zu Telefon oder Nur-Text-Sofortnachrichtensitzungen erstellen.

Mithilfe eines Registrierungsservers können einem Benutzer Anwesenheitsinformationen angezeigt werden. So erfährt er, ob seine Kontakte in Echtzeit verfügbar sind. Aus diesem Grund ist es für einen Benutzer möglich, eine Person anzurufen, ohne zuvor den genauen Standort des Kontakts ermitteln oder die richtige Telefonnummer für den Anruf auswählen zu müssen. Wenn Sie beispielsweise einen Kontakt am Arbeitsplatz anrufen und aus den Anwesenheitsinformationen hervorgeht, dass die betreffende Person auf einem Computer verfügbar ist, der an einem Heimarbeitsplatz steht, kann der Anruf automatisch an diesen Ort weitergeleitet werden. Ein Benutzer kann zudem seine Privatsphäre schützen, indem er seine Anwesenheitsinformationen sperrt, sodass Anrufer nicht darauf zugreifen können.

Beispiele dieser Art der Echtzeitkommunikation für Geschäftsanwendungen sind benutzerdefinierte Kommunikationsmöglichkeiten für Benutzer Ihrer Anwendungen, wie z. B. eine CRM-Anwendung für Teilnehmer, die an einer Verkaufsmöglichkeit interessiert sind und aus diesen Grund an einer Videokonferenz teilnehmen und über die Anwendung auf Daten über den Kunden zugreifen können.

Die Sofortnachrichtendienste werden momentan über das MSN®-Netzwerk von Internetdiensten sowie von Yahoo! und AOL von Millionen Benutzern weltweit verwendet.

Microsoft Unified Communications-AJAX 2007-SDK

Microsoft® () besteht aus folgenden Komponenten:

  • ist eine Programmierschnittstelle für Anwendungen zu . Die API besteht aus Methoden und Ereignissen. Ein Client sendet eine Methode in Form einer Anforderung an den -Server und erhält Daten vom Server in Form von Ereignissen. Anforderungen und Ereignisse werden als XML-Elemente angegeben. Die Kommunikation erfolgt hauptsächlich über HTTP-POST- und GET-Anforderungen in individuellen Szenarien. Im Gegensatz zu Anwendungen, die als Webdienst dienen sollen, analysiert der -Server keine SOAP-Nachrichten und stellt kein WSDL-Dokument für Entwicklungstools von Clientanwendungen bereit. Dieser Ansatz bietet zwei Vorteile. Besonders wichtig ist in diesem Zusammenhang, dass die verstärkte Auslastung vermieden wird, die entsteht, wenn größere SOAP-Dokumente mit JavaScript-Code generiert und analysiert werden müssen. Darüber hinaus reichen allgemeine XML-Kenntnisse aus, um das erfolgreich verwenden zu können. Dazu sind keine besonderen Kenntnisse in Bezug auf SOAP-Nachrichten erforderlich.
  • Unified Communications-JavaScript-Bibliotheken auf Grundlage des AJAX-Diensts. Hierbei handelt es sich um JavaScript-Klassen zum Kapseln der normalerweise verwendeten Funktionalität, die für einen Client für Unified Communications-JavaScript-Bibliotheken erforderlich ist. Die allgemeine Funktionalität umfasst unter anderem das Erstellen und Verwalten der Kommunikationskanäle, die Anmeldung auf dem Server, das Einbetten der Anwesenheitsanzeige eines Benutzers in einer Webseite oder das Starten einer Sofortnachrichtenunterhaltung. Mit den Bibliotheken können Anwendungsentwickler einen Client für Unified Communications-JavaScript-Bibliotheken erstellen. Dazu werden die Bibliotheken einfach instantiiert, die entsprechenden Eigenschaften festgelegt und die gewünschten Methoden aufgerufen.

Der -Server stellt den Zugriff auf die Unified Communications-Funktionalität bereit.

Office Live Meeting-Dienst-API

Das Microsoft () ermöglicht den programmgesteuerten Zugriff auf fast alle Funktionen, die über die Windows- und webbasierten Office Live Meeting-Clients verfügbar sind.

Die -Dokumentation besteht aus zwei Teilen:

  • Eine allgemeine Anleitung mit Beispielen und Lernprogrammen, um neue Programmierer mit den Konzepten von Live Meeting und der Anwendungsprogrammierschnittstelle (Application Programming Interface, API) vertraut zu machen
  • Eine detaillierte API-Referenz mit Informationen zu öffentlich unterstützten Nachrichten, den zugrunde liegenden XML-Elementen, Fehlercodes und weiteren technischen Informationen

Die API-Dokumentation richtet sich an Entwickler und Programmierer, die Webkonferenzlösungen auf Grundlage der Live Meeting-Technologie entwerfen, implementieren und testen. Sie sollten über grundlegende HTTP- und XML-Kenntnisse verfügen.

Entwickler können mit Live Meeting-Diensten Onlinebesprechungen verwalten. Zu diesen Aufgaben zählen das Planen von Besprechungen, Einladen von Teilnehmern zu Besprechungen, Hinzufügen eines Benutzerkontos zu einem Live Meeting-Konferenzcenter, Hochladen von Präsentationen und weiteren Ressourcen, Verwalten von Aufnahmen, Benutzereinstellungen und eines Adressbuchs sowie Berichterstellung zu Anwesenheitsinformationen und anderen Statistiken mit Bezug zur Besprechung. Viele dieser Aufgaben können programmgesteuert ausgeführt werden.

Sie können über die Live Meeting-Webbenutzeroberfläche oder den API-Prozessor auf die Live Meeting-Dienste zugreifen. Benutzer können über die Webbenutzeroberfläche alle Aktivitäten bezüglich Besprechungen ausführen. Der API-Prozessor des Live Meeting-Diensts dient als Gateway für den programmgesteuerten Zugriff auf Live Meeting-Dienste und zum Verwalten von Benutzern, Ressourcen und Besprechungen.

Office Live Meeting-Dienstportal-API

Das Microsoft () ist eine Ergänzung zu Service Pack 2.

Das (das Portal) ist eine Webanwendung von Microsoft IIS (Internetinformationsdienste), die ASP.NET verwendet. Dieses Portal ist auf einem Webserver unter Microsoft Windows® installiert. Es kommuniziert über XML-API-Aufrufe, die über das Internet gesendet werden, mit dem Live Meeting-Dienst.

Benutzer können die Portalwebseiten in Webbrowsern aufrufen und folgende Aktionen ausführen:

  • Erstellen eines neuen Live Meeting-Kontos
  • Anmelden beim Live Meeting-Dienst
  • Ändern des Kennworts für das Live Meeting-Konto
  • Zulassen, dass Benutzer auf Multimediainhalte im Zusammenhang mit Live Meeting zugreifen

Programme oder Skripts, die die Portalwebmethoden aufrufen, können die Live Meeting-Kontoverwaltung automatisieren. Mit den Webmethoden können Sie folgende Aktionen ausführen:

  • Erstellen oder Löschen eines Live Meeting-Kontos
  • Aktivieren oder Deaktivieren eines Live Meeting-Kontos
  • Ändern des Kennworts für ein Live Meeting-Konto
  • Abrufen des Status eines Live Meeting-Kontos