Richtlinien für Office 2010 Mobile Service (Teil 3 von 3)
Zusammenfassung: Hier erhalten Sie Informationen zum XML-Schema für Daten, die zwischen Microsoft Office 2010 Mobile Service (OMS)-Webanbietern und OMS-Clients in Office 2010 übergeben werden, sowie zur WSDL-Definition (Web Services Description Language) für einen OMS-Webdienst. Dieser Artikel dient als Referenz für OMS-Webdienstanbieter. Beachten Sie, dass Office Mobile Service in Office 2010 die aktualisierte Version von Outlook Mobile Service in Microsoft Office System 2007 ist. (30 gedruckte Seiten)
Letzte Änderung: Montag, 9. März 2015
Gilt für: Excel 2010 | Office 2007 | Office 2010 | Office Mobile | Open XML | Outlook 2010 | Outlook Mobile | PowerPoint 2010 | SharePoint Foundation 2010 | SharePoint Server 2010 | VBA | Word 2010
Inhalt dieses Artikels
Einführung in OMS-Schemas
Referenz zu Dienstinformationen
Referenz zu Authentifizierungsdaten
Referenz zu Benutzerinformationen
Referenz zu Nachrichten
Referenz zu Übermittlungsantworten
Referenz zum Nachrichtenbatch
Referenz zum Batch mit Übermittlungsantworten
OMS-Webdienstmethoden
Schlussbemerkung
Weitere Ressourcen
Inhalt
Einführung in OMS-Schemas
Referenz zu Dienstinformationen
Referenz zu Authentifizierungsdaten
Referenz zu Benutzerinformationen
Referenz zu Nachrichten
Referenz zu Übermittlungsantworten
Referenz zum Nachrichtenbatch
Referenz zum Batch mit Übermittlungsantworten
OMS-Webdienstmethoden
Schlussbemerkung
Weitere Ressourcen
Einführung in OMS-Schemas
Dies ist der letzte Teil einer dreiteiligen Serie von Artikeln, in denen Microsoft Office 2010 Mobile Service (OMS) vorgestellt wird und Richtlinien zum Verwenden des Diensts bereitgestellt werden. Codebeispiele und Informationen zu dem Nachrichtenfluss zwischen OMS-Webanbietern und OMS-Clients finden Sie unter Richtlinien für Office 2010 Mobile Service (Teil 1 von 3). Empfehlungen zum Implementieren eines OMS-Webdiensts finden Sie unter Richtlinien für Office 2010 Mobile Service (Teil 2 von 3).
Referenz zu Dienstinformationen
Bei den Dienstinformationen handelt es sich um eine serviceInfo-Zeichenfolge, die in XML formatiert ist und die Informationen zu einem OMS-Webdienst enthält, z. B. zu unterstützten Diensttypen, Parametern der unterstützten Dienste und zu Authentifizierungstypen. Von der Methode GetServiceInfo() wird eine serviceInfo-Zeichenfolge zurückgegeben.
Die Elemente einer serviceInfo-Zeichenfolge sind im nächsten Abschnitt beschrieben, gefolgt vom Schema der Dienstinformationen.
Elementbeschreibungen
In Tabelle 1 sind ausführliche Erläuterungen zu den in der serviceInfo-Zeichenfolge verwendeten Elementen aufgeführt. Alle Elemente sind erforderlich, mit Ausnahme der Elemente, für die explizit angegeben ist, dass sie optional sind.
Tabelle 1. Elemente von 'serviceInfo'
Element |
Attribute |
Beschreibung |
|---|---|---|
<serviceInfo> |
Stammelement |
|
<serviceProvider> |
Der Firmenname des Dienstanbieters, der in der OMS-Benutzeroberfläche für die Kontoeinstellungen in Outlook 2010 angezeigt wird. |
|
<serviceUri> |
Der URI (Uniform Resource Identifier) des Webdiensts, der als eindeutige ID des Webdiensts verwendet wird. Falls der serviceUri-Wert des OMS-Webdiensts geändert wird, behandelt der OMS-Client den Dienst als neuen OMS-Webdienst. |
|
<signUpPage> |
Der URI der Anmeldeseite des OMS-Webdiensts. |
|
<targetLocale> |
Die Gebietsschema-ID (Locale ID, LCID), die zum Anzeigen des Lands oder der Region verwendet wird, für das bzw. die der Webdienst verwendet werden soll (z. B. 2052 für Chinesisch-China und 1042 für Koreanisch). Der Standardwert ist 0 (der Dienst ist global). Ein detailliertes Diagramm mit LCIDs finden Sie unter Locale ID (LCID) Chart. In Bezug auf 3GPP2 C.R1001-C in Tabelle 9.1-1 können verschiedene SMS-Codierungsschemas (Short Message Service) in verschiedenen Märkten verwendet werden. Im Allgemeinen sind zwei Arten von Codierung vorhanden:
Bei der Codierung vom Typ 1 wird ein ASCII-Zeichen als ein Unicode-Zeichen in einer Textnachricht gezählt, die sowohl ASCII- als auch Nicht-ASCII-Zeichen enthält. Bei der Codierung vom Typ 2 wird ein ASCII-Zeichen als ein Byte in einer Textnachricht gezählt, die sowohl ASCII- als auch Nicht-ASCII-Zeichen enthält. Falls <targetLocale> auf Koreanisch oder Japanisch festgelegt ist, wird die Nachrichtenlänge auf der Grundlage der Codierung vom Typ 2 berechnet, während sie für die anderen Gebietsschemas auf der Codierung vom Typ 1 basiert. Auf den <targetLocale>-Wert wird auch durch den Client verwiesen, indem der Name des Webdiensts in der Benutzeroberfläche von OMS angezeigt wird. Weitere Einzelheiten finden Sie in der Beschreibung des <localName>-Werts. |
|
<localName> |
Der Dienstname in der lokalen Sprache, der in der OMS-Benutzeroberfläche für die Kontoeinstellungen angezeigt wird, wenn der <targetLocale>-Wert derselbe ist wie für die Benutzeroberflächensprache von Microsoft Office. Andernfalls wird <englishName> verwendet. Der Standardkontoname wird erstellt durch Verwendung von <localName> oder <englishName> gefolgt vom Element <replyPhone> der userInfo-Zeichenfolge (siehe Referenz zu Benutzerinformationen in diesem Artikel) im Format <replyPhone> (<localName>). |
|
<englishName> |
Der Dienstname auf Englisch, der in der OMS-Benutzeroberfläche für die Kontoeinstellungen angezeigt wird, wenn <targetLocale> nicht mit der Benutzeroberflächensprache von Office übereinstimmt. |
|
<authenticationType> |
Wird zum Anzeigen der Authentifizierungsmethode verwendet, die vom Webdienst unterstützt wird. Unterstützte Werte sind passport und other. Falls passport nicht unterstützt wird, verwenden Sie other. Dies bedeutet, dass Benutzer mithilfe einer normalen Benutzer-ID und eines Kennworts authentifiziert werden. |
|
<batchSize> |
Wenn dieses Element vorhanden ist, wird damit angezeigt, dass der OMS-Webdienst die Übertragung im Batchmodus unterstützt (z. B. den von SharePoint 2010 verwendeten Modus). Falls dieser Modus aktiviert ist, übermittelt der OMS-Client mehrere xmsData-Elemente an den OMS-Webdienst in einer Transaktion von DeliverXmsBatch(). Mit dem Wert batchSize wird die maximale Anzahl von xmsData in einem einzelnen XML-Element angegeben. |
|
<supportedService> |
Das übergeordnete Tag für unterstützte Dienstelemente |
|
<SMS_SENDER> |
maxRecipientsPerMessage maxMessagesPerSend maxSbcsPerMessage maxDbcsPerMessage |
Der unterstützte Diensttyp. Von <SMS_SENDER> werden ausgehende Textnachrichten behandelt. Einschränkungen oder Eigenschaften werden als Attribute angegeben. Wenn der Client eine Nachricht an den Webdienst sendet, wird der erforderliche Diensttyp in der Zeichenfolge xmsData angegeben, die als Parameter an DeliverXms() übergeben wird. Optional, aber <SMS_SENDER> oder <MMS_SENDER> muss mindestens unterstützt werden. Unter anderem stehen die folgenden Attribute zur Verfügung:
|
<LONG_SMS_SENDER> |
maxRecipientsPerMessage maxMessagesPerSend maxSbcsPerMessage maxDbcsPerMessage |
Der unterstützte Diensttyp <LONG_SMS_SENDER> ist ein untergeordnetes Element von <SMS_SENDER>. Wenn dieses Element in serviceInfo angegeben ist, wird der SMS-Text von Outlook 2010 in einem einzelnen Inhaltselement in xmsData übermittelt. Ohne dieses Element zeigt Outlook 2010 ein ähnliches Verhalten wie Outlook 2007, wobei die Nachricht bei einer SMS-Nachricht, deren Länge das in maxSbcsPerMessage oder maxDbvsPerMessage in <SMS_SENDER> angegebene Maximum für die Anzahl von Zeichen überschreitet, abgeschnitten wird. Einschränkungen oder Eigenschaften werden als Attribute angegeben. Wenn der Client eine Nachricht an den Webdienst sendet, wird der erforderliche Diensttyp in der Zeichenfolge xmsData angegeben, die als Parameter an DeliverXms() übergeben wird. <LONG_SMS_SENDER> sollte für Outlook 2010 unterstützt werden, sodass die OMS-Webdienstanbieter die lange SMS (verkettete SMS) ordnungsgemäß verarbeiten können. Unter anderem stehen die folgenden Attribute zur Verfügung:
|
<MMS_SENDER> |
supportSlide maxRecipientsPerMessage maxSizePerMessage maxSlidesPerMessage |
Der unterstützte Diensttyp. Von <MMS_SENDER> werden ausgehende MMS-Nachrichten (Multimedia Messaging Service) behandelt. Einschränkungen oder Eigenschaften werden als Attribute angegeben. Optional, aber <SMS_SENDER> oder <MMS_SENDER> muss mindestens unterstützt werden. Unter anderem stehen die folgenden Attribute zur Verfügung:
|
Schema der Dienstinformationen
Im folgenden Beispiel wird das Schema einer serviceInfo-Zeichenfolge gezeigt.
<?xml version="1.0" encoding="utf-8"?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified"
targetNamespace="https://schemas.microsoft.com/office/Outlook/2006/OMS"
xmlns:tns="https://schemas.microsoft.com/office/Outlook/2006/OMS"
xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexType name="tSMS_SENDER">
<xs:annotation>
<xs:documentation>
Specify a type for outgoing text message service.
</xs:documentation>
</xs:annotation>
<xs:attribute name="maxRecipientsPerMessage" type="xs:unsignedInt" use="required">
<xs:annotation>
<xs:documentation>
Maximum number of recipients allowed for a text message.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="maxMessagesPerSend" type="xs:unsignedInt" use="required">
<xs:annotation>
<xs:documentation>
Maximum number of split text messages allowed in one DeliverXms transaction.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="maxSbcsPerMessage" type="xs:unsignedInt" use="required">
<xs:annotation>
<xs:documentation>
Maximum number of single-byte chars a text message can have.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="maxDbcsPerMessage" type="xs:unsignedInt" use="required" >
<xs:annotation>
<xs:documentation>
Maximum number of double-byte chars a text message can have.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="tMMS_SENDER">
<xs:annotation>
<xs:documentation>
Specify a type for outgoing multimedia message service.
</xs:documentation>
</xs:annotation>
<xs:attribute name="supportSlide" type="xs:boolean" use="required">
<xs:annotation>
<xs:documentation>
Indicate if the Web service supports multimedia messages that are described as a series of slides using SMIL.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="maxRecipientsPerMessage" type="xs:unsignedInt" use="required">
<xs:annotation>
<xs:documentation>
Maximum number of recipients allowed for a multimedia message.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="maxSizePerMessage" type="xs:unsignedInt" use="required">
<xs:annotation>
<xs:documentation>
Maximum size in bytes that a multimedia message can have.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="maxSlidesPerMessage" type="xs:unsignedInt" use="required">
<xs:annotation>
<xs:documentation>
Maximum number of slides a multimedia message can have.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="tSupportedService">
<xs:annotation>
<xs:documentation>
Specify a type for services supported by a Web service.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="SMS_SENDER" type="tns:tSMS_SENDER" minOccurs="0">
<xs:annotation>
<xs:documentation>
Outgoing text message service (SMS).
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="MMS_SENDER" type="tns:tMMS_SENDER" minOccurs="0">
<xs:annotation>
<xs:documentation>
Outgoing multimedia message service (MMS).
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="tServiceInfo">
<xs:annotation>
<xs:documentation>
Specify a type for Web service properties.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="serviceProvider" type="xs:string">
<xs:annotation>
<xs:documentation>
Name of the OMS Web service provider.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="serviceUri" type="xs:string" >
<xs:annotation>
<xs:documentation>
Uniform Resource Identifier (URI) of the Web service.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="signUpPage" type="xs:string">
<xs:annotation>
<xs:documentation>
Hyperlink to the sign-up page of the Web service.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="targetLocale" type="xs:unsignedShort" minOccurs="0">
<xs:annotation>
<xs:documentation>
The Locale ID that represents the market the Web service is for. Use zero for global service.
Default value is zero.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="localName" type="xs:string">
<xs:annotation>
<xs:documentation>
Official name of the Web service in local language. If the 'targetLocale' is same
as the UI language of Microsoft Office Outlook 2007, 'localName'
is displayed on the account setting user interface of Outlook 2007.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="englishName" type="xs:string">
<xs:annotation>
<xs:documentation>
Official name of the Web service in English. If the 'targetLocale' is different
from the UI language of Microsoft Office Outlook 2007, 'englishName' is displayed
on the account setting user interface of Outlook 2007.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="authenticationType" type="xs:string">
<xs:annotation>
<xs:documentation>
Type of authentication supported by the Web service. Currently supported values are 'passport' or 'other'.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="supportedService" type="tns:tSupportedService">
<xs:annotation>
<xs:documentation>
Supported services by the Web service.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:element name="serviceInfo" type="tns:tServiceInfo">
<xs:annotation>
<xs:documentation>
Information about the Web service with its properties defined in type tServiceInfo.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:schema>
Referenz zu Authentifizierungsdaten
Bei Authentifizierungsdaten handelt es sich um eine xmsUser-Zeichenfolge, die in XML formatiert ist und Authentifizierungsinformationen für einen Benutzer enthält. Sie wird als Parameter für die GetUserInfo()-Methode verwendet. Weitere Informationen finden Sie im Abschnitt "string GetUserInfo(string xmsUser)-Webdienstmethode" in Richtlinien für Office 2010 Mobile Service (Teil 1 von 3).
Schema der Authentifizierungsdaten
Im folgenden Beispiel wird das Schema einer xmsUser-Zeichenfolge gezeigt.
<?xml version="1.0" encoding="utf-8"?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" targetNamespace="https://schemas.microsoft.com/office/Outlook/2006/OMS"
xmlns:tns="https://schemas.microsoft.com/office/Outlook/2006/OMS"
xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexType name="tXmsUser">
<xs:annotation>
<xs:documentation>
Specify a type for user's authentication information.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="userId" type="xs:string" minOccurs="0" >
<xs:annotation>
<xs:documentation>
User's identification provided by their service provider.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="password" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>
User's password provided by their service provider.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="customData" type="xs:string" minOccurs="0" >
<xs:annotation>
<xs:documentation>
Reserved for future extension.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="client" type="xs:string" >
<xs:annotation>
<xs:documentation>
Client information, such as "Microsoft Office Outlook 12.0".
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:element name="xmsUser" type="tns:tXmsUser" >
<xs:annotation>
<xs:documentation>
User's authentication information.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:schema>
Referenz zu Benutzerinformationen
Eine userInfo-Zeichenfolge ist in XML formatiert und wird von der GetUserInfo()-Webmethode zurückgegeben, die von OMS-Webdiensten implementiert wird. Falls der Aufruf von GetUserInfo() erfolgreich war, enthält die userInfo-Zeichenfolge Benutzerinformationen und ein error-Element, dessen code-Attribut auf OK festgelegt ist. Falls beim Aufruf ein Fehler aufgetreten ist, enthält die userInfo-Zeichenfolge mindestens ein error-Element, dessen severity-Attribut auf failure festgelegt ist.
Schema der Benutzerinformationen
Im folgenden Beispiel wird das Schema einer userInfo-Zeichenfolge gezeigt.
<?xml version="1.0" encoding="utf-8"?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" targetNamespace="https://schemas.microsoft.com/office/Outlook/2006/OMS"
xmlns:tns="https://schemas.microsoft.com/office/Outlook/2006/OMS"
xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexType name="tError">
<xs:annotation>
<xs:documentation>
Specify a type for the error data returned by the Web service.
</xs:documentation>
</xs:annotation>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attribute name="code" type="xs:string" use="required" >
<xs:annotation>
<xs:documentation>
Predefined error code.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="severity" type="xs:string" use="optional" >
<xs:annotation>
<xs:documentation>
Severity of an error.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
<xs:complexType name="tUserInfo">
<xs:annotation>
<xs:documentation>
Specify a type for user information.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="replyPhone" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>
Users' mobile phone number.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="smtpAddress" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>
SMTP address for receiving replies from mobile phone.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="error" type="tns:tError">
<xs:annotation>
<xs:documentation>
Error data returned by the Web service.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="customData" type="xs:string" minOccurs="0" >
<xs:annotation>
<xs:documentation>
Reserved for future extension.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:element name="userInfo" type="tns:tUserInfo">
<xs:annotation>
<xs:documentation>
User information returned by the Web service.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:schema>
Referenz zu Nachrichten
Bei einer Nachricht handelt es sich um eine xmsData-Zeichenfolge, die in XML formatiert ist und zum Speichern von Nachrichteninformationen verwendet wird, einschließlich des Inhalts der Nachricht und der angegebenen Empfänger. Sie wird als Parameter für die Webdienstmethode DeliverXms() verwendet. Die Elemente einer xmsData-Zeichenfolge sind in Tabelle 2 beschrieben, gefolgt vom Nachrichtenschema.
Elementbeschreibungen
In Tabelle 2 sind einige Elemente von xmsData definiert. Alle Elemente sind erforderlich, mit Ausnahme der Elemente, die explizit als optional angegeben sind.
Tabelle 2. Elemente von 'xmsData'
Element |
Attribut |
Beschreibung |
|---|---|---|
<xmsData> |
Das Stammelement. |
|
<user> |
Das übergeordnete Tag für Elemente mit Benutzerinformationen. |
|
<userId> |
Die Benutzer-ID, die entweder ein Passport oder eine beliebige Zeichenfolge ist, die aus Zeichen und Zahlen besteht. Eine Mobiltelefonnummer kann als ein Nicht-Passport-userId verwendet werden. |
|
<password> |
Das Kennwort, das beim Anmelden für den Dienst bei einem Dienstanbieter erstellt wird. |
|
<replyPhone> |
Die Antwort- oder Rückrufnummer, die hauptsächlich in Korea verwendet wird. Dienstanbieter, die Rückrufnummern nicht unterstützen, können dieses Element ignorieren. Optional |
|
<customData> |
Für zukünftige Erweiterungen. |
|
<xmsHead> |
Das übergeordnete Tag für Kopfzeilenelemente einer XMS-Nachricht. |
|
<scheduled> |
Gibt an, dass die Nachricht zu einer bestimmten Uhrzeit (UTC-Zeit im Format JJJJ-MM-DDThh:mm:ssZ) gesendet werden soll. Die Angabe ist nur auf die Minute genau, sodass das Sekundenelement ("ss") immer 00 ist. Die geplante Zeit muss von der Dienstseite in die lokale Zeitzone konvertiert werden. Falls die angegebene Zeit in der Vergangenheit liegt, wird die Nachricht sofort gesendet. Optional |
|
<requiredService> |
Der vom Client erforderliche Dienst. Einer der unterstützten Dienste, die in der serviceInfo-Zeichenfolge definiert sind. Gültige Werte sind SMS_SENDER oder MMS_SENDER. |
|
<sourceType> |
Gibt für den Dienst an, dass die Nachricht automatisch von einer Outlook-Erinnerung, einer Kalenderzusammenfassung oder von Regeln generiert wurde oder manuell mithilfe eines XMS-Inspektors oder dem Outlook-Inspektor (other) gesendet wurde. Gültige Werte sind reminder, calSummary oder ruleBased, xmsInspector, spAlert oder other. Weitere sourceType-Werte können zukünftig für OMS-Clients für neue SMS-Features hinzugefügt werden. Vom Webdienst kann eine Web-UI für Benutzer bereitgestellt werden, um einige dieser Nachrichten zu bestimmten Zeiten oder für bestimmte Bedingungen zu blockieren. Dieses Element kann vom Webdienst ignoriert werden, wenn die für sourceType spezifische Aktion nicht unterstützt wird. Optional |
|
<to> |
Das übergeordnete Element der Empfängerliste. |
|
<recipient> |
Verweist auf die Mobiltelefonnummer (Adresse) des Empfängers. Mehrere Vorkommen. Es muss mindestens ein Empfänger angegeben sein. Die maximale Anzahl von Empfängern wird vom Webdienst im maxRecipientsPerMessage-Attribut des unterstützten Diensttyps (<MMS_SENDER> oder <SMS_SENDER>) angegeben. |
|
<xmsBody…> |
format |
Das übergeordnete Element der Elemente des XMS-Nachrichtentexts. Das format-Attribut gibt das Format oder den Typ von xmsBody an. OMS bietet Unterstützung für SMS und MMS. Weitere Nachrichtenformate werden möglicherweise in zukünftigen Versionen unterstützt. |
<subject> |
Der Betreff der Nachricht. Gilt nur für MMS-Nachrichten. |
|
<mmsSlides> |
Das Stammelement der Präsentationsbeschreibung. Gilt nur für MMS-Nachrichten. Erforderlich für folienbasierte MMS-Nachrichten. Falls mmsSlides für eine MMS-Nachricht nicht verfügbar ist, wird angegeben, dass die MMS-Nachricht im Nicht-Folienmodus oder vom Typ multipart.mixed im Sinne von MMS vorliegt, und die Medien werden in ihrer Codierungssequenz präsentiert. Die untergeordneten Elemente von mmsSlides sind eine Untergruppe von SMIL gemäß 3GPP. |
|
<head> |
Das Stammtag für den Kopfzeilenteil von SMIL. |
|
<meta name="author" …> |
name content |
Metadaten, die den Verfasser des SMIL-Teils mit name="author" und content="msOfficeOutlookOms" angeben. Auf der Dienstseite ist keine Aktion erforderlich. Optional |
<layout> |
Das Stammtag für den Layoutteil von SMIL. |
|
<root-layout …> |
width height background-color |
Die Bildschirmauflösung des Telefons in Pixeln und die Hintergrundfarbe. |
<region id="image" …> |
id left top width height |
Das id-Attribut kann auf image oder text festgelegt sein, womit der Typ des Bereichs definiert wird. Mit den anderen vier Attributen wird die Position und Größe des Bereichs in Prozent der Länge und Breite der Folie angegeben. |
<body> |
Das Stammtag für den Textteil von SMIL. |
|
<par dur="3s" …> |
dur |
Das Stammtag einer MMS-Folie. Mit dem dur-Attribut wird die Dauer in Sekunden angegeben, die die Folie wiedergegeben wird. Mehrere Vorkommen. |
<img …> |
src region |
Ein Base64-codiertes Bildobjekt. Das src-Attribut verweist auf das contentId-Attribut des <content>-Elements. Optional |
<text …> |
src region |
Ein Nur-Text-Objekt. Das src-Attribut verweist auf das contentID-Attribut des <content>-Elements. Optional |
<audio …> |
src region |
Ein Base64-codiertes Audioobjekt. Das src-Attribut verweist auf das contentId-Attribut des <content>-Elements. Optional |
<content> |
contentType contentId contentLocation |
Mehrere Vorkommen und sequenziell. Stellt eins der folgenden Elemente dar:
Unter anderem stehen die folgenden Attribute zur Verfügung:
|
Nachrichtenschema
Im folgenden Beispiel wird das Schema einer xmsData-Zeichenfolge gezeigt.
<?xml version="1.0" encoding="utf-8"?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" targetNamespace="https://schemas.microsoft.com/office/Outlook/2006/OMS"
xmlns:tns="https://schemas.microsoft.com/office/Outlook/2006/OMS"
xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexType name="tTo">
<xs:annotation>
<xs:documentation>
Specify a type for recipients of the message.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element maxOccurs="unbounded" name="recipient" type="xs:string">
<xs:annotation>
<xs:documentation>
Cell phone number as the recipient of the message.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="tXmsHeader">
<xs:annotation>
<xs:documentation>
Specify a type for the header part of the message data.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="scheduled" type="xs:dateTime" minOccurs="0">
<xs:annotation>
<xs:documentation>
Indicate that the message is to be sent at the specified time.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="requiredService" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>
Required service by the message.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="sourceType" type="xs:string" minOccurs="0" >
<xs:annotation>
<xs:documentation>
Source of the message, indicating how the message was created by the client.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="to" type="tns:tTo">
<xs:annotation>
<xs:documentation>
Recipients of the message.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="subject" type="xs:string" minOccurs="0" >
<xs:annotation>
<xs:documentation>
Subject of the message. Apply only to a multimedia message.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="tUser">
<xs:annotation>
<xs:documentation>
Specify a type for user information.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="userId" type="xs:string" minOccurs="0" >
<xs:annotation>
<xs:documentation>
User's identification provided by their service provider.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="password" type="xs:string" minOccurs="0" >
<xs:annotation>
<xs:documentation>
User's password provided by their service provider.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="replyPhone" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>
User's cell phone number.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="customData" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>
Reserved for future extension.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="tMeta">
<xs:annotation>
<xs:documentation>
Specify a type for metadata.
</xs:documentation>
</xs:annotation>
<xs:attribute name="name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
Name of the metadata.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="content" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
Content of the metadata.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="tRoot-layout">
<xs:annotation>
<xs:documentation>
Specify a type for the description of the display of a cell phone.
</xs:documentation>
</xs:annotation>
<xs:attribute name="width" type="xs:unsignedInt" use="required" >
<xs:annotation>
<xs:documentation>
Width of the message view.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="height" type="xs:unsignedByte" use="required" >
<xs:annotation>
<xs:documentation>
Height of the message view.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="background-color" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
Background color of the message view.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="tRegion">
<xs:annotation>
<xs:documentation>
Specify a type for describing regions of the display of a cell phone.
</xs:documentation>
</xs:annotation>
<xs:attribute name="id" type="xs:string" use="required" >
<xs:annotation>
<xs:documentation>
ID of the region.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="left" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
Left position of the region.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="top" type="xs:string" use="required" >
<xs:annotation>
<xs:documentation>
Top position of the region.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="width" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
Width of the region.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="height" type="xs:string" use="required" >
<xs:annotation>
<xs:documentation>
Height of the region.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="tLayout">
<xs:annotation>
<xs:documentation>
Specify a type for the layout definition of a multimedia message.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="root-layout" type="tns:tRoot-layout">
<xs:annotation>
<xs:documentation>
Display definition of a cell phone in terms of screen resolution.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="region" type="tns:tRegion" maxOccurs="2">
<xs:annotation>
<xs:documentation>
Regions definition of the display of a cell phone.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="tHeader">
<xs:annotation>
<xs:documentation>
Specify a type for the header part of the message data.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="meta" type="tns:tMeta" minOccurs="0" >
<xs:annotation>
<xs:documentation>
Metadata to indicate the author of the SMIL.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="layout" type="tns:tLayout">
<xs:annotation>
<xs:documentation>
Layout definition of a multimedia message.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="tImg">
<xs:annotation>
<xs:documentation>
Specify a type for image.
</xs:documentation>
</xs:annotation>
<xs:attribute name="src" type="xs:string" use="required" >
<xs:annotation>
<xs:documentation>
Path to the image - contentId attribute of 'content' element is used here.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="region" type="xs:string" use="required" >
<xs:annotation>
<xs:documentation>
Region for displaying the image.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="tText">
<xs:annotation>
<xs:documentation>
Specify a type for plain text.
</xs:documentation>
</xs:annotation>
<xs:attribute name="src" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
Path to the text - contentId attribute of 'content' element is used here.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="region" type="xs:string" use="required" >
<xs:annotation>
<xs:documentation>
Region for displaying the text.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="tAudio">
<xs:annotation>
<xs:documentation>
Specify a type for audio.
</xs:documentation>
</xs:annotation>
<xs:attribute name="src" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
Path to the audio - contentId attribute of 'content' element is used here.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="tPar">
<xs:annotation>
<xs:documentation>
Specify a type for elements of a slide.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="img" type="tns:tImg" minOccurs="0">
<xs:annotation>
<xs:documentation>
Image part of a slide.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="text" type="tns:tText" minOccurs="0">
<xs:annotation>
<xs:documentation>
Text part of a slide.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="audio" type="tns:tAudio" minOccurs="0">
<xs:annotation>
<xs:documentation>
Audio part of a slide.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="dur" type="xs:unsignedInt" use="required">
<xs:annotation>
<xs:documentation>
Duration in seconds for the slide to be played.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="tBody">
<xs:annotation>
<xs:documentation>
Specify a type for the body part of slide definition.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="par" type="tns:tPar" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>
Parts of the body part of the slide definition.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="tMmsSlides">
<xs:annotation>
<xs:documentation>
Specify a type for the slide definition.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="head" type="tns:tHeader" minOccurs="0">
<xs:annotation>
<xs:documentation>
Header part of the slide definition.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="body" type="tns:tBody">
<xs:annotation>
<xs:documentation>
Body part of the slide definition.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="tContent">
<xs:annotation>
<xs:documentation>
Specify a type for the contents of the body part of the message data.
</xs:documentation>
</xs:annotation>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attribute name="contentType" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
MIME content type of message content.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="contentId" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
ID of message content.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="contentLocation" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
Location of message content - path to the media file.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
<xs:complexType name="tXmsBody">
<xs:annotation>
<xs:documentation>
Specify a type for the body part of the message data.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="mmsSlides" type="tns:tMmsSlides" minOccurs="0">
<xs:annotation>
<xs:documentation>
Slide definition of the body part of the message data.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="content" type="tns:tContent" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>
Contents of the body part of the message data.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="format" type="xs:string" use="required" />
</xs:complexType>
<xs:complexType name="tXmsData">
<xs:annotation>
<xs:documentation>
Specify a type for the message data being transferred to the Web service.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="user" type="tns:tUser" minOccurs="0">
<xs:annotation>
<xs:documentation>
User information.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="xmsHead" type="tns:tXmsHeader" minOccurs="0">
<xs:annotation>
<xs:documentation>
Header part of the message data.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="xmsBody" type="tns:tXmsBody">
<xs:annotation>
<xs:documentation>
Body part of the message data.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="client" type="xs:string" >
<xs:annotation>
<xs:documentation>
Client information, such as "Microsoft Office Outlook 12.0".
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:element name="xmsData" type="tns:tXmsData">
<xs:annotation>
<xs:documentation>
Message data being transferred to the Web service.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:schema>
Referenz zu Übermittlungsantworten
Bei der Übermittlungsantwort handelt es sich um eine xmsResponse-Zeichenfolge, die als XML formatiert ist und von DeliverXms() zurückgegeben wird, um Erfolg oder Fehler anzuzeigen. Die xmsResponse-Zeichenfolge enthält mindestens ein error-Element, dem abhängig vom Fehlertyp untergeordnete content- oder recipientList-Elemente zugeordnet sein können.
OMS-Fehlercodes
Vom OMS-Webdienst können viele verschiedene Fehler an den OMS-Client zurückgegeben werden. Beim Aufruf von GetUserInfo() und DeliverXms() werden als XML formatierte Zeichenfolgen zurückgegeben, die mindestens ein error-Element enthalten, das den Erfolg oder Fehler des Aufrufs angibt.
Der Wert des code-Attributs jedes error-Elements, das in einer userInfo- oder xmsResponse-Zeichenfolge enthalten ist, sollte einem der Werte in Tabelle 3 entsprechen. Bei diesen Werten wird die Groß-/Kleinschreibung nicht beachtet.
Der Wert des severity-Attributs kann entweder neutral oder failure sein. Dieses Attribut ist für Fehler erforderlich, die in den xmsResponse-Zeichenfolgen enthalten sind, es ist jedoch in userInfo-Zeichenfolgen optional.
Mit dem Fehlercode ok wird der Erfolg angegeben. Mit dem Fehlercode other kann ein Fehler angegeben werden, der keinem der erwarteten Fehlertypen entspricht und über ein begleitendes untergeordnetes content-Element verfügen sollte, das Details zu dem Fehler enthält.
Jedes error-Element, das in einer xmsResponse-Zeichenfolge zurückgegeben wird, darf abhängig vom Fehlertyp maximal ein untergeordnetes Element content und ein untergeordnetes Element recipientList enthalten. Das content-Element enthält eine Beschreibung oder Parameter des Fehlers. Das recipientList-Element enthält eine Zeichenfolge, die die Liste der Empfänger enthält, die von dem Fehler betroffen sind. Tabelle 3 zeigt den erwarteten Inhalt dieser untergeordneten Elemente für jeden Fehlertyp und zudem die vordefinierten Fehlercodes, die von OMS-Webdiensten verwendet werden.
Tabelle 3. OMS-Fehlercodes
Wert des "code"-Attributs |
Erklärung |
Wert des "severity"-Attributs |
untergeordnetes "<content>"-Element |
untergeordnetes "<recipientList>"-Element |
|---|---|---|---|---|
ok |
Voller Erfolg. |
neutral |
Nicht zutreffend |
Nicht zutreffend |
invalidUser |
Ungültige oder nicht erkannte Benutzer-ID oder ungültiges oder nicht erkanntes Kennwort. |
failure |
Nicht zutreffend |
Nicht zutreffend |
unregisteredUser |
Der Benutzer hat sich nicht für den Dienst registriert. Vom Dienstanbieter wird invalidUser zurückgegeben, wenn die Beurteilung nicht auf der Grundlage der Benutzer-ID erfolgen kann. |
failure |
Nicht zutreffend |
Nicht zutreffend |
unregisteredService |
Der Benutzer hat den im Element <content> aufgeführten Dienst nicht abonniert. |
failure |
SMS oder MMS |
Nicht zutreffend |
expiredUser |
Die Vorauszahlung des Benutzers ist aufgebraucht, oder die Registrierung ist abgelaufen. Der Fehlercode wird für einen Dienstanbieter verwendet, der einen Prepaiddienst anbietet. |
failure |
Nicht zutreffend |
Nicht zutreffend |
invalidRecipient |
Mindestens ein Empfänger ist ungültig oder wird nicht erkannt. Gibt eine durch Semikolon getrennte Liste der Empfänger im Element <recipientList> zurück. |
failure |
Nicht zutreffend |
Recipent1; Recipient2; … |
crossCarrier |
Mindestens ein Empfänger stammt von einem Netzbetreiber, der vom Netzbetreiber des Absenders nicht unterstützt wird. Gibt eine durch Semikolon getrennte Liste der Empfänger im <recipientList>-Element zurück. |
failure |
Nicht zutreffend |
Recipent1; Recipent2;… |
invalidChar |
Der Betreff oder Text der Nachricht enthält Zeichen oder Wörter, die aufgrund von lokalen Richtlinien nicht zulässig sind oder vom Dienstanbieter nicht unterstützt werden. |
failure |
Nicht zutreffend |
Nicht zutreffend |
invalidMedia |
Ungültige oder nicht unterstützte Medien. Gibt Inhalts-IDs von ungültigen Medien im <content>-Element zurück. (Das Attribut gilt nur für MMS-Nachrichten.) |
failure |
Speicherort1; Speicherort2… |
Nicht zutreffend |
perDayMsgLimit |
Die maximale Anzahl von Nachrichten, die ein Benutzer pro Tag senden kann, wurde überschritten. Gibt die maximale Anzahl im <content>-Element zurück. |
failure |
Maximale Anzahl von Nachrichten pro Tag im Format: Anzahl von SMS oder Anzahl von MMS |
Empfänger1; Empfänger2;… |
perMonthMsgLimit |
Die maximale Anzahl von Nachrichten, die ein Benutzer pro Monat senden kann, wurde überschritten. Gibt die maximale Anzahl im <content>-Element zurück. |
failure |
Maximale Anzahl von Nachrichten pro Monat im Format: Anzahl von SMS oder Anzahl von MMS |
Empfänger1; Empfänger2;… |
lengthLimit |
Die maximale Länge einer SMS-Nachricht wurde überschritten. Gibt die maximale Länge für Einzelbyte- und Doppelbytenachrichten im <content>-Element an. |
failure |
DB oder gemischter Grenzwert; Grenzwert EB |
Nicht zutreffend |
sizeLimit |
Die maximale Größe einer MMS-Nachricht wurde überschritten. |
failure |
Maximal zulässige Größe (in Bytes) von MMS-Nachrichten. |
Nicht zutreffend |
slidesLimit |
Die maximale Anzahl von Folien wurde für eine MMS überschritten. |
failure |
Die maximal für eine MMS-Nachricht zulässige Anzahl von Folien. |
Nicht zutreffend |
invalidFormat |
Ungültiges oder nicht erkanntes XMS-Datenformat. |
failure |
Nicht zutreffend |
Nicht zutreffend |
serviceNetwork |
Dienstseitiges Netzwerkproblem (es konnte z. B. keine Verbindung mit SMSC oder MMSC hergestellt werden). |
failure |
Nicht zutreffend |
Recipent1; Recipent2;… |
noScheduled |
Ein terminiertes Senden wird nicht unterstützt. Die Nachricht wird sofort gesendet. |
failure |
Nicht zutreffend |
Nicht zutreffend |
lowBalance |
Der Kontensaldo des Benutzers ist niedrig. Der aktuelle Saldo und die Kosten pro Nachricht werden im <content>-Element zurückgegeben. |
failure |
Der aktuelle Saldo und die Kosten pro Nachricht werden durch Semikolon getrennt zurückgegeben. Verwenden Sie das Währungssymbol hinter jeder Zahl (ein Beispiel: 5,00 €;0,10 €). |
Empfänger1; Empfänger2;… |
serviceUpdate |
Dies Nachricht sollte vom Dienst bei jeder Änderung der Diensteigenschaften zurückgegeben werden. Vom Client kann GetServiceInfo() aufgerufen werden, um die Diensteigenschaften bei Empfang dieser Nachricht zu aktualisieren. |
neutral |
UTC-Zeit im Format JJJJ-MM-DDThh:mm:ssZ. Die Angabe ist nur auf die Minute genau, sodass das Sekundenelement ("ss") immer 00 ist. |
Nicht zutreffend |
ceasedService |
Benachrichtigt den Client darüber, dass der Dienst beendet wurde. |
failure |
Nicht zutreffend |
Nicht zutreffend |
other |
Verwenden Sie diesen Fehlercode für alle anderen Fehler. |
Der Schweregrad wird vom Dienstanbieter angegeben. |
Fehlermeldung |
Empfänger1; Empfänger2;… |
Hinweis
Die userInfo-Zeichenfolge kann diese Fehlercodes enthalten, error-Elemente in einer userInfo-Zeichenfolge besitzen jedoch keine untergeordneten Elemente.
Schema der Übermittlungsantwort
Im folgenden Beispiel wird das Schema einer xmsResponse-Zeichenfolge gezeigt.
<?xml version="1.0" encoding="utf-8"?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" targetNamespace="https://schemas.microsoft.com/office/Outlook/2006/OMS"
xmlns:tns="https://schemas.microsoft.com/office/Outlook/2006/OMS"
xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexType name="tError">
<xs:annotation>
<xs:documentation>
Specify a type for the error reported by the Web service.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="content" type="xs:string" minOccurs="0" >
<xs:annotation>
<xs:documentation>
Descriptions of the error.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="recipientList" type="xs:string" minOccurs="0" >
<xs:annotation>
<xs:documentation>
Recipients that are impacted by the error.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="code" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
Code that represents a predefined error.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="severity" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
Severity of the error. Supported values are "failure" and "neutral".
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="tXmsResponse">
<xs:annotation>
<xs:documentation>
Specify a type for the response from the Web service.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="error" type="tns:tError" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>
Error reported by the Web service.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:element name="xmsResponse" type="tns:tXmsResponse">
<xs:annotation>
<xs:documentation>
Response from the Web service.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:schema>
Referenz zum Nachrichtenbatch
Mit einem Schema für den Nachrichtenbatch wird ein Batch mit Nachrichtendaten angegeben, der an den Webdienst übergeben wird. Dieser Batch mit Nachrichtendaten ist eine packageXml-Zeichenfolge, die als XML formatiert ist und für zahlreiche Mobilfunknachrichten Nachrichteninformationen speichert, einschließlich des Inhalts der Nachricht und der angegebenen Empfänger. Die Zeichenfolge wird als Parameter für die DeliverXmsBatch()-Webdienstmethode verwendet. Die packageXml-Zeichenfolge enthält mehrere untergeordnete xmsData-Elemente. Die Elemente einer xmsData-Zeichenfolge sind in Tabelle 2 weiter vorne in diesem Thema erläutert.
Schema des Nachrichtenbatches
Im folgenden Beispiel wird das Schema einer packageXml-Zeichenfolge gezeigt.
<?xml version="1.0" encoding="utf-8"?>
<xs:schema
targetNamespace="https://schemas.microsoft.com/office/Outlook/2006/OMS"
xmlns:mstns="https://schemas.microsoft.com/office/Outlook/2006/OMS"
xmlns="https://schemas.microsoft.com/office/Outlook/2006/OMS"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:msdata="urn:schemas-microsoft-com:xml-msdata"
attributeFormDefault="qualified" elementFormDefault="qualified">
<xs:element name="xmsBatch" type="tXmsBatch" >
<xs:annotation>
<xs:documentation>
Specify a batch of message data being transferred to the Web service.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="tXmsBatch">
<xs:annotation>
<xs:documentation>
A batch of message data being transferred to the Web service.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="xmsData" type="tXmsData" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>
Message data being transferred to the Web service.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="client" form="unqualified" type="xs:string">
<xs:annotation>
<xs:documentation>
Client information, such as "Microsoft Office Outlook 12.0".
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="tXmsData">
<xs:annotation>
<xs:documentation>
Specify a type for the message data being transferred to the Web service.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="user" type="tUser" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>
User information.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="xmsHead" type="tXmsHeader" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>
Header part of the message data.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="xmsBody" type="tXmsBody" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>
Body part of the message data.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="Id" form="unqualified" type="xs:nonNegativeInteger">
<xs:annotation>
<xs:documentation>
Identification number of message data in a batch.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:schema>
Ausführliche Definitionen von tUser, tXmsHeader und tXmsBody sind im Abschnitt "Nachrichtenschema" weiter vorne in diesem Thema erläutert.
Referenz zum Batch mit Übermittlungsantworten
Übermittlungsantworten sind ein Batch mit Antworten des Webdiensts. Der Batch ist eine xmsResponses-Zeichenfolge, die als XML formatiert ist und von DeliverXmsBatch() zurückgegeben wird, um Erfolg oder Fehler anzuzeigen. Die xmsResponses-Zeichenfolge enthält mehrere untergeordnete xmsResponse-Elemente.
Schema des Batches mit Übermittlungsantworten
Im folgenden Beispiel wird das Schema einer xmsResponses-Zeichenfolge gezeigt.
<?xml version="1.0" encoding="utf-8"?>
<xs:schema
targetNamespace="https://schemas.microsoft.com/office/Outlook/2006/OMS"
xmlns:mstns="https://schemas.microsoft.com/office/Outlook/2006/OMS"
xmlns="https://schemas.microsoft.com/office/Outlook/2006/OMS"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:msdata="urn:schemas-microsoft-com:xml-msdata"
attributeFormDefault="qualified" elementFormDefault="qualified">
<xs:element name="xmsResponses" type="tXmsResponses" >
<xs:annotation>
<xs:documentation>
Specify a batch of responses from the Web service.
</xs:documentation>
</xs:annotation>
</xs:element >
<xs:complexType name="tXmsResponses">
<xs:annotation>
<xs:documentation>
A batch of responses from the Web service.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="xmsResponse" type="tXmsResponse" maxOccurs="unbounded" >
<xs:annotation>
<xs:documentation>
Specify a response message from the Web service.
</xs:documentation>
</xs:annotation>
</xs:element >
</xs:sequence>
</xs:complexType>
<xs:complexType name="tXmsResponse">
<xs:annotation>
<xs:documentation>
Specify a type for the response from the Web service.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="error" type="tError" maxOccurs="unbounded" >
<xs:annotation>
<xs:documentation>
Error reported by the Web service.
</xs:documentation>
</xs:annotation>
</xs:element >
</xs:sequence>
<xs:attribute name="Id" form="unqualified" type="xs:string" >
<xs:annotation>
<xs:documentation>
Identification number of an error in a batch of responses.
</xs:documentation>
</xs:annotation>
</xs:attribute >
</xs:complexType>
</xs:schema>
Die ausführliche Definition von tError ist im Abschnitt "Schema der Übermittlungsantwort" weiter vorne in diesem Thema erläutert.
OMS-Webdienstmethoden
Von einem OMS-Webdienst müssen vier öffentliche Methoden implementiert werden: GetServiceInfo(), GetUserInfo(), DeliverXms() und DeliverXmsBatch(). Mit GetServiceInfo() kann der OMS-Client Informationen zu einem Webdienst abrufen. Von GetUserInfo() werden Informationen zu einem spezifischen Benutzerkonto zurückgegeben. DeliverXms() wird zum Senden einer Nachricht an mindestens einen Empfänger aufgerufen. DeliverXmsBatch() wird zum Senden zahlreicher Nachrichten in einer XML-Batchtransaktion an mindestens einen Empfänger aufgerufen. Diese Webmethoden werden im ersten Artikel dieser Serie, Richtlinien für Office 2010 Mobile Service (Teil 1 von 3), ausführlich beschrieben und in Beispielcode verwendet.
WSDL des OMS-Webdiensts
Das folgende Beispiel zeigt die WSDL-Definition (Web Services Description Language) für einen OMS-Webdienst.
<?xml version="1.0" encoding="utf-8"?>
<definitions
xmlns:soap="https://schemas.xmlsoap.org/wsdl/soap/"
xmlns:tm="https://microsoft.com/wsdl/mime/textMatching/"
xmlns:soapenc="https://schemas.xmlsoap.org/soap/encoding/"
xmlns:mime="https://schemas.xmlsoap.org/wsdl/mime/"
xmlns:tns="https://schemas.microsoft.com/office/Outlook/2006/OMS"
xmlns:s="http://www.w3.org/2001/XMLSchema"
xmlns:http="https://schemas.xmlsoap.org/wsdl/http/"
targetNamespace="https://schemas.microsoft.com/office/Outlook/2006/OMS"
xmlns="https://schemas.xmlsoap.org/wsdl/">
<types />
<message name="GetUserInfoSoapIn">
<part name="xmsUser" type="s:string" />
</message>
<message name="GetUserInfoSoapOut">
<part name="GetUserInfoResult" type="s:string" />
</message>
<message name="GetServiceInfoSoapIn" />
<message name="GetServiceInfoSoapOut">
<part name="GetServiceInfoResult" type="s:string" />
</message>
<message name="DeliverXmsSoapIn">
<part name="xmsData" type="s:string" />
</message>
<message name="DeliverXmsSoapOut">
<part name="DeliverXmsResult" type="s:string" />
</message>
<message name="DeliverXmsBatchSoapIn">
<part name="packageXml" type="s:string" />
</message>
<message name="DeliverXmsBatchSoapOut">
<part name="DeliverXmsBatchResult" type="s:string" />
</message>
<portType name="OMSServiceSoap">
<operation name="GetUserInfo">
<documentation xmlns:wsdl="https://schemas.xmlsoap.org/wsdl/">
Read user infomation such as mobile number.
</documentation>
<input message="tns:GetUserInfoSoapIn" />
<output message="tns:GetUserInfoSoapOut" />
</operation>
<operation name="GetServiceInfo">
<documentation xmlns:wsdl="https://schemas.xmlsoap.org/wsdl/">
Read service properties.
</documentation>
<input message="tns:GetServiceInfoSoapIn" />
<output message="tns:GetServiceInfoSoapOut" />
</operation>
<operation name="DeliverXms">
<documentation xmlns:wsdl="https://schemas.xmlsoap.org/wsdl/">
Send a text message or multimedia message.
</documentation>
<input message="tns:DeliverXmsSoapIn" />
<output message="tns:DeliverXmsSoapOut" />
</operation>
<operation name="DeliverXmsBatch">
<documentation xmlns:wsdl="https://schemas.xmlsoap.org/wsdl/">
Send a batch of text messages and multimedia messages.
</documentation>
<input message="tns:DeliverXmsBatchSoapIn" />
<output message="tns:DeliverXmsBatchSoapOut" />
</operation>
</portType>
<binding name="OMSServiceSoap" type="tns:OMSServiceSoap">
<soap:binding transport="https://schemas.xmlsoap.org/soap/http" />
<operation name="GetUserInfo">
<soap:operation soapAction="https://schemas.microsoft.com/office/Outlook/2006/OMS/GetUserInfo"
style="rpc" />
<input>
<soap:body use="encoded" encodingStyle="https://schemas.xmlsoap.org/soap/encoding/"
namespace="https://schemas.microsoft.com/office/Outlook/2006/OMS" />
</input>
<output>
<soap:body use="encoded" encodingStyle="https://schemas.xmlsoap.org/soap/encoding/"
namespace="https://schemas.microsoft.com/office/Outlook/2006/OMS" />
</output>
</operation>
<operation name="GetServiceInfo">
<soap:operation soapAction="https://schemas.microsoft.com/office/Outlook/2006/OMS/GetServiceInfo"
style="rpc" />
<input>
<soap:body use="encoded" encodingStyle="https://schemas.xmlsoap.org/soap/encoding/"
namespace="https://schemas.microsoft.com/office/Outlook/2006/OMS" />
</input>
<output>
<soap:body use="encoded" encodingStyle="https://schemas.xmlsoap.org/soap/encoding/"
namespace="https://schemas.microsoft.com/office/Outlook/2006/OMS" />
</output>
</operation>
<operation name="DeliverXms">
<soap:operation soapAction="https://schemas.microsoft.com/office/Outlook/2006/OMS/DeliverXms"
style="rpc" />
<input>
<soap:body use="encoded" encodingStyle="https://schemas.xmlsoap.org/soap/encoding/"
namespace="https://schemas.microsoft.com/office/Outlook/2006/OMS" />
</input>
<output>
<soap:body use="encoded" encodingStyle="https://schemas.xmlsoap.org/soap/encoding/"
namespace="https://schemas.microsoft.com/office/Outlook/2006/OMS" />
</output>
</operation>
<operation name="DeliverXmsBatch">
<soap:operation soapAction="https://schemas.microsoft.com/office/Outlook/2006/OMS/DeliverXmsBatch" style="rpc" />
<input>
<soap:body use="encoded" encodingStyle="https://schemas.xmlsoap.org/soap/encoding/"
namespace="https://schemas.microsoft.com/office/Outlook/2006/OMS" />
</input>
<output>
<soap:body use="encoded" encodingStyle="https://schemas.xmlsoap.org/soap/encoding/"
namespace="https://schemas.microsoft.com/office/Outlook/2006/OMS" />
</output>
</operation>
</binding>
<service name="OMSService">
<port name="OMSServiceSoap" binding="tns:OMSServiceSoap">
<soap:address location="https://localhost/OMSWS30/Service.asmx" />
</port>
</service>
</definitions>
Schlussbemerkung
In diesem Artikel werden die XML-Schemas definiert und erläutert, die von OMS-Webdiensten und Clients verwendet werden, und es wird die WSDL-Definition des OMS-Webdiensts bereitgestellt. Codebeispiele und Informationen zum Nachrichtenfluss zwischen den OMS-Webdienstanbietern und Clients finden Sie unter Richtlinien für Office 2010 Mobile Service (Teil 1 von 3). Empfehlungen zur Implementierung eines OMS-Webdiensts finden Sie unter Richtlinien für Office 2010 Mobile Service (Teil 2 von 3). Informationen zum OMS-Protokoll finden Sie unter Office Mobile Service Protocol Specification.
Weitere Ressourcen
Weitere Informationen finden Sie in den folgenden Ressourcen: