MS Oms

[MS-OMS]: Office Mobile Service Protocol Specification
Intellectual Property Rights Notice for Open Specifications Documentation Technical Documentation. Microsoft publishes Open Specifications documentation for protocols, file formats, languages, standards as well as overviews of the interaction among each of these technologies.
Trademarks. The names of companies and products contained in this documentation may be covered by trademarks or similar intellectual property rights. This notice does not grant any licenses under those rights. Fictitious Names. The example companies, organizations, products, domain names, e-mail addresses, logos, people, places, and events depicted in this documentation are fictitious. No association with any real company, organization, product, domain name, email address, logo, person, place, or event is intended or should be inferred.
Pr e
Reservation of Rights. All other rights are reserved, and this notice does not grant any rights other than specifically described above, whether by implication, estoppel, or otherwise. Tools. The Open Specifications do not require the use of Microsoft programming tools or programming environments in order for you to develop an implementation. If you have access to Microsoft programming tools and environments you are free to take advantage of them. Certain Open Specifications are intended for use in conjunction with publicly available standard specifications and network programming art, and assumes that the reader either is familiar with the aforementioned material or has immediate access to it. Preliminary Documentation. This Open Specification provides documentation for past and current releases and/or for the pre-release (beta) version of this technology. This Open Specification is final
lim
Patents. Microsoft has patents that may cover your implementations of the technologies described in the Open Specifications. Neither this notice nor Microsoft's delivery of the documentation grants any licenses under those or any other Microsoft patents. However, a given Open Specification may be covered by Microsoft Open Specification Promise or the Community Promise. If you would prefer a written license, or if the technologies described in the Open Specifications are not covered by the Open Specifications Promise or Community Promise, as applicable, patent licenses are available by contacting [email protected].
in
No Trade Secrets. Microsoft does not claim any trade secret rights in this documentation.
[MS-OMS] v20120122 Office Mobile Service Protocol Specification Copyright 2012 Microsoft Corporation. Release: Sunday, January 22, 2012
ar
1 / 71
Copyrights. This documentation is covered by Microsoft copyrights. Regardless of any other terms that are contained in the terms of use for the Microsoft website that hosts this documentation, you may make copies of it in order to develop implementations of the technologies described in the Open Specifications and may distribute portions of it in your implementations using these technologies or your documentation as necessary to properly document the implementation. You may also distribute in your implementation, with or without modification, any schema, IDLs, or code samples that are included in the documentation. This permission also applies to any documents that are referenced in the Open Specifications.
documentation for past or current releases as specifically noted in the document, as applicable; it is preliminary documentation for the pre-release (beta) versions. Microsoft will release final documentation in connection with the commercial release of the updated or new version of this technology. As the documentation may change between this preliminary version and the final version of this technology, there are risks in relying on preliminary documentation. To the extent that you incur additional development obligations or any other costs as a result of relying on this preliminary documentation, you do so at your own risk.
Date 07/13/2009 08/28/2009 11/06/2009 02/19/2010 03/31/2010 04/30/2010 06/07/2010 06/29/2010 07/23/2010 09/27/2010 11/15/2010 12/17/2010 03/18/2011 06/10/2011 01/20/2012
Revision History 0.1 0.2 0.3 1.0 1.01 1.02 1.03 1.04 1.05 1.05 1.05 1.05 1.05 1.05 2.0
Revision Class Major Editorial Editorial Editorial Editorial Editorial Editorial Editorial Major
Comments Initial Availability
Revised and edited the technical content Revised and edited the technical content Revised and edited the technical content Revised and edited the technical content Revised and edited the technical content Revised and edited the technical content
Pr e
Release: Sunday, January 22, 2012
lim
No change No change No change No change No change Major
in
Changed language and formatting in the technical content. Significantly changed the technical content. No changes to the meaning, language, or formatting of the technical content. No changes to the meaning, language, or formatting of the technical content. No changes to the meaning, language, or formatting of the technical content. No changes to the meaning, language, or formatting of the technical content. No changes to the meaning, language, or formatting of the technical content. Significantly changed the technical content.
[MS-OMS] v20120122 Office Mobile Service Protocol Specification Copyright 2012 Microsoft Corporation.
ar
2 / 71
Revision Summary
Table of Contents
1 Introduction ............................................................................................................. 7 1.1 Glossary ............................................................................................................... 7 1.2 References ............................................................................................................ 7 1.2.1 Normative References ....................................................................................... 8 1.2.2 Informative References ..................................................................................... 8 1.3 Protocol Overview (Synopsis) .................................................................................. 9 1.3.1 Roles .............................................................................................................. 9 1.3.1.1 Protocol Server........................................................................................... 9 1.3.1.2 Protocol Clients .......................................................................................... 9 1.3.2 Scenarios ........................................................................................................ 9 1.3.2.1 Obtaining Information from the Protocol Server .............................................. 9 1.3.2.2 Obtaining Information from an Authenticated User ....................................... 10 1.3.2.3 Data Communication ................................................................................. 10 1.4 Relationship to Other Protocols .............................................................................. 10 1.5 Prerequisites/Preconditions ................................................................................... 11 1.6 Applicability Statement ......................................................................................... 11 1.7 Versioning and Capability Negotiation..................................................................... 11 1.8 Vendor-Extensible Fields ....................................................................................... 11 1.9 Standards Assignments ........................................................................................ 11
Pr e
lim
in
Messages................................................................................................................ 12 2.1 Transport............................................................................................................ 12 2.2 Common Message Syntax ..................................................................................... 12 2.2.1 Namespaces .................................................................................................. 12 2.2.2 Messages ...................................................................................................... 12 2.2.2.1 Mobile message packaged as MIME formatted e-mail message ....................... 13 2.2.2.1.1 Message Headers ................................................................................ 13 2.2.2.1.1.1 Content-Class ............................................................................... 13 2.2.2.1.1.2 X-MS-Reply-To-Mobile.................................................................... 13 2.2.2.1.1.3 To ............................................................................................... 13 2.2.2.1.1.4 From ............................................................................................ 13 2.2.2.1.1.5 Subject ........................................................................................ 13 2.2.2.1.2 Message Body ..................................................................................... 14 2.2.2.1.2.1 Incoming Text Message .................................................................. 14 2.2.2.1.2.2 Incoming Multimedia Message ......................................................... 14 2.2.3 Elements ....................................................................................................... 14 2.2.4 Complex Types .............................................................................................. 14 2.2.4.1 tAudio ..................................................................................................... 15 2.2.4.2 tBody ...................................................................................................... 15 2.2.4.3 tContent .................................................................................................. 16 2.2.4.4 tDeliveryError .......................................................................................... 16 2.2.4.5 tHeader ................................................................................................... 19 2.2.4.6 tImg ....................................................................................................... 19 2.2.4.7 tLayout ................................................................................................... 20 2.2.4.8 tMeta ...................................................................................................... 20 2.2.4.9 tMmsSlides .............................................................................................. 20 2.2.4.10 tPar....................................................................................................... 21 2.2.4.11 tRegion.................................................................................................. 21 2.2.4.12 tRoot-layout ........................................................................................... 21 2.2.4.13 tText ..................................................................................................... 22
ar
3 / 71
Pr e
lim
in
ar
4 / 71
Protocol Details ...................................................................................................... 27 3.1 Server Details ..................................................................................................... 27 3.1.1 Abstract Data Model ....................................................................................... 27 3.1.2 Timers .......................................................................................................... 27 3.1.3 Initialization .................................................................................................. 27 3.1.4 Message Processing Events and Sequencing Rules .............................................. 28 3.1.4.1 GetServiceInfo ......................................................................................... 28 3.1.4.1.1 Messages ........................................................................................... 28 3.1.4.1.1.1 GetServiceInfoSoapIn .................................................................... 28 3.1.4.1.1.2 GetServiceInfoSoapOut .................................................................. 29 3.1.4.1.2 Elements ............................................................................................ 29 3.1.4.1.2.1 GetServiceInfo .............................................................................. 29 3.1.4.1.2.2 GetServiceInfoResponse ................................................................. 29 3.1.4.1.2.3 serviceInfo ................................................................................... 30 3.1.4.1.3 Complex Types ................................................................................... 30 3.1.4.1.3.1 tServiceInfo .................................................................................. 30 3.1.4.1.3.2 tSupportedService ......................................................................... 31 3.1.4.1.3.3 tSMS_SENDER .............................................................................. 31 3.1.4.1.3.4 tLONG_SMS_SENDER ..................................................................... 32 3.1.4.1.3.5 tMMS_SENDER .............................................................................. 32 3.1.4.1.4 Simple Types ...................................................................................... 33 3.1.4.1.4.1 tAuthenticationTypeEnum ............................................................... 33 3.1.4.1.5 Attributes ........................................................................................... 33 3.1.4.1.6 Groups............................................................................................... 33 3.1.4.1.7 Attribute Groups ................................................................................. 34 3.1.4.2 GetUserInfo ............................................................................................. 34 3.1.4.2.1 Messages ........................................................................................... 34 3.1.4.2.1.1 GetUserInfoSoapIn ........................................................................ 34 3.1.4.2.1.2 GetUserInfoSoapOut ...................................................................... 34 3.1.4.2.2 Elements ............................................................................................ 34 3.1.4.2.2.1 GetUserInfo .................................................................................. 35 3.1.4.2.2.2 GetUserInfoResponse ..................................................................... 35 3.1.4.2.2.3 xmsUser ....................................................................................... 35 3.1.4.2.2.4 userInfo ....................................................................................... 35 3.1.4.2.3 Complex Types ................................................................................... 36 3.1.4.2.3.1 tXmsUser ..................................................................................... 36 3.1.4.2.3.1.1 client ...................................................................................... 36 3.1.4.2.3.2 tUserInfo ...................................................................................... 36 3.1.4.2.3.3 tUserError .................................................................................... 37
2.2.4.14 tTo ........................................................................................................ 22 2.2.4.15 tUser ..................................................................................................... 22 2.2.4.16 tXmsBody .............................................................................................. 23 2.2.4.17 tXmsData .............................................................................................. 23 2.2.4.18 tXmsHeader ........................................................................................... 24 2.2.4.19 tXmsResponse ........................................................................................ 24 2.2.5 Simple Types ................................................................................................. 25 2.2.5.1 tRequiredServiceTypeEnum ....................................................................... 25 2.2.6 Attributes ...................................................................................................... 25 2.2.6.1 client ...................................................................................................... 25 2.2.7 Groups .......................................................................................................... 25 2.2.8 Attribute Groups ............................................................................................ 25 2.2.9 Common Data Structures ................................................................................ 26
Pr e
4
3.1.4.2.4 Simple Types ...................................................................................... 37 3.1.4.2.5 Attributes ........................................................................................... 37 3.1.4.2.6 Groups............................................................................................... 37 3.1.4.2.7 Attribute Groups ................................................................................. 37 3.1.4.3 DeliverXms .............................................................................................. 38 3.1.4.3.1 Messages ........................................................................................... 38 3.1.4.3.1.1 DeliverXmsSoapIn ......................................................................... 38 3.1.4.3.1.2 DeliverXmsSoapOut ....................................................................... 38 3.1.4.3.2 Elements ............................................................................................ 38 3.1.4.3.2.1 DeliverXms ................................................................................... 39 3.1.4.3.2.2 DeliverXmsResponse ...................................................................... 39 3.1.4.3.2.3 xmsData ...................................................................................... 39 3.1.4.3.2.4 xmsResponse ................................................................................ 39 3.1.4.3.3 Complex Types ................................................................................... 40 3.1.4.3.4 Simple Types ...................................................................................... 40 3.1.4.3.5 Attributes ........................................................................................... 40 3.1.4.3.6 Groups............................................................................................... 40 3.1.4.3.7 Attribute Groups ................................................................................. 40 3.1.4.4 DeliverXmsBatch ...................................................................................... 40 3.1.4.4.1 Messages ........................................................................................... 40 3.1.4.4.1.1 DeliverXmsBatchSoapIn ................................................................. 41 3.1.4.4.1.2 DeliverXmsBatchSoapOut ............................................................... 41 3.1.4.4.2 Elements ............................................................................................ 41 3.1.4.4.2.1 DeliverXmsBatch ........................................................................... 41 3.1.4.4.2.2 DeliverXmsBatchResponse .............................................................. 42 3.1.4.4.2.3 xmsBatch ..................................................................................... 42 3.1.4.4.2.4 xmsResponses .............................................................................. 42 3.1.4.4.3 Complex Types ................................................................................... 42 3.1.4.4.3.1 tXmsBatch .................................................................................... 43 3.1.4.4.3.2 tXmsDataInBatch .......................................................................... 43 3.1.4.4.3.3 tXmsResponseWithId ..................................................................... 43 3.1.4.4.4 Simple Types ...................................................................................... 44 3.1.4.4.5 Attributes ........................................................................................... 44 3.1.4.4.6 Groups............................................................................................... 44 3.1.4.4.7 Attribute Groups ................................................................................. 44 3.1.4.5 Send reply message to client after collecting them from the recipients phone .. 44 3.1.5 Timer Events ................................................................................................. 44 3.1.6 Other Local Events ......................................................................................... 44 3.2 Client Details....................................................................................................... 44 3.2.1 Abstract Data Model ....................................................................................... 44 3.2.2 Timers .......................................................................................................... 45 3.2.3 Initialization .................................................................................................. 45 3.2.4 Message Processing Events and Sequencing Rules .............................................. 45 3.2.5 Timer Events ................................................................................................. 45 3.2.6 Other Local Events ......................................................................................... 45
Protocol Examples .................................................................................................. 46 4.1 GetServiceInfo .................................................................................................... 46 4.2 GetUserInfo ........................................................................................................ 46 4.3 DeliverXms ......................................................................................................... 47 4.4 DeliverXmsBatch ................................................................................................. 49 4.5 Send Reply Message from Server to Client after Server Collects the Mobile Message from Recipients Phone ........................................................................................ 50
lim
in
ar
5 / 71
Security .................................................................................................................. 52 5.1 Security Considerations for Implementers ............................................................... 52 5.2 Index of Security Parameters ................................................................................ 52 Appendix A: Full WSDL ........................................................................................... 53 Appendix B: Product Behavior ................................................................................ 62 Change Tracking..................................................................................................... 63
6 7 8 9
Pr e
lim
6 / 71
in
ar
Index ..................................................................................................................... 69
Introduction
This document specifies the Office Mobile Service Protocol. This protocol is used to transmit mobile messages between a protocol client and a protocol server. Sections 1.8, 2, and 3 of this specification are normative and contain RFC 2119 language. Sections 1.5 and 1.9 are also normative but cannot contain RFC 2119 language. All other sections and examples in this specification are informative.
1.1
Glossary
The following terms are defined in [MS-OFCGLOS]:
The following terms are specific to this document: Synchronized Multimedia Integration Language (SMIL): An XML-based language that enables a data stream to be divided, transmitted as separate streams, and then recombined as a single stream, as described in [W3C-SMIL3.0].
Pr e
1.2 References
MAY, SHOULD, MUST, SHOULD NOT, MUST NOT: These terms (in all caps) are used as described in [RFC2119]. All statements of optional behavior use either MAY, SHOULD, or SHOULD NOT.
References to Microsoft Open Specification documents do not include a publishing year because links are to the latest version of the documents, which are updated frequently. References to other documents include a publishing year when one is available.
lim
alert Hypertext Markup Language (HTML) Multipurpose Internet Mail Extensions (MIME) Simple Mail Transfer Protocol (SMTP) Simple Object Access Protocol (SOAP) site SOAP action SOAP body SOAP fault Uniform Resource Identifier (URI) Uniform Resource Locator (URL) Web service Web Services Description Language (WSDL) XML fragment XML namespace XML namespace prefix XML schema
in
7 / 71
ar
ASCII authenticated users authentication certificate Hypertext Transfer Protocol over Secure Sockets Layer (HTTPS) language code identifier (LCID)
The following terms are defined in [MS-GLOS]:
1.2.1
Normative References
We conduct frequent surveys of the normative references to assure their continued availability. If you have any issue with finding a normative reference, please contact [email protected]. We will assist you in finding the relevant information. Please check the archive site, http://msdn2.microsoft.com/en-us/library/E4BD6494-06AD-4aed-9823-445E921C9624, as an additional source. [GIF89a] CompuServe Incorporated, "Graphics Interchange Format(sm)", Graphics Interchange Format Programming Reference, July 1990, http://www.w3.org/Graphics/GIF/spec-gif89a.txt
[RFC2616] Fielding, R., Gettys, J., Mogul, J., et al., "Hypertext Transfer Protocol -- HTTP/1.1", RFC 2616, June 1999, http://www.ietf.org/rfc/rfc2616.txt
[RFC5321] Klensin, J., "Simple Mail Transfer Protocol", RFC 5321, October 2008, http://www.rfceditor.org/rfc/rfc5321.txt [SOAP1.1] Box, D., Ehnebuske, D., Kakivaya, G., et al., "Simple Object Access Protocol (SOAP) 1.1", May 2000, http://www.w3.org/TR/2000/NOTE-SOAP-20000508/
[WSDL] Christensen, E., Curbera, F., Meredith, G., and Weerawarana, S., "Web Services Description Language (WSDL) 1.1", W3C Note, March 2001, http://www.w3.org/TR/2001/NOTE-wsdl-20010315 [XMLNS] Bray, T., Hollander, D., Layman, A., et al., Eds., "Namespaces in XML 1.0 (Third Edition)", W3C Recommendation, December 2009, http://www.w3.org/TR/2009/REC-xml-names-20091208/ [XMLSCHEMA1] Thompson, H.S., Ed., Beech, D., Ed., Maloney, M., Ed., and Mendelsohn, N., Ed., "XML Schema Part 1: Structures", W3C Recommendation, May 2001, http://www.w3.org/TR/2001/REC-xmlschema-1-20010502/ [XMLSCHEMA2] Biron, P.V., Ed. and Malhotra, A., Ed., "XML Schema Part 2: Datatypes", W3C Recommendation, May 2001, http://www.w3.org/TR/2001/REC-xmlschema-2-20010502/
1.2.2
[IANA-CharSets] IANA, "Character Sets", Last Updated 2010-11-04, http://www.iana.org/assignments/character-sets [MS-GLOS] Microsoft Corporation, "Windows Protocols Master Glossary". [MS-LCID] Microsoft Corporation, "Windows Language Code Identifier (LCID) Reference". [MS-OFCGLOS] Microsoft Corporation, "Microsoft Office Master Glossary". [SOAP1.2/2] Gudgin, M., Hadley, M., Mendelsohn, N., Moreau, J., and Nielsen, H.F., "SOAP Version 1.2 Part 2: Adjuncts", W3C Recommendation, June 2003, http://www.w3.org/TR/2003/REC-soap12part2-20030624
Pr e
lim
Informative References
in
[SOAP1.2/1] Gudgin, M., Hadley, M., Mendelsohn, N., Moreau, J., and Nielsen, H.F., "SOAP Version 1.2 Part 1: Messaging Framework", W3C Recommendation, June 2003, http://www.w3.org/TR/2003/REC-soap12-part1-20030624
ar
[RFC2818] Rescorla, E., "HTTP Over TLS", RFC 2818, May 2000, http://www.ietf.org/rfc/rfc2818.txt
y
8 / 71
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997, http://www.rfc-editor.org/rfc/rfc2119.txt
1.3
Protocol Overview (Synopsis)
This protocol allows a client to remotely send mobile messages to a server that processes and delivers these messages to a recipients phone. The protocol of data communication from a protocol server to a phone is not in the scope of this document. A typical scenario for using this protocol is a data communication application between software in a computer with a phone. The software, as a protocol client, sends the data as specified in this document to a protocol server, and the protocol server will deliver the data to the phone. The phone can reply to the protocol server and the protocol server delivers the message to the protocol client via SMTP protocol. Another scenario for using this protocol is an alert (2) application sent from software in a computer to a phone. The software, as a protocol client, sends the data as specified in this document to a protocol server, and the protocol server will deliver the data to the phone. Such an application could use this protocol to provide user a notification on the phone when user has no access to the computer or Internet.
1.3.1
Roles
Two roles are always being played whenever this protocol is used. There is always a protocol client issuing request to a protocol server, and there is always a protocol server to receive, process and respond to the requests of protocol clients.
The protocol server implements the Web service described by this protocol. It also maintains the database of authenticated users who can send a valid request to this server, as well as delivers the data sent from these users to the recipients phones according to the request. It also collects the replies from the phones and delivers to the protocol clients accordingly.
1.3.1.2
Protocol Clients
Protocol clients issue commands to the protocol server via the Web service methods described in this protocol. The client is required to implement the message delivery mechanism from client to server. The client can also accept replies to the messages from a server, if two-way communication is required between the client and the recipients phone. If the application does not require a reply (such as an alert application), the client need not implement the interpretation mechanism in receiving the reply message.
1.3.2
Pr e
1.3.2.1
The methods described by this service enable several types of data communication operations.
Protocol clients can send a request to understand what the protocol server can offer. A common usage is for the protocol clients to configure the behavior of itself according to the servers information.
lim
Scenarios
Obtaining Information from the Protocol Server
in
1.3.1.1
Protocol Server
ar
y
9 / 71
Figure 1: Obtaining information from a protocol server
Protocol clients can obtain more detailed information from an authenticated user from the server. A common usage is for the protocol clients to obtain users phone number as the recipient of an alert.
Prior to the initiation of this request, the client is configured with the users authenticated information.
1.3.2.3
Data Communication
Pr e
1.4
Figure 3: Data communication Prior to the initiation of sending messages to server, the client is configured with the users authenticated information.
Relationship to Other Protocols
This protocol uses the SOAP message protocol for formatting request and response messages, as described in [SOAP1.1], [SOAP1.2/1] and [SOAP1.2/2]. It transmits those messages by using HTTPS, as described in [RFC2818].
10 / 71
lim
Protocol clients can initiate communications with the protocol server by sending a SOAP message. The protocol server will send a response to the client. If the protocol server receives a mobile message as a reply, this will be delivered to the protocol client via SMTP.
in
Figure 2: Obtaining information from an authenticated user
ar
1.3.2.2
Obtaining Information from an Authenticated User
The following diagram shows the underlying messaging and transport stack used by the protocol:
Figure 4: This protocol in relation to other protocols
1.5
Prerequisites/Preconditions
The protocol server maintains records of known protocol clients. For each client the server will store the information needed to authenticate messages sent from the client, and the e-mail addresses needed to deliver messages to the client.
1.6
Applicability Statement
1.7
Versioning and Capability Negotiation
None.
1.8
Vendor-Extensible Fields
None.
1.9
Standards Assignments
Pr e
None.
lim
The protocol is designed to allow protocol clients to send mobile messages to the protocol server.
in
This protocol operates against a site (1) that is identified by a URL that is known by protocol clients. The protocol client also knows the users authentication information for sending a request to retrieve user information or deliver message to the server. The protocol requires that SOAP data transferring under HTTPS to protect the users authentication information.
ar
This protocol has no interactions with parallel protocols, nor are there other protocols that substitute for it.
y
11 / 71
Messages
In the following sections, the schema definition might differ from the processing rules imposed by the protocol. The WSDL in this specification matches the WSDL that shipped with the product and provides a base description of the schema. The text that introduces the WSDL might specify differences that reflect actual Microsoft product behavior. For example, the schema definition might allow for an element to be empty, null, or not present but the behavior of the protocol as specified restricts the same elements to being non-empty, present, and not null.
2.1
Transport
Protocol servers MUST support SOAP over HTTPS, as specified in [RFC2818], for securing communication with clients.
The replies of mobile messages sent from protocol servers to protocol clients MUST be transmitted using Simple Mail Transfer Protocol (SMTP), as specified in [RFC5321].
2.2
Common Message Syntax
This section contains common definitions that are used by this protocol. The syntax of the definitions uses XML schema, as specified in [XMLSCHEMA1] and [XMLSCHEMA2], and WSDL, as specified in [WSDL].
2.2.1
Namespaces
Prefix soap tns s
lim
Namespace URI http://www.w3.org/2001/XMLSchema http://schemas.xmlsoap.org/wsdl/
This specification defines and references various XML namespaces using the mechanisms specified in [XMLNS]. Although this specification associates a specific XML namespace prefix for each XML namespace that is used, the choice of any particular XML namespace prefix is implementationspecific and not significant for interoperability.
Reference [WSDL]
http://schemas.xmlsoap.org/wsdl/soap/ http://schemas.microsoft.com/office/Outlook/2006/OMS
in
Pr e
(none) wsdl
soap12
http://schemas.xmlsoap.org/wsdl/soap12/ http://schemas.microsoft.com/office/Outlook/2006/OMS
2.2.2
Messages
The WSDL message definitions are specified in their respective operations in the section 3.1.
ar
[WSDL] [WSDL] [WSDL]
Protocol messages, including service discovery and mobile messages from protocol client to protocol server MUST be formatted as specified either in [SOAP1.1] section 4 or in [SOAP1.2/1] section 5. Protocol server faults MUST be returned either using HTTP status codes as specified in [RFC2616] section 10 or using SOAP faults as specified either in [SOAP1.1] section 4.4 or in [SOAP1.2/1] section 5.4.
y
12 / 71
The following message definition is applied to the reply messages sent from server to client after the server collects this reply message from the recipients phone.
2.2.2.1
Mobile message packaged as MIME formatted e-mail message
The following sections describe the structure of mobile messages packaged as Multipurpose Internet Mail Extensions (MIME) formatted e-mail messages.
2.2.2.1.1
Message Headers
2.2.2.1.1.1
Content-Class
Text message content class: MS-OMS-SMS Use this if the mobile message is a text message.
Multimedia message content class: MS-OMS-MMS
Use this if the mobile message is a multimedia message.
2.2.2.1.1.2
X-MS-Reply-To-Mobile
Adds the following header specifically for conveying the recipients mobile number: X-MS-Reply-To-Mobile: The value of this header SHOULD be a valid mobile phone number.
The value of the To field is an e-mail address provided by the authenticated user for receiving incoming mobile messages.
2.2.2.1.1.4
The value of the From field is the e-mail address that is used for sending the reply. The server is required to provide a unique SMTP address to the mobile recipient for sending back replies.
2.2.2.1.1.5
Pr e
If the reply e-mail message is for an incoming text message, the value of the Subject field MUST be either the first 40 characters of the text message body or the first line of the text message (if there are multiple lines in the message body). If the reply e-mail message is for an incoming multimedia message, the server MUST set the subject of the e-mail message as the subject of the multimedia message. The subject of the MMS message SHOULD remind users to view the message content by opening the message as shown in the following example: Subject of MMS Message (open the message to view content).
lim
From Subject
2.2.2.1.1.3
To
in
ar
13 / 71
Sets the message header "Content-class" to one of following values:
When encoding a reply into an e-mail message, set SMTP headers as described in the following sections so that the client can properly recognize the incoming e-mail messages as coming from a mobile phone.
2.2.2.1.2
Message Body Incoming Text Message
2.2.2.1.2.1
To compose the message body for an incoming text message, the server MUST create a plain text MIME part for the text message content by adding the following headers: Content-Type: text/plain; charset=xxxx Content-Transfer-Encoding: quoted-printable
2.2.2.1.2.2
Incoming Multimedia Message
When composing the message body for incoming multimedia messages, the server MUST encode multimedia messages as MIME-formatted SMTP mails. If SMIL is available, the server MUST compose the MIME body as multipart/related: Content-Type: multipart/related; type="application/smil"; The first MIME part of the SMIL file MUST be as follows:
Content-Type: application/smil; name="mmspresent.smil"
Media parts of the MMS message MUST be encoded as MIME parts with corresponding media types following the SMIL file. If SMIL is not available, the server MUST compose the MIME body as multipart/mixed:
The server MUST encode media parts of the multimedia message as MIME parts with the corresponding media types.
2.2.3
This specification does not define any common XML schema element definitions.
2.2.4
Pr e
Complex type tAudio tBody tContent tDeliveryError
The following table summarizes the set of common XML schema complex type definitions defined by this specification. XML schema complex type definitions that are specific to a particular operation are described with the operation.
Description Base64 encoded audio object. Body part of SMIL. Content of the xmsBody. Indicates the success or failure of the attempt to send this message to the intended
lim
Elements Complex Types
Content-type: multipart/mixed
in
ar
14 / 71
Examples of valid charset values are "us-ascii" (ASCII) and "gb2312" (Simplified Chinese). The server can also use multipart/alternative content type and provide a HTML view of the message body. A reference of valid charset values can be found in [IANA-CharSets].
Complex type
Description recipient.
tHeader tImg tLayout tMeta tMmsSlides tPar tRegion tRoot-layout tText tTo tUser tXmsBody tXmsData tXmsHeader tXmsResponse
Header part of SMIL. Base64 encoded image object. Layout part of SMIL. Metadata indicating the author of the SMIL.
Specifies multimedia messages slides. Specifies the region of the text or image.
Plain text object.
One or more recipients of this mobile message.
The user information of the sender of this mobile message. Content body of this mobile message. Content of mobile message.
Header information of this mobile message.
This complex type contains one or more error elements that indicate the success or failure of the attempt to send this message to the intended recipient.
Base64 encoded audio object.
<xs:complexType name="tAudio"> <xs:attribute name="src" type="xs:string" use="required" /> </xs:complexType>
src: An identifier that refers to the contentId attribute of the content element.
2.2.4.2
Pr e
Body part of SMIL.
<xs:complexType name="tBody"> <xs:sequence> <xs:element name="par" type="tns:tPar" maxOccurs="unbounded" /> </xs:sequence> </xs:complexType>
par: Multiple occurrences. Specifies multimedia message slides; MUST be an XML fragment that conforms to the XML schema of the tPar complex type.
lim
tBody
2.2.4.1
tAudio
in
ar
15 / 71
Specifies phone screen resolution, in pixels, and background color.
The presentation description part for multimedia messages.
2.2.4.3
tContent
Content of the xmsBody.

<xs:complexType name="tContent"> <xs:simpleContent> <xs:extension base="xs:string"> <xs:attribute name="contentType" type="xs:string" use="required" /> <xs:attribute name="contentId" type="xs:string" use="required" /> <xs:attribute name="contentLocation" type="xs:string" use="required" /> </xs:extension> </xs:simpleContent> </xs:complexType>
contentType: MIME content type.
Content Text Static image. Multi-frame image. MIDI audio format.
MIME type text/plain image/jpeg
Description
Plain text. Can be used by both text and multimedia messages.
image/gif
[GIF89a], 96 DPI, maximum of 256 colors. Smaller or equal to the mobile screen size defined in the root-layout element of the xmsData string. Base64 encoded. Only applies to multimedia messages. MIDI format. Base64 encoded. Only applies to multimedia messages. AMR format, single channel, 8K Hz. Base64 encoded. Only applies to multimedia messages.
audio/mid audio/AMR
AMR sound format.
contentId: Content identifier referred in SMIL body part. The server MUST ignore it for text message and non-slide mode multimedia message. contentLocation: Indicates the file name of a media object, which can be used as the default file name when the object is saved.
2.2.4.4
Pr e
Indicates the success or failure of the attempt to send this message to the intended recipient.
<xs:complexType name="tDeliveryError"> <xs:sequence> <xs:element name="content" type="xs:string" minOccurs="0" /> <xs:element name="recipientList" type="xs:string" minOccurs="0" /> </xs:sequence> <xs:attribute name="code" type="xs:string" use="required" /> <xs:attribute name="severity" type="xs:string" use="required" /> </xs:complexType>
lim
tDeliveryError
in
96 DPI. Smaller, or equal to, the mobile screen size defined in the rootlayout element of the xmsData string. Base64 encoded. Only applies to multimedia messages.
ar
16 / 71
Addition to the content, text messages support the "text/plain" content type. The media objects listed in following table for multimedia messages are supported.
The error element has two child elements: content, which is a string containing a description or parameters of the error, and recipientList, which is a string containing a semi-colondelimited list of recipients that are affected by the error. At most, one content element and one recipientList element can be defined for each error element. The absence of a recipientList element means that the error applies to all recipients. Each error code has two required attributes: code and severity. The possible values are as follows: When either a complete and successful send, or the service is sending a non-error message to the client:
Severity: The "neutral" value MUST be set. When the message has not been delivered to one or more recipients:
Code: The error code MUST be set follow the different situations in the following table or define its own protocol. Severity: The "failure" value MUST be set.
Value of code attribute invalidUser unregisteredUser
Explanation Invalid or unrecognized user identifier or password.
User has not registered for the service. The service provider returns "invalidUser" if it cannot make the judgment based on the user identifier. User has not subscribed to the service listed in the content element. Users prepayment is used up or the registration is expired. The error code is for the service provider who provides prepaid service.
in
Not applicable "SMS" or "MMS" Not applicable Not applicable Not applicable Not applicable
unregisteredService
lim
One or more recipients are from a carrier that is not supported by the senders carrier. Returns semicolon delimited recipients in the <recipientList> element.
expiredUser
invalidRecipient
Pr e
crossCarrier invalidChar
One or more recipients are not valid or not recognized. Returns semicolon delimited recipients in the recipientList element.
Message subject or body contains characters or words
ar
content child element Not applicable recipientList child element Not applicable Not applicable Not applicable Not applicable Recipient1; Recipient2; Recipient1; Recipient2; Not applicable
y
17 / 71
Code: The "ok" value MUST be set.
Value of code attribute
Explanation that are not allowed by local policy or not supported by the service provider.
content child element
recipientList child element
invalidMedia
Invalid or unsupported media. Returns content IDs of invalid media in the content element. (Attribute only applies to MMS messages). Exceeded limit on the number of messages a user can send per day. Returns the limit number in the content element. Exceeded limit on the number of messages a user can send per month. Returns the limit number in the content element. Exceeded length limit of SMS message. Returns maximum length limits for single byte messages and double byte messages in the content element. Exceeded size limit of MMS message.
location1; location2
Not applicable
perDayMsgLimit
Limit on number of messages per day in the form: "# SMS" or "# MMS"
perMonthMsgLimit
lengthLimit
sizeLimit slidesLimit
in
Not applicable Not applicable Not applicable Not applicable
invalidFormat
lim
Exceeded limit on number of slides an MMS message can have. Invalid or unrecognized XMS data format.
serviceNetwork
Service-side network problem, for example, unable to connect to short message service center (SMSC). Scheduled send is not supported. The message was sent immediately. Users account balance is low. Returns current balance and cost per message in the content element.
noScheduled
Pr e
lowBalance ceasedService
Notifies client that the service is terminated.
ar
Limit on number of messages per month in the form: "# SMS" or "# MMS" Recipient1; Recipient2; DB or mixed limit; SB limit Not applicable Maximum size allowed (in bytes) of MMS messages Maximum number of slides allowed per MMS message Not applicable Not applicable Not applicable Recipient1; Recipient2; Not applicable Returns current balance and cost per message separated by semi-colons (use currency symbol before each number). For example, "$5.00;$0.10" Recipient1; Recipient2; Not applicable 18 / 71
y
Recipient1; Recipient2;
Value of code attribute other
Explanation Use this error code for all other errors.
content child element Error message
recipientList child element Recipient1; Recipient2;
When the server information or service properties are changed, the server SHOULD return the following xmsResponse element: Code: The "serviceUpdate" value MUST be set.
Content: UTC time in format of YYYY-MM-DDThh:mm:ssZ MUST be set. Second part ("ss") MUST be "00" and the accuracy is at minute level. The following are notes on the use of the tDeliveryError type and Severity attribute:
If the error element is not included in an xmsResponse string, the client assumes that a failure error occurred. If the error element without the code attribute is included in an xmsResponse string, the client assumes that an unknown failure error occurred. If the error element without the severity attribute is included in an xmsResponse string, the client assumes that the severity is "neutral."
If multiple error codes are returned, the error that has the highest severity attribute ("failure" is higher than "neutral") decides whether the client generates a Non-delivery Report (NDR) and sends it to the user. If there are one or more "failure" errors, the OMS client generates an NDR letting the user know that the message has not been delivered.
Header part of SMIL.
<xs:complexType name="tHeader"> <xs:sequence> <xs:element name="meta" type="tns:tMeta" minOccurs="0" /> <xs:element name="layout" type="tns:tLayout" /> </xs:sequence> </xs:complexType>
meta: Metadata indicating the author of the SMIL; MUST be an XML fragment that conforms to the XML schema of the tMeta complex type. layout: Layout part of SMIL; MUST be an XML fragment that conforms to the XML schema of the tLayout complex type.
Pr e
2.2.4.6 tImg
Base64 encoded image object.

<xs:complexType name="tImg"> <xs:attribute name="src" type="xs:string" use="required" />
lim
2.2.4.5
tHeader
in
ar
y
19 / 71
Severity: The "neutral" value MUST be set.
<xs:attribute name="region" type="xs:string" use="required" /> </xs:complexType>
src: An identifier that refers to the contentId attribute of the content element. region: Region for displaying the image. It has the same value as the id attribute of the tRegion which is a child of the tLayout complex type. The value could be "Image" or "Text".
2.2.4.7
tLayout
root-layout: Specifies phone screen resolution, in pixels, and background color. MUST be an XML fragment that conforms to the XML schema of the tRoot-layout complex type. region: Specifies the region of the text or image. MUST be an XML fragment that conforms to the XML schema of the tRegion complex type.
2.2.4.8
tMeta
Metadata indicating the author of the SMIL.
name: The server MUST ignore this value.
content: The server MUST ignore this value.
2.2.4.9
The presentation description part for multimedia messages.

<xs:complexType name="tMmsSlides"> <xs:sequence> <xs:element name="head" type="tns:tHeader" minOccurs="0" /> <xs:element name="body" type="tns:tBody" /> </xs:sequence> </xs:complexType>
Pr e
head: Header part of SMIL; MUST be an XML fragment that conforms to the XML schema of the tHeader complex type.
lim
tMmsSlides
<xs:complexType name="tMeta"> <xs:attribute name="name" type="xs:string" use="required" /> <xs:attribute name="content" type="xs:string" use="required" /> </xs:complexType>
in
ar
20 / 71
<xs:complexType name="tLayout"> <xs:sequence> <xs:element name="root-layout" type="tns:tRoot-layout" /> <xs:element name="region" type="tns:tRegion" maxOccurs="2" /> </xs:sequence> </xs:complexType>
Layout part of SMIL.
body: Body part of SMIL; MUST be an XML fragment that conforms to the XML schema of the tBody complex type.
2.2.4.10
tPar
Specifies the slide of the multimedia message.

<xs:complexType name="tPar"> <xs:sequence> <xs:element name="img" type="tns:tImg" minOccurs="0" /> <xs:element name="text" type="tns:tText" minOccurs="0" /> <xs:element name="audio" type="tns:tAudio" minOccurs="0" /> </xs:sequence> <xs:attribute name="dur" type="xs:string" use="required" /> </xs:complexType>
img: Base64 encoded image object; MUST be an XML fragment that conforms to the XML schema of the tImg complex type. text: Plain text object; MUST be an XML fragment that conforms to the XML schema of the tText complex type.
audio: Base64 encoded audio object; MUST be an XML fragment that conforms to the XML schema of the tAudio complex type. dur: Specifies duration in milliseconds that the slide will be played.
2.2.4.11
tRegion
Specifies the region of the text or image.
id: MUST be either "Image" or "Text" indicating the type of region being defined. left: Specifies the left position, in pixels, of the region relative to the left edge of the phone screen. top: Specifies the top position, in pixels, of the region relative to the top edge of the phone screen. width: Specifies the width of the region, in pixels. height: Specifies the height of the region, in pixels.
Pr e
2.2.4.12 tRoot-layout
Specifies phone screen resolution, in pixels, and background color.

<xs:complexType name="tRoot-layout"> <xs:attribute name="width" type="xs:unsignedInt" use="required" />
lim
<xs:complexType name="tRegion"> <xs:attribute name="id" type="xs:string" use="required" /> <xs:attribute name="left" type="xs:unsignedInt" use="required" /> <xs:attribute name="top" type="xs:unsignedInt" use="required" /> <xs:attribute name="width" type="xs:unsignedInt" use="required" /> <xs:attribute name="height" type="xs:unsignedInt" use="required" /> </xs:complexType>
in
ar
y
21 / 71
<xs:attribute name="height" type="xs:unsignedByte" use="required" /> <xs:attribute name="background-color" type="xs:string" use="required" /> </xs:complexType>
width: Phone screens width in pixels. height: Phone screens height in pixels. background-color: The background color of slides. The background color is a RGB color encoded as a string with format "#RRGGBB". Each of RR, GG, and BB is a hexadecimal encoded number ranging from 00 for 0 to "FF" for 255. RR represents the red value. GG represents the green value. BB represents the blue value.
2.2.4.13
tText
<xs:complexType name="tText"> <xs:attribute name="src" type="xs:string" use="required" /> <xs:attribute name="region" type="xs:string" use="required" /> <xs:attribute name="foreground-color" type="xs:string" use="optional" /> </xs:complexType>
region: Region for displaying the text. It has the same value as the id attribute of the tRegion, which is a child of tLayout complex type. The value could be "Image" or "Text". foreground-color: Foreground color of the text. The foreground color is an RGB color encoded as a string with format "#RRGGBB". Each of RR, GG and BB is a hexadecimal encoded number ranging from "00" for 0 to "FF" for 255. RR represents the red value, GG represents the green value, and BB represents the blue value.
2.2.4.14
One or more recipients of this mobile message.
<xs:complexType name="tTo"> <xs:sequence> <xs:element maxOccurs="unbounded" name="recipient" type="xs:string" /> </xs:sequence> </xs:complexType>
Pr e
2.2.4.15 tUser
recipient: Multiple occurrences. Refers to the recipients mobile phone number (address). At least one recipient is required.
The user information of the sender of this mobile message.

<xs:complexType name="tUser"> <xs:sequence> <xs:element name="userId" type="xs:string" minOccurs="0" />
lim
tTo
in
src: An identifier that refers to the contentId attribute of the content element.
ar
22 / 71
Plain text object.
<xs:element name="password" type="xs:string" minOccurs="0" /> <xs:element name="replyPhone" type="xs:string" minOccurs="0" /> <xs:element name="customData" type="xs:string" minOccurs="0" /> </xs:sequence> </xs:complexType>
userId: User's identification of the sender. password: User's password of the sender.
customData: Protocol server MUST ignore this value.
Content body of this mobile message.
mmsSlides: The presentation description part for multimedia messages; MUST be an XML fragment that conforms to the XML schema of the tMmsSlides complex type. Content: Represents one of the following:
The text messages, if format attribute of xmsBody is "SMS". Multiple content elements are possible for text message with each element representing a division of a longer message. The server MUST deliver each of the elements as individual text messages in sequence. Text, image, or audio object for a slide if format attribute of xmsBody is "MMS" and SMIL part is available (slide mode). Page of text, image, or audio object of multimedia message, if format attribute of xmsBody is "MMS" and SMIL part is not available (non-slide mode). MUST be an XML fragment that conforms to the XML schema of the tContent complex type. format: Specifies the format or type of the xmsBody element. It MUST be "SMS" for a text message or "MMS" for a multimedia message.
Pr e
2.2.4.17 tXmsData
Content of a mobile message.

<xs:complexType name="tXmsData"> <xs:sequence> <xs:element name="user" type="tns:tUser" minOccurs="0" /> <xs:element name="xmsHead" type="tns:tXmsHeader" minOccurs="0" />
lim
in
<xs:complexType name="tXmsBody"> <xs:sequence> <xs:element name="mmsSlides" type="tns:tMmsSlides" minOccurs="0" /> <xs:element name="content" type="tns:tContent" maxOccurs="unbounded" /> </xs:sequence> <xs:attribute name="format" type="xs:string" use="required" /> </xs:complexType>
ar
23 / 71
2.2.4.16
tXmsBody
replyPhone: Reply number or callback number. Service providers that do not support callback numbers can ignore this element.
<xs:element name="xmsBody" type="tns:tXmsBody" /> </xs:sequence> <xs:attribute name="client" type="xs:string" /> </xs:complexType>
user: The user information of the sender of this mobile message; MUST be an XML fragment that conforms to the XML schema of the tUser complex type. xmsHead: Header information of this mobile message; MUST be an XML fragment that conforms to the XML schema of the tXmsHeader complex type. xmsBody: Content body of this mobile message; MUST be an XML fragment that conforms to the XML schema of the tXmsBody complex type.
2.2.4.18
tXmsHeader
Header information of this mobile message.
requiredService: The delivery service required to delivery this mobile message; MUST be an XML fragment that conforms to the XML schema of the tRequiredServiceTypeEnum simple type. sourceType: Indicates that the message is generated from which type of client, or a specific feature of a client. to: One or more recipients of this mobile message; MUST be an XML fragment that conforms to the XML schema of the tTo complex type. subject: Subject of the message. For a text message, the server MUST ignore the subject. If left unspecified for a multimedia message, the server MAY return error or send the multimedia message out without a subject.
Pr e
2.2.4.19
This complex type contains one or more error elements that indicate the success or failure of the attempt to send this message to the intended recipient.
<xs:complexType name="tXmsResponse"> <xs:sequence> <xs:element name="error" type="tns:tDeliveryError" maxOccurs="unbounded" /> 24 / 71
lim
tXmsResponse
scheduled: Indicates that the message is to be sent at a specified time. UTC time in the format YYYY-MM-DDThh:mm:ssZ. The accuracy is at the minute level, so the second element ("ss") MUST be "00". The server needs to convert the scheduled time to the local time zone. If the specified time is in the past, the message is sent immediately.
in
<xs:complexType name="tXmsHeader"> <xs:sequence> <xs:element name="scheduled" type="xs:dateTime" minOccurs="0" /> <xs:element name="requiredService" type="tns:tRequiredServiceTypeEnum" minOccurs="0" /> <xs:element name="sourceType" type="xs:string" minOccurs="0" /> <xs:element name="to" type="tns:tTo" /> <xs:element name="subject" type="xs:string" minOccurs="0" /> </xs:sequence> </xs:complexType>
ar
</xs:sequence> </xs:complexType>
error: It MUST be an XML fragment that conforms to the XML schema of the tDeliveryError complex type.
2.2.5
Simple Types
Simple type tRequiredServiceTypeEnum
Description
The delivery service required to delivery this mobile message.
2.2.5.1
tRequiredServiceTypeEnum
The delivery service required to delivery this mobile message.

<xs:simpleType name="tRequiredServiceTypeEnum"> <xs:restriction base="xs:string"> <xs:enumeration value="SMS_SENDER" /> <xs:enumeration value="MMS_SENDER" /> </xs:restriction> </xs:simpleType>
SMS_SENDER: Indicates that this message is to be delivered as a text message. MMS_SENDER: Indicates that this message is to be delivered as a multimedia message.
2.2.6
The following table summarizes the set of common XML schema attribute definitions defined by this specification. XML schema attribute definitions that are specific to a particular operation are described with the operation.
Attribute client Description
2.2.6.1
Pr e
2.2.7 Groups 2.2.8 Attribute Groups
This attribute keeps a string of client information.
This specification does not define any common XML schema group definitions.
This specification does not define any common XML schema attribute group definitions.
lim
Attributes client
in
ar
25 / 71
The following table summarizes the set of common XML schema simple type definitions defined by this specification. XML schema simple type definitions that are specific to a particular operation are described with the operation.
2.2.9
Common Data Structures
This specification does not define any common XML schema data structures.
Pr e
lim
26 / 71
in
ar
Protocol Details
In the following sections, the schema definition might differ from the processing rules imposed by the protocol. The WSDL in this specification matches the WSDL that shipped with the product and provides a base description of the schema. The text that introduces the WSDL might specify differences that reflect actual Microsoft product behavior. For example, the schema definition might allow for an element to be empty, null, or not present but the behavior of the protocol as specified restricts the same elements to being non-empty, present, and not null. Except where specified, protocol clients SHOULD interpret HTTP status codes returned by the protocol server as specified in [RFC2616] section 10. This protocol allows protocol servers to notify protocol clients of application-level faults using SOAP faults. Except where specified, these SOAP faults are not significant for interoperability, and protocol clients can interpret them in an implementation-specific manner.
3.1
Server Details Abstract Data Model
3.1.1
The protocol server maintains the following states that allow a client to understand how this server accepts or handles the data (which will be text message or multimedia message delivery): Support of delivery of text message, multimedia message, or both. Limitation of text message or multimedia message supported by this server, such as maximum number of recipients. Support of concatenated text message or not. Support for batch mode delivery or not.
The protocol server also maintains a database of users and only the client of the authenticated users can send in XML containing text message or multimedia message to server. In two-way communication application, the server MAY collect the mobile message replied from recipients phone and send it to a client accordingly.
Pr e
3.1.2 Timers
None.
3.1.3
None.
lim
Initialization
in
This section describes a conceptual model of possible data organization that an implementation maintains to participate in this protocol. The described organization is provided to facilitate the explanation of how the protocol behaves. This document does not mandate that implementations adhere to this model as long as their external behavior is consistent with that described in this document.
ar
This protocol allows protocol servers to perform implementation-specific authorization checks and notify protocol clients of authorization faults either using HTTP status codes or using SOAP faults as specified previously in this section.
y
27 / 71
3.1.4
Message Processing Events and Sequencing Rules
The following table summarizes the list of WSDL operations as defined by this specification:
Operation GetServiceInfo GetUserInfo DeliverXms Description Specifies the properties of this Web service. Returns a GetServiceInfoResponse. Specifies the users information. Returns a GetUserInfoResponse. Sends one mobile message to this Web service. Returns a DeliverXmsResponse. The protocol server SHOULD<1> implement a SendXms operation that is the same as the DeliverXms operation. Sends multiple mobile messages in a batch to this Web service. Returns a DeliverXmsBatchResponse.<2>
DeliverXmsBatch
3.1.4.1
GetServiceInfo
Specifies the properties of this Web service.
The client sends a GetServiceInfoSoapIn request message and the server responds with a GetServiceInfoSoapOut response message.
3.1.4.1.1
The following table summarizes the set of WSDL message definitions that are specific to this operation.
Message Description
GetServiceInfoSoapIn
GetServiceInfoSoapOut
Pr e
3.1.4.1.1.1
The message represents the client request for the server information from the server. The SOAP action value of the message is defined as:
http://schemas.microsoft.com/office/Outlook/2006/OMS/GetServiceInfo
lim
Messages GetServiceInfoSoapIn
The GetServiceInfoSoapOut response message contains basic properties of this Web service, such as the information specifies in section 3.1.1.
The request to specify the properties of this Web service. The response to the request to specify the properties of this Web service.
in
<wsdl:operation name="GetServiceInfo"> <wsdl:input message="tns:GetServiceInfoSoapIn" /> <wsdl:output message="tns:GetServiceInfoSoapOut" /> </wsdl:operation>
ar
28 / 71
The server also sends reply message to the client after collecting them from the recipients phone. The server processing rules are specified in section 3.1.4.5.
The SOAP body contains a GetServiceInfo element.
3.1.4.1.1.2
GetServiceInfoSoapOut
The message represents the protocol server response for a client request for the server information. The SOAP action value of the message is defined as:
http://schemas.microsoft.com/office/Outlook/2006/OMS/GetServiceInfo
3.1.4.1.2
Elements
Element GetServiceInfo GetServiceInfoResponse serviceInfo
Description
The request to specify the properties of this Web service.
Contains the response to the request to specify the properties of this Web service.
3.1.4.1.2.1
GetServiceInfo
GetServiceInfo is an empty structure indicating a GetServiceInfo WSDL operation is being requested.

<xs:element name="GetServiceInfo"> <xs:complexType /> </xs:element>
3.1.4.1.2.2
This structure contains the response to a GetServiceInfo WSDL operation.

<xs:element name="GetServiceInfoResponse"> <xs:complexType> <xs:sequence> <xs:element name="GetServiceInfoResult" type="xs:string" /> </xs:sequence> </xs:complexType> </xs:element>
Pr e
GetServiceInfoResult: Information for a protocol server; MUST be an XML fragment that conforms to the XML schema of the serviceInfo element.
lim
GetServiceInfoResponse
in
Information for a protocol server.
ar
29 / 71
The following table summarizes the XML schema element definitions that are specific to this operation.
The SOAP body contains a GetServiceInfoResponse element.
3.1.4.1.2.3
serviceInfo
Information for a protocol server; MUST be an XML fragment that conforms to the XML schema of the tServiceInfo complex type.
<xs:element name="serviceInfo" type="tns:tServiceInfo" />
3.1.4.1.3
Complex Types
Complex type tServiceInfo tSupportedService tSMS_SENDER tLONG_SMS_SENDER tMMS_SENDER
Description Information for a protocol server.
The type of message delivery service this server supports.
The limitations or properties of text message delivery supported by this server. The limitations or properties of concatenated text message delivery supported by this server.
3.1.4.1.3.1
tServiceInfo
Information for a protocol server.
Pr e
serviceProvider: Company name of the service provider hosting this Web service. serviceUri: The Uniform Resource Identifier (URI) of this Web service. signUpPage: URI of sign-up or logon page for the users of this Web service.
targetLocale: Language code identifier (LCID), as described in [MS-LCID]. Used to indicate the country or region for which this Web service is targeted. Default value is zero ("0"), which indicates that this Web service supports users globally.
lim
<xs:complexType name="tServiceInfo"> <xs:sequence> <xs:element name="serviceProvider" type="xs:string" /> <xs:element name="serviceUri" type="xs:string" /> <xs:element name="signUpPage" type="xs:string" /> <xs:element name="targetLocale" type="xs:unsignedShort" minOccurs="0" default="0" /> <xs:element name="localName" type="xs:string" /> <xs:element name="englishName" type="xs:string" /> <xs:element name="authenticationType" type="tns:tAuthenticationTypeEnum" /> <xs:element name="batchSize" type="xs:unsignedInt" minOccurs="0" default="0" /> <xs:element name="supportedService" type="tns:tSupportedService" /> </xs:sequence> </xs:complexType>
in
The limitations or properties of multimedia message delivery supported by this server.
ar
30 / 71
The following table summarizes the XML schema complex type definitions that are specific to this operation.
localName: The name of this Web service in the language preferred by the service provider. englishName: The name of this Web service in English. authenticationType: Indicates the method of authentication (2) supported by this Web service. MUST conform to the XML schema of the tAuthenticationTypeEnum simple type specified in section 3.1.4.1.4.1. batchSize: Indicates the maximum number of mobile messages to be delivered in a single XML. The default value of zero ("0") means that the server cannot deliver multiple messages in a single XML.
3.1.4.1.3.2
tSupportedService
The tSupportedService complex type contains the type of message delivery service this server supports.
<xs:complexType name="tSupportedService"> <xs:sequence minOccurs="1" maxOccurs="2"> <xs:element name="SMS_SENDER" type="tns:tSMS_SENDER" minOccurs="0" /> <xs:element name="MMS_SENDER" type="tns:tMMS_SENDER" minOccurs="0" /> </xs:sequence> </xs:complexType>
SMS_SENDER: Indicates that this server supports text message delivery. It MUST conform to the XML schema of the tSMS_SENDER complex type specified in section 3.1.4.1.3.3. MMS_SENDER: Indicates that this server supports multimedia message delivery. It MUST conform to the XML schema of the tMMS_SENDER complex type specified in section 3.1.4.1.3.5. Both elements here are optional, but at least one of them MUST be supported.
3.1.4.1.3.3
The tSMS_SENDER complex type specifies the limitations or properties of text message delivery supported by this server.
<xs:complexType name="tSMS_SENDER"> <xs:sequence> <xs:element name="LONG_SMS_SENDER" type="tns:tLONG_SMS_SENDER" minOccurs="0" /> </xs:sequence> <xs:attribute name="maxRecipientsPerMessage" type="xs:unsignedInt" use="required" /> <xs:attribute name="maxMessagesPerSend" type="xs:unsignedInt" use="required" /> <xs:attribute name="maxSbcsPerMessage" type="xs:unsignedInt" use="required" /> <xs:attribute name="maxDbcsPerMessage" type="xs:unsignedInt" use="required" /> </xs:complexType>
Pr e
lim
tSMS_SENDER
in
ar
31 / 71
supportedService: The supported message delivery service by this server; MUST conform to the XML schema of the tSupportedService complex type specified in section 3.1.4.1.3.2.
LONG_SMS_SENDER: Indicates that this server supports delivery of concatenated text message. It MUST conform to the XML schema of the tLONG_SMS_SENDER complex type specified in section 3.1.4.1.3.4. maxRecipientsPerMessage: Specifies the maximum number of recipients allowed for delivering a text message. maxMessagesPerSend: Specifies the maximum number of separate text messages allowed in a single xmsData string. xmsData is specified in section 3.1.4.3.2.3. maxSbcsPerMessage: Specifies the maximum number of characters allowed for a text message purely consisting of US ASCII characters.
maxDbcsPerMessage: Specifies the maximum number of characters allowed for a text message containing double byte characters.
The tLONG_SMS_SENDER complex type specifies the limitations or properties of concatenated text message delivery supported by this server.
<xs:complexType name="tLONG_SMS_SENDER"> <xs:attribute name="maxRecipientsPerMessage" type="xs:unsignedInt" use="required" /> <xs:attribute name="maxMessagesPerSend" type="xs:unsignedInt" use="required" /> <xs:attribute name="maxSbcsPerMessage" type="xs:unsignedInt" use="required" /> <xs:attribute name="maxDbcsPerMessage" type="xs:unsignedInt" use="required" /> </xs:complexType>
maxMessagesPerSend: Specifies the maximum number of separate concatenated text messages allowed in a single xmsData string. xmsData is specified in section 3.1.4.3.2.3. maxSbcsPerMessage: Specifies the maximum number of characters allowed for a text message inside a concatenated text message purely consisting of US ASCII characters. maxDbcsPerMessage: Specifies the maximum number of characters allowed for a text message inside a concatenated text message containing double byte characters.
3.1.4.1.3.5
Pr e
The tMMS_SENDER complex type specifies the limitations or properties of multimedia message delivery supported by this server.
<xs:complexType name="tMMS_SENDER"> <xs:attribute name="supportSlide" type="xs:boolean" use="required" /> <xs:attribute name="maxRecipientsPerMessage" type="xs:unsignedInt" use="required" /> <xs:attribute name="maxSizePerMessage" type="xs:unsignedInt" use="required" /> <xs:attribute name="maxSlidesPerMessage" type="xs:unsignedInt"
lim
tMMS_SENDER
maxRecipientsPerMessage: Specifies the maximum number of recipients allowed for delivering a concatenated text message.
in
ar
3.1.4.1.3.4
tLONG_SMS_SENDER
y
32 / 71
use="required" /> </xs:complexType>
supportSlide: Indicates whether Synchronized Multimedia Integration Language (SMIL) is supported in describing presentation of the multimedia message or not. maxRecipientsPerMessage: Specifies the maximum number of recipients allowed for delivering a multimedia message. maxSizePerMessage: Specifies the maximum size, in bytes, of the multimedia message.
3.1.4.1.4
Simple Types
Simple type tAuthenicationTypeEnum
Description
The method of authentication supported by this Web service.
3.1.4.1.4.1
tAuthenticationTypeEnum
Indicates the method of authentication supported by this Web service.

<xs:simpleType name="tAuthenticationTypeEnum"> <xs:restriction base="xs:string"> <xs:enumeration value="passport" /> <xs:enumeration value="fulltrust" /> <xs:enumeration value="other" /> </xs:restriction> </xs:simpleType>
MUST be one of the values described in the following table.

Value Meaning
passport fulltrust other
Pr e
3.1.4.1.5
None.
3.1.4.1.6
None.
lim
Attributes Groups
Users will be authenticated by passport authentication method. Users will be authenticated by certificate (1). No password is required. Users will be authenticated by user name and password.
in
33 / 71
ar
The following table summarizes the XML schema simple type definitions that are specific to this operation.
maxSlidesPerMessage: Specifies the maximum number of slides a multimedia message can have.
3.1.4.1.7
None.
Attribute Groups
3.1.4.2
GetUserInfo
Used to retrieve the information of an authenticated user.

<wsdl:operation name="GetUserInfo"> <wsdl:input message="tns:GetUserInfoSoapIn" /> <wsdl:output message="tns:GetUserInfoSoapOut" /> </wsdl:operation>
3.1.4.2.1
Messages
Message GetUserInfoSoapIn GetUserInfoSoapOut Description
The request to retrieve the information of an authenticated user. The response to a request to retrieve the information of an authenticated user.
3.1.4.2.1.1
GetUserInfoSoapIn
The message represents the client request for the user information from the server. The SOAP action value of the message is defined as:
http://schemas.microsoft.com/office/Outlook/2006/OMS/GetUserInfo
The SOAP body contains a GetUserInfo element.
3.1.4.2.1.2
The message represents the protocol server response for a client request for the user information. The SOAP action value of the message is defined as:
http://schemas.microsoft.com/office/Outlook/2006/OMS/GetUserInfo
Pr e
3.1.4.2.2 Elements
The SOAP body contains a GetUserInfoResponse element.
lim
GetUserInfoSoapOut
in
ar
34 / 71
The client sends a GetUserInfoSoapIn request message, which contains the authentication information for a user, and the server responds with a GetUserInfoSoapOut response message, which contains the information of this authenticated user.
Element GetUserInfo GetUserInfoResponse xmsUser userInfo
Description The request to retrieve the information of an authenticated user. Contains the response to a request to retrieve the information of an authenticated user. Authentication information for a user. Information for an authenticated user.
The input data for a GetUserInfo WSDL operation.

<xs:element name="GetUserInfo"> <xs:complexType> <xs:sequence> <xs:element name="xmsUser" type="xs:string" /> </xs:sequence> </xs:complexType> </xs:element>
3.1.4.2.2.2
GetUserInfoResponse
This structure contains the response to a GetUserInfo WSDL operation.
GetUserInfoResult: User information for an authenticated user; MUST be an XML fragment that conforms to the XML schema of the userInfo element.
3.1.4.2.2.3
Pr e
3.1.4.2.2.4 userInfo
Authentication information for a user; MUST be an XML fragment that conforms to the XML schema of the tXmsUser complex type.
<xs:element name="xmsUser" type="tns:tXmsUser" />
Information for an authenticated user; MUST be an XML fragment that conforms to the XML schema of the tUserInfo complex type.
lim
xmsUser
<xs:element name="GetUserInfoResponse"> <xs:complexType> <xs:sequence> <xs:element name="GetUserInfoResult" type="xs:string" /> </xs:sequence> </xs:complexType> </xs:element>
in
xmsUser: Authentication information for a user; MUST be an XML fragment that conforms to the XML schema of the xmsUser element.
ar
35 / 71
3.1.4.2.2.1
GetUserInfo
<xs:element name="userInfo" type="tns:tUserInfo" />
3.1.4.2.3
Complex Types
Complex type tXmsUser tUserInfo tUserError Description The password and user identification of a user. The mobile number and SMTP address of a user.
Error data returned by the protocol server in response to a request.
userId: The identification of a user. password: The password of a user.
3.1.4.2.3.1.1
3.1.4.2.3.2
Information for an authenticated user.
Pr e
<xs:complexType name="tUserInfo"> <xs:sequence> <xs:element name="replyPhone" type="xs:string" minOccurs="0" /> <xs:element name="smtpAddress" type="xs:string" minOccurs="0" /> <xs:element name="error" type="tns:tUserError" /> <xs:element name="customData" type="xs:string" minOccurs="0" /> </xs:sequence> </xs:complexType>
replyPhone: The mobile number that the user used to sign up for the service with the service provider.
lim
client tUserInfo
customData: The protocol server MUST ignore this value.
in
36 / 71
<xs:complexType name="tXmsUser"> <xs:sequence> <xs:element name="userId" type="xs:string" minOccurs="0" /> <xs:element name="password" type="xs:string" minOccurs="0" /> <xs:element name="customData" type="xs:string" minOccurs="0" /> </xs:sequence> <xs:attribute name="client" type="xs:string" /> </xs:complexType>
ar
3.1.4.2.3.1
tXmsUser
smtpAddress: A unique SMTP address that is used by the protocol server to deliver the reply from phone to the protocol client. error: Error data returned by the protocol server in response to a request; MUST be an XML fragment that conforms to the XML schema of the tUserError complex type. customData: Protocol server MUST ignore this value.
3.1.4.2.3.3
tUserError
Error data returned by the protocol server in response to a request.

<xs:complexType name="tUserError"> <xs:simpleContent> <xs:extension base="xs:string"> <xs:attribute name="code" type="xs:string" use="required" /> <xs:attribute name="severity" type="xs:string" use="optional" /> </xs:extension> </xs:simpleContent> </xs:complexType>
code: If the call to GetUserInfo was successful, the code attribute MUST be set to "OK". If the call failed, the error code MUST be set follow the different situations in the following table or define its own protocol.
Value invalidUser unregisteredUser expiredUser Meaning
Invalid or unrecognized password.
User has not registered for the service.
severity: If the call to GetUserInfo was successful, the value MUST be "neutral"; otherwise it MUST be "failure".
3.1.4.2.4
None.
3.1.4.2.5
None.
Pr e
3.1.4.2.6
None.
3.1.4.2.7
None.
lim
Simple Types Attributes Groups Attribute Groups
Users prepayment is used up or the registration is expired. The error code is for the service provider who provides prepaid service.
in
ar
y
37 / 71
3.1.4.3
DeliverXms
Used to send a mobile message to the protocol server.

<wsdl:operation name="DeliverXms"> <wsdl:input message="tns:DeliverXmsSoapIn" /> <wsdl:output message="tns:DeliverXmsSoapOut" /> </wsdl:operation>
3.1.4.3.1
Messages
Message DeliverXmsSoapIn DeliverXmsSoapOut Description
The request to send a mobile message to the protocol server.
The response to a request to send a mobile message to the protocol server.
3.1.4.3.1.1
DeliverXmsSoapIn
The message represents the client request to send a mobile message to the server. The SOAP action value of the message is defined as:
http://schemas.microsoft.com/office/Outlook/2006/OMS/DeliverXms
The SOAP body contains a DeliverXms element.
3.1.4.3.1.2
The message represents the protocol server response that indicates the success or failure of the attempt to send this message to the intended recipient. The SOAP action value of the message is defined as:
http://schemas.microsoft.com/office/Outlook/2006/OMS/DeliverXms
Pr e
3.1.4.3.2 Elements
The SOAP body contains a DeliverXmsResponse element.
lim
DeliverXmsSoapOut
in
ar
38 / 71
The client sends a DeliverXmsSoapIn request message, which contains the content of a mobile message, and the server responds with a DeliverXmsSoapOut response message, which contains one or more error elements that indicate the success or failure of the attempt to send this message to the intended recipient.
Element DeliverXms DeliverXmsResponse xmsData xmsResponse
Description The request to send a mobile message to the protocol server. Contains the response to a request to send a mobile message to the protocol server. The content of a mobile message. Indicates the success or failure of the attempt to send this message to the intended recipient.
3.1.4.3.2.1
DeliverXms
The input data for a DeliverXms WSDL operation.

<xs:element name="DeliverXms"> <xs:complexType> <xs:sequence> <xs:element name="xmsData" type="xs:string" /> </xs:sequence> </xs:complexType> </xs:element>
3.1.4.3.2.2
DeliverXmsResponse
This structure contains the response to a DeliverXms WSDL operation.
DeliverXmsResult: One or more error elements that indicate the success or failure of the attempt to send the message to intended recipient; MUST be an XML fragment that conforms to the XML schema of the xmsResponse element specified at section 3.1.4.3.2.4.
Pr e
3.1.4.3.2.4
3.1.4.3.2.3
Content of mobile message; MUST be an XML fragment that conforms to the XML schema of the tXmsData complex type.
<xs:element name="xmsData" type="tns:tXmsData" />
Indicates the success or failure of the attempt to send this message to the intended recipient.
lim
xmsData xmsResponse
<xs:element name="DeliverXmsResponse"> <xs:complexType> <xs:sequence> <xs:element name="DeliverXmsResult" type="xs:string" /> </xs:sequence> </xs:complexType> </xs:element>
in
xmsData: Content of a mobile message; MUST be an XML fragment that conforms to the XML schema of the xmsData element specified at section 3.1.4.3.2.3.
ar
39 / 71
<xs:element name="xmsResponse" type="tns:tXmsResponse" />
It MUST be an XML fragment that conforms to the XML schema of the tXmsResponse complex type.
3.1.4.3.3
None.
Complex Types
3.1.4.3.4
None.
Simple Types
3.1.4.3.5
None.
Attributes
3.1.4.3.6
None.
Groups
3.1.4.3.7
None.
Attribute Groups
3.1.4.4
DeliverXmsBatch
Used to send a batch of mobile messages to the protocol server.

<wsdl:operation name="DeliverXmsBatch"> <wsdl:input message="tns:DeliverXmsBatchSoapIn" /> <wsdl:output message="tns:DeliverXmsBatchSoapOut" /> </wsdl:operation>
The client sends a DeliverXmsBatchSoapIn request message, which contains the content of a batch of mobile messages, and the server responds with a DeliverXmsBatchSoapOut response message, which contains one or more error elements that indicate the success or failure of the attempt to send each and every of these messages to the intended recipient.
3.1.4.4.1
Pr e
Message DeliverXmsBatchSoapIn DeliverXmsBatchSoapOut
Description The request to send a batch of mobile messages to the protocol server. The response to a request to send a batch of mobile messages to the protocol server.
lim
Messages
in
40 / 71
ar
3.1.4.4.1.1
DeliverXmsBatchSoapIn
The message represents the client request to send a batch of mobile messages to the server. The SOAP action value of the message is defined as:
http://schemas.microsoft.com/office/Outlook/2006/OMS/DeliverXmsBatch
The SOAP body contains a DeliverXmsBatch element.
The message represents the protocol server response that indicates the success or failure of the attempt to each and every of the messages to the intended recipient. The SOAP action value of the message is defined as:
http://schemas.microsoft.com/office/Outlook/2006/OMS/DeliverXmsBatch
The SOAP body contains a DeliverXmsBatchResponse element.
3.1.4.4.2
Elements
Element DeliverXmsBatch DeliverXmsBatchResponse xmsBatch
Description
The request to send a batch of mobile messages to the protocol server. Contains the response to a request to send a batch of mobile messages to the protocol server. The content of a batch of mobile messages. Indicates the success or failure of the attempt to send this message to the intended recipients.
xmsResponses
3.1.4.4.2.1
The input data for a DeliverXmsBatch WSDL operation.

<xs:element name="DeliverXmsBatch"> <xs:complexType> <xs:sequence> <xs:element name="packageXml" type="xs:string" /> </xs:sequence> </xs:complexType> </xs:element>
Pr e
packageXml: Content of a batch of mobile messages; MUST be an XML fragment that conforms to the XML schema of the xmsBatch element.
lim
DeliverXmsBatch
in
ar
41 / 71
3.1.4.4.1.2
DeliverXmsBatchSoapOut
3.1.4.4.2.2
DeliverXmsBatchResponse
This structure contains the response to a DeliverXmsBatch WSDL operation.

<xs:element name="DeliverXmsBatchResponse"> <xs:complexType> <xs:sequence> <xs:element name="DeliverXmsBatchResult" type="xs:string" /> </xs:sequence> </xs:complexType> </xs:element>
DeliverXmsBatchResult: One or more error elements that indicate the success or failure of the attempt to send each and every of a batch of the messages to intended recipient; MUST be an XML fragment that conforms to the XML schema of the xmsResponses element.
3.1.4.4.2.3
xmsBatch
<xs:element name="xmsBatch" type="tns:tXmsBatch" />
xmsBatch: Content of a batch of mobile messages; MUST be an XML fragment that conforms to the XML schema of the tXmsBatch complex type.
xmsResponse: Indicates the success or failure of the attempt to send this message to the intended recipient; MUST be an XML fragment that conforms to the XML schema of the tXmsResponseWithId complex type.
3.1.4.4.3
Complex type tXmsBatch Description Content of mobile message. The content of a mobile message, using the id attribute to identify each and every message in a specific batch. Indicates the success or failure of the attempt to send this message to the intended recipients, using the id attribute for identification of the message.
Pr e
tXmsDataInBatch tXmaResponseWithId
lim
Complex Types
<xs:element name="xmsResponses"> <xs:complexType> <xs:sequence> <xs:element name="xmsResponse" type="tns:tXmsResponseWithId" maxOccurs="unbounded" /> </xs:sequence> </xs:complexType> </xs:element>
in
3.1.4.4.2.4
xmsResponses
ar
y
42 / 71
3.1.4.4.3.1
tXmsBatch
<xs:complexType name="tXmsBatch"> <xs:sequence> <xs:element name="xmsData" type="tns:tXmsDataInBatch" maxOccurs="unbounded" /> </xs:sequence> <xs:attribute name="client" type="xs:string" /> </xs:complexType>
client: See section 2.2.6.1.
3.1.4.4.3.2
tXmsDataInBatch
The tXmsDataInBatch is similar to the xmsData of the DeliverXms operation, except that it uses the id attribute to identify each and every message in a specific batch.
<xs:complexType name="tXmsDataInBatch"> <xs:sequence> <xs:element name="user" type="tns:tUser" minOccurs="0" /> <xs:element name="xmsHead" type="tns:tXmsHeader" minOccurs="0" /> <xs:element name="xmsBody" type="tns:tXmsBody" /> </xs:sequence> <xs:attribute name="Id" type="xs:unsignedInt" use="required" /> </xs:complexType>
user: See section 2.2.4.17. xmsHead: See section 2.2.4.17. xmsBody: See section 2.2.4.17.
Id: Identifies each and every message in a specific batch.
3.1.4.4.3.3
The tXmsResponseWithId is similar to the xmsResponse of the DeliverXms operation, except that it uses attribute id to identify each and every message in a specific batch.
<xs:complexType name="tXmsResponseWithId"> <xs:sequence> <xs:element name="error" type="tns:tDeliveryError" maxOccurs="unbounded" /> </xs:sequence> <xs:attribute name="id" type="xs:unsignedInt" use="required" /> </xs:complexType>
Pr e
error: See section 2.2.4.19. id: Identifies each and every message in a specific batch.
lim
tXmsResponseWithId
in
ar
y
43 / 71
xmsData: Content of mobile message; MUST be an XML fragment that conforms to the XML schema of the tXmsDataInBatch complex type.
3.1.4.4.4
None.
Simple Types
3.1.4.4.5
None.
Attributes
3.1.4.4.6
None.
Groups
3.1.4.4.7
None.
Attribute Groups
To enable two-way mobile message communication between the client and a mobile phone, the protocol server is required to package the reply sent from a mobile phone into a MIME-formatted SMTP e-mail message specified in the section 2.2.2.1, and then send the e-mail messages to a userdesignated e-mail address.
None.
3.1.6
None.
Other Local Events
3.2
Client Details
The client side of this protocol is simply a pass-through. That is, no additional timers or other state is required on the client side of this protocol. Calls made by the higher-layer protocol or application are passed directly to the transport, and the results returned by the transport are passed directly back to the higher-layer protocol or application.
3.2.1
Pr e
This section describes a conceptual model of possible data organization that an implementation maintains to participate in this protocol. The described organization is provided to facilitate the explanation of how the protocol behaves. This document does not mandate that implementations adhere to this model as long as their external behavior is consistent with that described in this document. When there is reply to the mobile message from the recipients phone, the protocol server sends the reply to client via the SMTP protocol. If the application requires two-way communication from client to server and needs the client to receive reply messages, the client MAY implement the details specified in this section.
lim
Abstract Data Model
in
44 / 71
3.1.5
Timer Events
ar
3.1.4.5 Send reply message to client after collecting them from the recipients phone
3.2.2
None.
Timers
3.2.3
Initialization
To accept the reply of the mobile message from the protocol server, the client MUST be able to retrieve e-mail messages from an e-mail address that the server will send the reply message to.
3.2.4
Message Processing Events and Sequencing Rules
3.2.5
None.
Timer Events
3.2.6
None.
Other Local Events
Pr e
lim
45 / 71
in
ar
When a client receives the SMTP e-mail messages, the client MUST understand the message as specified in section 2.2.2.1. The client MUST recognize the content class and treat it as a mobile message. The client MUST be able to recognize them as text or multimedia messages. When these messages are opened, replied to, or forwarded, they are automatically treated as mobile messages. That also means, in the message reply and forward operations, the client MUST be able to allow its user to send the mobile message via calling the servers DeliverXms WSDL operation as specified in section 3.1.4.3.
Protocol Examples
The following provides examples of the interaction between protocol client and protocol server.
4.1
GetServiceInfo
An OMS client can submit a GetServiceInfo request with an empty parameter with the following code:
<?xml version="1.0" encoding="utf-8"?> <Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <Body> <GetServiceInfo xmlns="http://schemas.microsoft.com/office/Outlook/2006/OMS" /> </Body> </Envelope>
The protocol server receives this request and creates an appropriate response, similar to the following code:
<?xml version="1.0" encoding="utf-8"?> <serviceInfo> <serviceProvider>ABC Company</serviceProvider> <serviceUri>http://www.abc.com.cn/OMS3/XMS.asmx</serviceUri> <signUpPage>http://www.abc.com.cn/ws/xmssignup.aspx/</signUpPage> <targetLocale>2052</targetLocale> <localName>ABC Mobile Service</localName> <englishName>ABC Mobile Service</englishName> <authenticationType>other</authenticationType> <batchSize>255</batchSize> <supportedService> <SMS_SENDER maxRecipientsPerMessage="50" maxMessagesPerSend="20" maxSbcsPerMessage="140" maxDbcsPerMessage="70" > <LONG_SMS_SENDER maxRecipientsPerMessage="50" maxMessagesPerSend="255" maxSbcsPerMessage="153" maxDbcsPerMessage="67" /> </SMS_SENDER> <MMS_SENDER supportSlide="true" maxRecipientsPerMessage="100" maxSizePerMessage="30000" maxSlidesPerMessage="10" /> </supportedService> </serviceInfo>
Pr e
4.2 GetUserInfo
When the client wants to retrieve user information of an authenticated user in the protocol server, the request would resemble the following code:
<?xml version="1.0" encoding="utf-8"?> <xmsUser client="Microsoft Office Outlook 12.0" 46 / 71
lim
in
ar
xmlns = "http://schemas.microsoft.com/office/Outlook/2006/OMS"> <userId>myname</userId> <password>mypwd</password> <customData/> </xmsUser>
The following code is returned from the protocol server after a successful call:
<?xml version="1.0" encoding="utf-8"?> <userInfo xmlns = "http://schemas.microsoft.com/office/Outlook/2006/OMS"> <replyPhone>090123456</replyPhone> <smtpAddress>[email protected]</smtpAddress> <error code="ok"/> </userInfo>
<?xml version="1.0" encoding="utf-8"?> <userInfo xmlns = "http://schemas.microsoft.com/office/Outlook/2006/OMS"> <error code="unregistered" severity="failure"/> </userInfo>
When the client wants to send a text message to the protocol server, the request would resemble the following code:
<?xml version="1.0" encoding="utf-8"?> <xmsData client="Microsoft Office Outlook 12.0" xmlns = "http://schemas.microsoft.com/office/Outlook/2006/OMS"> <user> <userId>myname</userId> <password>mypwd</password> <replyPhone>13801391350</replyPhone> <customData/> </user> <xmsHead> <scheduled>2005-04-20T14:20:00Z</scheduled> <requiredService>SMS_SENDER</requiredService> <to> <recipient>135xxxx</recipient> <recipient>139xxxx</recipient> </to> </xmsHead> <xmsBody format="SMS"> <content contentType="text/plain" contentId="[email protected]" contentLocation="1.txt">(1/2)This is the first SMS message...</content> <content contentType="text/plain" contentId="[email protected]" contentLocation="2.txt">(2/2)This is the second SMS message...</content> </xmsBody> </xmsData>
Pr e
lim
in
4.3
DeliverXms
ar
47 / 71
The following code is returned from the protocol server after an error:
When the client wants to send a multimedia message to the protocol server, the request would resemble the following code:
<?xml version="1.0" encoding="utf-8"?> <xmsData client="Microsoft Office Outlook 12.0" xmlns = "http://schemas.microsoft.com/office/Outlook/2006/OMS"> <user> <userId>myname</userId> <password>mypwd</password> <replyPhone>13801391350</replyPhone> <customData/> </user> <xmsHead> <scheduled>2005-04-20T14:20:00Z</scheduled> <requiredService>MMS_SENDER</requiredService> <sourceType>reminder</sourceType> <to> <recipient>135xxxx</recipient> <recipient>139xxxx</recipient> </to> <subject>My Message</subject> </xmsHead> <xmsBody format="MMS"> <mmsSlides> <head> <meta name="author" content="msOfficeOutlookOms" /> <layout> <root-layout width="120" height="120" background-color="#ffffff" /> <region id="Image" left="0" top="0" width="120" height="90" /> <region id="Text" left="0" top="90" width="120" height="30" /> </layout> </head> <body> <par dur="3000"> <img src="cid:[email protected]" region="Image" /> <text src="cid:[email protected]" region="Text"/> <audio src="cid:[email protected]" /> </par> </body> </mmsSlides> <content contentType="text/plain" contentId="[email protected]" contentLocation="1.txt">This is the text part</content> <content contentType="image/gif" contentId="[email protected]" contentLocation= "106675.gif">/9j/4AAQ ...... AVExISEyccHhcgLikxMC4p</content> <content contentType="audio/mid" contentId="[email protected]" contentLocation="1898.mid">/wDQjVYUrl ...... GoJ4e8j</content> </xmsBody> </xmsData>
Pr e
After receiving the previous request, the following response is an example generated by protocol server when the message is delivered successfully:
lim
in
ar
48 / 71
<?xml version="1.0" encoding="utf-8"?> <xmsResponse xmlns="http://schemas.microsoft.com/office/Outlook/2006/OMS"> <error code="ok" severity="neutral"/> </xmsResponse>
The following response is an example generated by protocol server when the message failed to be delivered:
<?xml version="1.0" encoding="utf-8"?> <xmsResponse xmlns="http://schemas.microsoft.com/office/Outlook/2006/OMS"> <error code="perDayMsgLimit" severity="failure"> <content>20 SMS</content> <recipientList>13601391354;13601391388</recipientList> </error> </xmsResponse>
4.4
DeliverXmsBatch
The following code is an example from client for sending a batch of mobile messages (two text messages in this example):
<?xml version="1.0" encoding="utf-16"?> <xmsBatch client="Microsoft Windows SharePoint Service" xmlns="http://schemas.microsoft.com/office/Outlook/2006/OMS"> <xmsData id="0"> <user> <userId>ddguo</userId> <password /> <customData /> </user> <xmsHead> <requiredService>SMS_SENDER</requiredService> <sourceType>wssAlert</sourceType> <to> <recipient>13671121236</recipient> </to> </xmsHead> <xmsBody format="SMS"> <content contentType="text/plain" contentId="1.txt@5ca13ed023024ed59cfae6c0e185a5db" contentLocation="1.txt">This is a testing message.</content> </xmsBody> </xmsData> <xmsData id="1"> <user> <userId>ddguo</userId> <password /> <customData /> </user> <xmsHead> <requiredService>SMS_SENDER</requiredService> <sourceType>wssAlert</sourceType> <to> <recipient>13671121236</recipient> </to> </xmsHead>
Pr e
lim
in
ar
49 / 71
<xmsBody format="SMS"> <content contentType="text/plain" contentId="1.txt@ecf25304326e497c8775a929a3178311" contentLocation="1.txt">This is a testing message.</content> </xmsBody> </xmsData> </xmsBatch>
The following code is an example of response from the protocol server for the able request:
<?xml version="1.0" encoding="utf-16"?> <xmsResponses xmlns="http://schemas.microsoft.com/office/Outlook/2006/OMS"> <xmsResponse id="0"> <error code="ok" severity="neutral" /> <error code="serviceupdate" severity="neutral"> <content>2008-08-28T08:59:10Z</content> </error> </xmsResponse> <xmsResponse id="1"> <error code="ok" severity="neutral" /> <error code="serviceupdate" severity="neutral"> <content>2008-08-28T08:59:11Z</content> </error> </xmsResponse> </xmsResponses>
4.5 Send Reply Message from Server to Client after Server Collects the Mobile Message from Recipients Phone
The following is an example of an incoming text message that is packaged as e-mail message:
From: "Mobile Inbound Agent" [email protected] To: [email protected] Subject: This is a text message Date: Mon, 7 Nov 2005 17:52:00 +0800 Content-class: MS-OMS-SMS X-MS-Reply-to-mobile: +8613601391354 MIME-Version: 1.0 Content-Type: text/plain; charset="gb2312" Content-Transfer-Encoding: quoted-printable This is a text message from a mobile phone replying to a text message from Outlook.
Pr e
The following is an example of an incoming multimedia message that is packaged as e-mail message:
From: "Mobile Inbound Agent" [email protected] To: [email protected] Subject: This is a multimedia message (Open the message to view its content) Date: Mon, 7 Nov 2005 17:52:00 +0800 Content-class: MS-OMS-MMS X-MS-Reply-to-mobile: +8613601391354 MIME-Version: 1.0 Content-Type: multipart/related; type="application/smil"; boundary="--------------Boundary=_thisisboundary"
lim
in
ar
50 / 71
Pr e
lim
51 / 71
in
ar
This is a multi-part message in MIME format. --------------Boundary=_thisisboundary Content-Type: application/smil; name="mmspresent.smil" Content-Location: "mmspresent.smil" Content-Transfer-Encoding: Base64 PHNtaWw+ 1pbD4= --------------Boundary=_thisisboundary Content-Type: text/plain; name="textpart.txt" Content-Transfer-Encoding: Base64 Content-Location: textpart.txt 6Zi/5YWs5Y+45rOV5b6L5biI6IyD5Zu057uV6YGT6LCi --------------Boundary=_thisisboundary Content-Type: image/gif; name="imagepart.gif" Content-Transfer-Encoding: Base64 Content-Location:imagepart.gif R0lGODlheABaAPf/BDQi6j4uQAxwcixRzZErI5ROjfvSHJcmRMGBAAOw== --------------Boundary=_thisisboundary Content-Type: audio/mid; name="audiopart.mid" Content-Transfer-Encoding: Base64 Content-Location: audiopart.mid TVRoZAAAAAYXBDfwA/fwA6f4dAOgAAPwAAQwAA/y8A --------------Boundary=_thisisboundary
5
5.1
Security
Security Considerations for Implementers
This protocol introduces no additional security considerations beyond those applicable to its underlying protocols.
5.2
Index of Security Parameters
None.
Pr e
lim
52 / 71
in
ar
Appendix A: Full WSDL

For ease of implementation, the full WSDL and schema are provided in this appendix.
<wsdl:definitions targetNamespace="http://schemas.microsoft.com/office/Outlook/2006/OMS" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:tm="http://microsoft.com/wsdl/mime/textMatching/" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:mime="http://schemas.xmlsoap.org/wsdl/mime/" xmlns:tns="http://schemas.microsoft.com/office/Outlook/2006/OMS" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://schemas.xmlsoap.org/wsdl/soap12/" xmlns:http="http://schemas.xmlsoap.org/wsdl/http/" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" > <wsdl:types> <xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/office/Outlook/2006/OMS">  <xs:simpleType name="tAuthenticationTypeEnum"> <xs:restriction base="xs:string"> <xs:enumeration value="passport" /> <xs:enumeration value="fulltrust" /> <xs:enumeration value="other" /> </xs:restriction> </xs:simpleType> <xs:complexType name="tLONG_SMS_SENDER"> <xs:attribute name="maxRecipientsPerMessage" type="xs:unsignedInt" use="required" /> <xs:attribute name="maxMessagesPerSend" type="xs:unsignedInt" use="required" /> <xs:attribute name="maxSbcsPerMessage" type="xs:unsignedInt" use="required" /> <xs:attribute name="maxDbcsPerMessage" type="xs:unsignedInt" use="required" /> </xs:complexType> <xs:complexType name="tSMS_SENDER"> <xs:sequence> <xs:element name="LONG_SMS_SENDER" type="tns:tLONG_SMS_SENDER" minOccurs="0" /> </xs:sequence> <xs:attribute name="maxRecipientsPerMessage" type="xs:unsignedInt" use="required" /> <xs:attribute name="maxMessagesPerSend" type="xs:unsignedInt" use="required" /> <xs:attribute name="maxSbcsPerMessage" type="xs:unsignedInt" use="required" /> <xs:attribute name="maxDbcsPerMessage" type="xs:unsignedInt" use="required" /> </xs:complexType> <xs:complexType name="tMMS_SENDER"> <xs:attribute name="supportSlide" type="xs:boolean" use="required" /> <xs:attribute name="maxRecipientsPerMessage" type="xs:unsignedInt" use="required" /> <xs:attribute name="maxSizePerMessage" type="xs:unsignedInt" use="required" /> <xs:attribute name="maxSlidesPerMessage" type="xs:unsignedInt" use="required" />
Pr e
lim
in
ar
53 / 71
Pr e
lim
 <xs:complexType name="tXmsUser"> <xs:sequence> <xs:element name="userId" type="xs:string" minOccurs="0" /> <xs:element name="password" type="xs:string" minOccurs="0" /> <xs:element name="customData" type="xs:string" minOccurs="0" /> </xs:sequence> <xs:attribute name="client" type="xs:string" /> </xs:complexType> <xs:element name="xmsUser" type="tns:tXmsUser" /> <xs:element name="GetUserInfo"> <xs:complexType> <xs:sequence> <xs:element name="xmsUser" type="xs:string" /> </xs:sequence> </xs:complexType> </xs:element>  <xs:complexType name="tUserError"> <xs:simpleContent> <xs:extension base="xs:string"> <xs:attribute name="code" type="xs:string" use="required" /> <xs:attribute name="severity" type="xs:string" use="optional" />
in
</xs:complexType> <xs:complexType name="tSupportedService"> <xs:sequence minOccurs="1" maxOccurs="2"> <xs:element name="SMS_SENDER" type="tns:tSMS_SENDER" minOccurs="0" /> <xs:element name="MMS_SENDER" type="tns:tMMS_SENDER" minOccurs="0" /> </xs:sequence> </xs:complexType> <xs:complexType name="tServiceInfo"> <xs:sequence> <xs:element name="serviceProvider" type="xs:string" /> <xs:element name="serviceUri" type="xs:string" /> <xs:element name="signUpPage" type="xs:string" /> <xs:element name="targetLocale" type="xs:unsignedShort" minOccurs="0" default="0" /> <xs:element name="localName" type="xs:string" /> <xs:element name="englishName" type="xs:string" /> <xs:element name="authenticationType" type="tns:tAuthenticationTypeEnum" /> <xs:element name="batchSize" type="xs:unsignedInt" minOccurs="0" default="0" /> <xs:element name="supportedService" type="tns:tSupportedService" /> </xs:sequence> </xs:complexType> <xs:element name="GetServiceInfo"> <xs:complexType /> </xs:element> <xs:element name="serviceInfo" type="tns:tServiceInfo" /> <xs:element name="GetServiceInfoResponse"> <xs:complexType> <xs:sequence> <xs:element name="GetServiceInfoResult" type="xs:string" /> </xs:sequence> </xs:complexType> </xs:element>
ar
54 / 71
Pr e
 <xs:simpleType name="tRequiredServiceTypeEnum"> <xs:restriction base="xs:string"> <xs:enumeration value="SMS_SENDER" /> <xs:enumeration value="MMS_SENDER" /> </xs:restriction> </xs:simpleType> <xs:complexType name="tTo"> <xs:sequence> <xs:element maxOccurs="unbounded" name="recipient" type="xs:string" /> </xs:sequence> </xs:complexType> <xs:complexType name="tXmsHeader"> <xs:sequence> <xs:element name="scheduled" type="xs:dateTime" minOccurs="0" /> <xs:element name="requiredService" type="tns:tRequiredServiceTypeEnum" minOccurs="0" /> <xs:element name="sourceType" type="xs:string" minOccurs="0" /> <xs:element name="to" type="tns:tTo" /> <xs:element name="subject" type="xs:string" minOccurs="0" /> </xs:sequence> </xs:complexType> <xs:complexType name="tUser"> <xs:sequence> <xs:element name="userId" type="xs:string" minOccurs="0" /> <xs:element name="password" type="xs:string" minOccurs="0" /> <xs:element name="replyPhone" type="xs:string" minOccurs="0" /> <xs:element name="customData" type="xs:string" minOccurs="0" /> </xs:sequence> </xs:complexType> <xs:complexType name="tMeta"> <xs:attribute name="name" type="xs:string" use="required" /> <xs:attribute name="content" type="xs:string" use="required" /> </xs:complexType> <xs:complexType name="tRoot-layout"> <xs:attribute name="width" type="xs:unsignedInt" use="required" /> <xs:attribute name="height" type="xs:unsignedByte" use="required" /> <xs:attribute name="background-color" type="xs:string" use="required" /> </xs:complexType>
lim
in
ar
55 / 71
</xs:extension> </xs:simpleContent> </xs:complexType> <xs:complexType name="tUserInfo"> <xs:sequence> <xs:element name="replyPhone" type="xs:string" minOccurs="0" /> <xs:element name="smtpAddress" type="xs:string" minOccurs="0" /> <xs:element name="error" type="tns:tUserError" /> <xs:element name="customData" type="xs:string" minOccurs="0" /> </xs:sequence> </xs:complexType> <xs:element name="userInfo" type="tns:tUserInfo" /> <xs:element name="GetUserInfoResponse"> <xs:complexType> <xs:sequence> <xs:element name="GetUserInfoResult" type="xs:string" /> </xs:sequence> </xs:complexType> </xs:element>
Pr e
<xs:complexType name="tRegion"> <xs:attribute name="id" type="xs:string" use="required" /> <xs:attribute name="left" type="xs:unsignedInt" use="required" /> <xs:attribute name="top" type="xs:unsignedInt" use="required" /> <xs:attribute name="width" type="xs:unsignedInt" use="required" /> <xs:attribute name="height" type="xs:unsignedInt" use="required" /> </xs:complexType> <xs:complexType name="tLayout"> <xs:sequence> <xs:element name="root-layout" type="tns:tRoot-layout" /> <xs:element name="region" type="tns:tRegion" maxOccurs="2" /> </xs:sequence> </xs:complexType> <xs:complexType name="tHeader"> <xs:sequence> <xs:element name="meta" type="tns:tMeta" minOccurs="0" /> <xs:element name="layout" type="tns:tLayout" /> </xs:sequence> </xs:complexType> <xs:complexType name="tImg"> <xs:attribute name="src" type="xs:string" use="required" /> <xs:attribute name="region" type="xs:string" use="required" /> </xs:complexType> <xs:complexType name="tText"> <xs:attribute name="src" type="xs:string" use="required" /> <xs:attribute name="region" type="xs:string" use="required" /> <xs:attribute name="foreground-color" type="xs:string" use="optional" /> </xs:complexType> <xs:complexType name="tAudio"> <xs:attribute name="src" type="xs:string" use="required" /> </xs:complexType> <xs:complexType name="tPar"> <xs:sequence> <xs:element name="img" type="tns:tImg" minOccurs="0" /> <xs:element name="text" type="tns:tText" minOccurs="0" /> <xs:element name="audio" type="tns:tAudio" minOccurs="0" /> </xs:sequence> <xs:attribute name="dur" type="xs:string" use="required" /> </xs:complexType> <xs:complexType name="tBody"> <xs:sequence> <xs:element name="par" type="tns:tPar" maxOccurs="unbounded" /> </xs:sequence> </xs:complexType> <xs:complexType name="tMmsSlides"> <xs:sequence> <xs:element name="head" type="tns:tHeader" minOccurs="0" /> <xs:element name="body" type="tns:tBody" /> </xs:sequence> </xs:complexType> <xs:complexType name="tContent"> <xs:simpleContent> <xs:extension base="xs:string"> <xs:attribute name="contentType" type="xs:string" use="required" /> <xs:attribute name="contentId" type="xs:string" use="required" /> <xs:attribute name="contentLocation" type="xs:string" use="required" /> </xs:extension> </xs:simpleContent> </xs:complexType>
lim
in
ar
56 / 71
Pr e
lim
 <xs:complexType name="tDeliveryError"> <xs:sequence> <xs:element name="content" type="xs:string" minOccurs="0" /> <xs:element name="recipientList" type="xs:string" minOccurs="0" /> </xs:sequence> <xs:attribute name="code" type="xs:string" use="required" /> <xs:attribute name="severity" type="xs:string" use="required" /> </xs:complexType> <xs:complexType name="tXmsResponse"> <xs:sequence> <xs:element name="error" type="tns:tDeliveryError" maxOccurs="unbounded" /> </xs:sequence> </xs:complexType> <xs:element name="xmsResponse" type="tns:tXmsResponse" /> <xs:element name="DeliverXmsResponse"> <xs:complexType> <xs:sequence> <xs:element name="DeliverXmsResult" type="xs:string" /> </xs:sequence> </xs:complexType> </xs:element>  <xs:complexType name="tXmsDataInBatch"> <xs:sequence> <xs:element name="user" type="tns:tUser" minOccurs="0" /> <xs:element name="xmsHead" type="tns:tXmsHeader" minOccurs="0" /> <xs:element name="xmsBody" type="tns:tXmsBody" /> </xs:sequence> <xs:attribute name="Id" type="xs:unsignedInt" use="required" /> </xs:complexType> <xs:complexType name="tXmsBatch"> <xs:sequence> <xs:element name="xmsData" type="tns:tXmsDataInBatch"
in
ar
57 / 71
<xs:complexType name="tXmsBody"> <xs:sequence> <xs:element name="mmsSlides" type="tns:tMmsSlides" minOccurs="0" /> <xs:element name="content" type="tns:tContent" maxOccurs="unbounded" /> </xs:sequence> <xs:attribute name="format" type="xs:string" use="required" /> </xs:complexType> <xs:complexType name="tXmsData"> <xs:sequence> <xs:element name="user" type="tns:tUser" minOccurs="0" /> <xs:element name="xmsHead" type="tns:tXmsHeader" minOccurs="0" /> <xs:element name="xmsBody" type="tns:tXmsBody" /> </xs:sequence> <xs:attribute name="client" type="xs:string" /> </xs:complexType> <xs:element name="xmsData" type="tns:tXmsData" /> <xs:element name="DeliverXms"> <xs:complexType> <xs:sequence> <xs:element name="xmsData" type="xs:string" /> </xs:sequence> </xs:complexType> </xs:element>
Pr e
 <xs:complexType name="tXmsResponseWithId"> <xs:sequence> <xs:element name="error" type="tns:tDeliveryError" maxOccurs="unbounded" /> </xs:sequence> <xs:attribute name="id" type="xs:unsignedInt" use="required" /> </xs:complexType> <xs:element name="xmsResponses"> <xs:complexType> <xs:sequence> <xs:element name="xmsResponse" type="tns:tXmsResponseWithId" maxOccurs="unbounded" /> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="DeliverXmsBatchResponse"> <xs:complexType> <xs:sequence> <xs:element name="DeliverXmsBatchResult" type="xs:string" /> </xs:sequence> </xs:complexType> </xs:element> </xs:schema> </wsdl:types> <wsdl:message name="GetServiceInfoSoapIn"> <wsdl:part name="parameters" element="tns:GetServiceInfo" /> </wsdl:message> <wsdl:message name="GetServiceInfoSoapOut"> <wsdl:part name="parameters" element="tns:GetServiceInfoResponse" /> </wsdl:message> <wsdl:message name="GetUserInfoSoapIn"> <wsdl:part name="parameters" element="tns:GetUserInfo" /> </wsdl:message> <wsdl:message name="GetUserInfoSoapOut"> <wsdl:part name="parameters" element="tns:GetUserInfoResponse" /> </wsdl:message> <wsdl:message name="DeliverXmsSoapIn"> <wsdl:part name="parameters" element="tns:DeliverXms" /> </wsdl:message> <wsdl:message name="DeliverXmsSoapOut"> <wsdl:part name="parameters" element="tns:DeliverXmsResponse" /> </wsdl:message> <wsdl:message name="DeliverXmsBatchSoapIn"> <wsdl:part name="parameters" element="tns:DeliverXmsBatch" /> </wsdl:message>
lim
in
ar
58 / 71
maxOccurs="unbounded" /> </xs:sequence> <xs:attribute name="client" type="xs:string" /> </xs:complexType> <xs:element name="xmsBatch" type="tns:tXmsBatch" /> <xs:element name="DeliverXmsBatch"> <xs:complexType> <xs:sequence> <xs:element name="packageXml" type="xs:string" /> </xs:sequence> </xs:complexType> </xs:element>
<wsdl:message name="DeliverXmsBatchSoapOut"> <wsdl:part name="parameters" element="tns:DeliverXmsBatchResponse" /> </wsdl:message> <wsdl:portType name="OMSServiceSoap"> <wsdl:operation name="GetServiceInfo"> <wsdl:input message="tns:GetServiceInfoSoapIn" /> <wsdl:output message="tns:GetServiceInfoSoapOut" /> </wsdl:operation> <wsdl:operation name="GetUserInfo"> <wsdl:input message="tns:GetUserInfoSoapIn" /> <wsdl:output message="tns:GetUserInfoSoapOut" /> </wsdl:operation> <wsdl:operation name="DeliverXms"> <wsdl:input message="tns:DeliverXmsSoapIn" /> <wsdl:output message="tns:DeliverXmsSoapOut" /> </wsdl:operation> <wsdl:operation name="DeliverXmsBatch"> <wsdl:input message="tns:DeliverXmsBatchSoapIn" /> <wsdl:output message="tns:DeliverXmsBatchSoapOut" /> </wsdl:operation> </wsdl:portType> <wsdl:binding name="OMSServiceSoap" type="tns:OMSServiceSoap"> <soap:binding transport="http://schemas.xmlsoap.org/soap/http" /> <wsdl:operation name="GetServiceInfo"> <soap:operation soapAction="http://schemas.microsoft.com/office/Outlook/2006/OMS/GetServiceInfo" style="document" /> <wsdl:input> <soap:body use="literal" /> </wsdl:input> <wsdl:output> <soap:body use="literal" /> </wsdl:output> </wsdl:operation> <wsdl:operation name="GetUserInfo"> <soap:operation soapAction="http://schemas.microsoft.com/office/Outlook/2006/OMS/GetUserInfo" style="document" /> <wsdl:input> <soap:body use="literal" /> </wsdl:input> <wsdl:output> <soap:body use="literal" /> </wsdl:output> </wsdl:operation> <wsdl:operation name="DeliverXms"> <soap:operation soapAction="http://schemas.microsoft.com/office/Outlook/2006/OMS/DeliverXms" style="document" /> <wsdl:input> <soap:body use="literal" /> </wsdl:input> <wsdl:output> <soap:body use="literal" /> </wsdl:output> </wsdl:operation> <wsdl:operation name="DeliverXmsBatch">
Pr e
lim
in
ar
59 / 71
Pr e
<soap:operation soapAction="http://schemas.microsoft.com/office/Outlook/2006/OMS/DeliverXmsBatch" style="document" /> <wsdl:input> <soap:body use="literal" /> </wsdl:input> <wsdl:output> <soap:body use="literal" /> </wsdl:output> </wsdl:operation> </wsdl:binding> <wsdl:binding name="OMSServiceSoap12" type="tns:OMSServiceSoap"> <soap12:binding transport="http://schemas.xmlsoap.org/soap/http" /> <wsdl:operation name="GetServiceInfo"> <soap12:operation soapAction="http://schemas.microsoft.com/office/Outlook/2006/OMS/GetServiceInfo" style="document" /> <wsdl:input> <soap12:body use="literal" /> </wsdl:input> <wsdl:output> <soap12:body use="literal" /> </wsdl:output> </wsdl:operation> <wsdl:operation name="GetUserInfo"> <soap12:operation soapAction="http://schemas.microsoft.com/office/Outlook/2006/OMS/GetUserInfo" style="document" /> <wsdl:input> <soap12:body use="literal" /> </wsdl:input> <wsdl:output> <soap12:body use="literal" /> </wsdl:output> </wsdl:operation> <wsdl:operation name="DeliverXms"> <soap12:operation soapAction="http://schemas.microsoft.com/office/Outlook/2006/OMS/DeliverXms" style="document" /> <wsdl:input> <soap12:body use="literal" /> </wsdl:input> <wsdl:output> <soap12:body use="literal" /> </wsdl:output> </wsdl:operation> <wsdl:operation name="DeliverXmsBatch"> <soap12:operation soapAction="http://schemas.microsoft.com/office/Outlook/2006/OMS/DeliverXmsBatch" style="document" /> <wsdl:input> <soap12:body use="literal" /> </wsdl:input> <wsdl:output> <soap12:body use="literal" /> </wsdl:output> </wsdl:operation> </wsdl:binding>
lim
in
ar
60 / 71
</wsdl:definitions>
Pr e
lim
61 / 71
in
ar
Appendix B: Product Behavior

The information in this specification is applicable to the following Microsoft products or supplemental software. References to product versions include released service packs: Microsoft Office Outlook 2007 Microsoft Outlook 2010 Microsoft Outlook 15 Technical Preview Microsoft SharePoint Foundation 2010 Microsoft SharePoint Foundation 15 Technical Preview
Unless otherwise specified, any statement of optional behavior in this specification that is prescribed using the terms SHOULD or SHOULD NOT implies product behavior in accordance with the SHOULD or SHOULD NOT prescription. Unless otherwise specified, the term MAY implies that the product does not follow the prescription. <1> Section 3.1.4: To support Office Outlook 2007 SP1 or Outlook 2010, it is not necessary for the protocol server to implement the SendXms operation. <2> Section 3.1.4: Use the DeliverXmsBatch operation in implementations for SharePoint Foundation 2010 but not for Office Outlook 2007 or Outlook 2010.
Pr e
lim
62 / 71
in
ar
Exceptions, if any, are noted below. If a service pack or Quick Fix Engineering (QFE) number appears with the product version, behavior changed in that service pack or QFE. The new behavior also applies to subsequent service packs of the product unless otherwise specified. If a product edition appears with the product version, behavior is different in that product edition.
Change Tracking
This section identifies changes that were made to the [MS-OMS] protocol document between the June 2011 and January 2012 releases. Changes are classified as New, Major, Minor, Editorial, or No change. The revision class New means that a new document is being released. The revision class Major means that the technical content in the document was significantly revised. Major changes affect protocol interoperability or implementation. Examples of major changes are:
An extensive rewrite, addition, or deletion of major portions of content. The removal of a document from the documentation set. Changes made for template compliance.
The revision class Minor means that the meaning of the technical content was clarified. Minor changes do not affect protocol interoperability or implementation. Examples of minor changes are updates to clarify ambiguity at the sentence, paragraph, or table level. The revision class Editorial means that the language and formatting in the technical content was changed. Editorial changes apply to grammatical, formatting, and style issues.
The revision class No change means that no new technical or language changes were introduced. The technical content of the document is identical to the last released version, but minor editorial and formatting changes, as well as updates to the header and footer information, and to the revision summary, may have been made. Major and minor changes can be described further using the following change types:
Content updated.
Content removed.
New product behavior note added. Product behavior note updated.
Product behavior note removed. New protocol syntax added. Protocol syntax updated.
Pr e
Protocol syntax removed. New content added due to protocol revision. Content updated due to protocol revision. Content removed due to protocol revision. New protocol syntax added due to protocol revision.
lim
63 / 71
New content added.
in
ar
A document revision that incorporates changes to interoperability requirements or functionality.
Protocol syntax updated due to protocol revision. Protocol syntax removed due to protocol revision. New content added for template compliance. Content updated for template compliance. Content removed for template compliance. Obsolete document removed.
Some important terms used in the change type descriptions are defined as follows:
Protocol revision refers to changes made to a protocol that affect the bits that are sent over the wire.
The changes made to this document are listed in the following table. For more information, please contact [email protected].
Major change (Y or N) N
Section 1.1 Glossary
Tracking number (if applicable) and description
in
1.1 Glossary
lim
Added "authentication", "Hypertext Transfer Protocol over Secure Sockets Layer (HTTPS)", "language code identifier (LCID)", "Simple Object Access Protocol (SOAP)", "SOAP action", "SOAP body". Added "XML fragment", "XML schema". Added reference [GIF89a]. Added reference [SOAP1.2/2]. Clarified the discussion about the client accepting replies to messages from a server. Clarified the caption for the diagram.
1.2.1 Normative References
1.2.2 Informative References 1.3.1.2 Protocol Clients
Pr e
1.3.2.2 Obtaining Information from an Authenticated User 1.4 Relationship to Other Protocols
1.3.2.1 Obtaining Information from the Protocol Server
Clarified that clients can get more information from an authenticated user . Clarified that this protocol uses SOAP and HTTPS and added references for them.
ar
Change type New content added. N N N N N New content added. New content added. New content added. Content updated. Content updated. Content updated. Content updated. N N 64 / 71
Protocol syntax refers to data elements (such as packets, structures, enumerations, and methods) as well as interfaces.
Editorial changes are always classified with the change type Editorially updated.
Section 2 Messages
Tracking number (if applicable) and description Clarified that the schema might be different from the processing rules of the protocol. Clarified that the text introducing the WSDL might specify differences that reflect Microsoft product behavior. Clarified that the section contains definitions used by the protocol. Clarified what the value of the Subject field must be. Clarified that the server encodes multimedia messages as MIME-formatted SMTP mails. Updated the text to remove mention of the 3GPP standard. Clarified that tBody is "Body part of SMIL." Clarified that the attribute is "src".
Major change (Y or N) N
Change type Content updated.
2.2.2.1.1.5 Subject 2.2.2.1.2.2 Incoming Multimedia Message 2.2.2.1.2.2 Incoming Multimedia Message 2.2.4 Complex Types 2.2.4.1 tAudio 2.2.4.2 tBody 2.2.4.3 tContent 2.2.4.3 tContent 2.2.4.3 tContent 2.2.4.5 tHeader 2.2.4.6 tImg
in
Clarified that par must be an XML fragment. Updated the MIDI audio format MIME type.
lim
Updated the AMR sound format MIME type. Added normative reference to the GIF89a specification. Clarified that the elements are "meta" and "layout". Clarified that region could be "Image" or "Text". Clarified that the first attribute is "src". Clarified that the elements are "head" and "body". Updated the data type of attribute dur in schema. Clarified that attribute "dur" is a string. Updated description of id attribute.
Pr e
2.2.4.10 tPar 2.2.4.10 tPar 2.2.4.11 tRegion
2.2.4.9 tMmsSlides
ar
N Content updated. Content updated. Content updated. Content updated. Content updated. Content updated. Content updated. Content updated. Content updated. Content updated. Content updated. Content updated. Content updated. N N N Y Y N N N N N Y N 65 / 71
y
N Y Content updated. Content updated.
2.2 Common Message Syntax
Content updated.
Section 2.2.4.11 tRegion 2.2.4.13 tText 2.2.4.13 tText 2.2.4.16 tXmsBody 2.2.4.19 tXmsResponse 2.2.9 Common Data Structures 3 Protocol Details
Tracking number (if applicable) and description Clarified that id must be "Image" or "Text". Added description and schema definition for the "foreground-color" attribute. Clarified that the first attribute is "src". Clarified that region could be "Image" or "Text". Updated element mmsSlides in schema. Clarified that the description after the schema is for the error element. Added this section.
Major change (Y or N) Y Y N
Change type Content updated. New content added. Content updated. Content updated. Content updated.
3.1.4 Message Processing Events and Sequencing Rules 3.1.4 Message Processing Events and Sequencing Rules 3.1.4.1 GetServiceInfo 3.1.4.1.1 Messages 3.1.4.1.2 Elements
Clarified the descriptions of GetServiceInfo, DeliverXms, and DeliverXmBatch. Revised the product behavior note for DeliverXms.
in
Clarified that the schema may differ from the protocol processing rules and that the text that introduces the WSDL might specify differences that reflect Microsoft product behavior.
lim
Removed the normative language when describing how the server responds to the GetServiceInfoSoapIn message. Added a table of WSDL messages. Added a table of schema elements. Added a table of complex types. Clarified that LONG_SMS_SENDER conforms to the tLONG_SMS_SENDER complex type. Added the table of simple types. Added the table of messages. Added the table of schema elements.
Pr e
3.1.4.1.3.3 tSMS_SENDER 3.1.4.1.4 Simple Types 3.1.4.2.1 Messages 3.1.4.2.2
3.1.4.1.3 Complex Types
ar
N N N New content added. New content added. N New content added. Product behavior note updated. Content updated. Content updated. Content updated. Content updated. Content updated. New content added. New content added. New content N N N N N N N N N 66 / 71
y
N
Section Elements 3.1.4.2.3 Complex Types 3.1.4.3.1 Messages 3.1.4.3.1.1 DeliverXmsSoapIn 3.1.4.3.1.2 DeliverXmsSoapOut 3.1.4.3.2 Elements 3.1.4.4.1 Messages 3.1.4.4.1.1 DeliverXmsBatchSoapIn 3.1.4.4.1.2 DeliverXmsBatchSoapOut 3.1.4.4.2 Elements 3.1.4.4.2.1 DeliverXmsBatch 3.1.4.4.2.3 xmsBatch
Tracking number (if applicable) and description
Major change (Y or N)
Change type added.
Added the table of complex types. Added the table. Clarified that the SOAP action value of the message is "http://.../DeliverXms". Clarified that the SOAP action value of the message is "http://.../DeliverXms". Added the table. Added the table.
N N N N N N N N N N
New content added. New content added. Content updated. Content updated.
Updated the schema from "...DeliverXMSB" to "...DeliverXmsBatch". Updated the schema from "...DeliverXMSB" to "...DeliverXmsBatch". Added the table of elements.
in
lim
Added the table.
Updated, in the description of packageXml, the text from "packageXml complex type" to "xmsBatch element". Updated the section name and the element name from "packageXml" to "xmsBatch". Clarified XML schema requirement for "xmsResponse" element.
3.1.4.4.2.4 xmsResponses
3.1.4.4.3 Complex Types 3.1.4.4.3.1 tXmsBatch
Clarified XML schema requirement for "xmsData" element. Revised the "id" attribute to be "Id". Updated "xmlnsoap" to "xmlns:soap". Updated the <authenticationType> value from"Other" to "other". Revised "image" to "Image" and "text" to "Text" for both region id and region. Updated the data type of attribute dur in
Pr e
4.1 GetServiceInfo 4.3 DeliverXms 6
3.1.4.4.3.2 tXmsDataInBatch
ar
New content added. New content added. Content updated. Content updated. New content added. Content updated. Content updated. New content added. New content added. New content added. Content updated. Content updated. Content updated. Content N N N N N N N N 67 / 71
Section Appendix A: Full WSDL 6 Appendix A: Full WSDL 6 Appendix A: Full WSDL 6 Appendix A: Full WSDL 6 Appendix A: Full WSDL 6 Appendix A: Full WSDL 6 Appendix A: Full WSDL 7 Appendix B: Product Behavior
Tracking number (if applicable) and description complex type tPar. Removed an include from Full WSDL. Updated element mmsSlides of complex type tXmsBody. Updated the schema of tText. Added attribute foreground-color to complex type tText. Updated complex type tXmsDataInBatch so that attribute "id" is now "Id".
Major change (Y or N)
Change type updated.
N N N N N N N
Content removed. Content updated. Content updated. Content updated. Content updated. Content updated. Content updated.
Updated element name from "packageXml" to "xmsBatch". Updated the list of product versions.
Pr e
lim
68 / 71
in
ar
9
A
Index
Abstract data model client 44 server 27 Applicability 11 Attribute groups 25 Attributes 25 client 25 Events local - client 45 local - server 44 timer - client 45 timer - server 44 Examples DeliverXms 47 DeliverXmsBatch 49 GetServiceInfo 46 GetUserInfo 46 overview 46 send reply message from protocol server to protocol client 50
C
Capability negotiation 11 Change tracking 63 Client abstract data model 44 details 44 initialization 45 local events 45 message processing 45 overview 27 sequencing rules 45 timer events 45 timers 45 client attribute 25 Common data structures 26 Complex types 14 tAudio 15 tBody 15 tContent 16 tDeliveryError 16 tHeader 19 tImg 19 tLayout 20 tMeta 20 tMmsSlides 20 tPar 21 tRegion 21 tRoot-layout 21 tText 22 tTo 22 tUser 22 tXmsBody 23 tXmsData 23 tXmsHeader 24 tXmsResponse 24
lim
Pr e
D
Data communication 10 Data model - abstract client 44 server 27 DeliverXms example 47 DeliverXmsBatch example 49
in
I L
Local events client 45 server 44
ar
Fields - vendor-extensible 11 Full WSDL 53
GetServiceInfo example 46 GetUserInfo example 46 Glossary 7 Groups 25
Implementer - security considerations 52 Index of security parameters 52 Informative references 8 Initialization client 45 server 27 Introduction 7
M
Message processing client 45 server 28 Messages 12 attribute groups 25 attributes 25 client attribute 25 common data structures 26 complex types 14 elements 14 enumerated 12 groups 25 Mobile message packaged as MIME formatted email message 13
y
69 / 71
Namespaces 12 Normative references 8
Pr e
P
Parameters - security index 52 Preconditions 11 Prerequisites 11 Product behavior 62 Protocol clients 9
Obtaining information from an authenticated user 10 Obtaining information from the protocol server 9 Operations DeliverXms 38 DeliverXmsBatch 40 GetServiceInfo 28 GetUserInfo 34 Send reply message to client after collecting them from the recipients phone 44 Overview data communication 10 obtaining information from an authenticated user 10 obtaining information from the protocol server 9 protocol clients 9 protocol server 9 roles 9 scenarios 9 Overview (synopsis) 9
lim
in
T
ar
tAudio complex type 15 tBody complex type 15 tContent complex type 16 tDeliveryError complex type 16 tHeader complex type 19 Timer events client 45 server 44 Timers client 45 server 27 tImg complex type 19 tLayout complex type 20 tMeta complex type 20 tMmsSlides complex type 20 tPar complex type 21 Tracking changes 63 Transport 12
Mobile message packaged as MIME formatted email message message 13 namespaces 12 simple types 25 syntax 12 tAudio complex type 15 tBody complex type 15 tContent complex type 16 tDeliveryError complex type 16 tHeader complex type 19 tImg complex type 19 tLayout complex type 20 tMeta complex type 20 tMmsSlides complex type 20 tPar complex type 21 transport 12 tRegion complex type 21 tRequiredServiceTypeEnum simple type 25 tRoot-layout complex type 21 tText complex type 22 tTo complex type 22 tUser complex type 22 tXmsBody complex type 23 tXmsData complex type 23 tXmsHeader complex type 24 tXmsResponse complex type 24
Protocol server 9
R
References 7 informative 8 normative 8 Relationship to other protocols 10 Roles 9
S
Scenarios 9 Security implementer considerations 52 parameter index 52 Send reply message from protocol server to protocol client example 50 Sequencing rules client 45 server 28 Server abstract data model 27 DeliverXms operation 38 DeliverXmsBatch operation 40 GetServiceInfo operation 28 GetUserInfo operation 34 initialization 27 local events 44 message processing 28 overview 27 Send reply message to client after collecting them from the recipients phone operation 44 sequencing rules 28 timer events 44 timers 27 Simple types 25 tRequiredServiceTypeEnum 25 Standards assignments 11 Syntax messages - overview 12
y
70 / 71
V
Vendor-extensible fields 11 Versioning 11
W
WSDL 53
Pr e
lim
71 / 71
in
ar
tRegion complex type 21 tRequiredServiceTypeEnum simple type 25 tRoot-layout complex type 21 tText complex type 22 tTo complex type 22 tUser complex type 22 tXmsBody complex type 23 tXmsData complex type 23 tXmsHeader complex type 24 tXmsResponse complex type 24 Types complex 14 simple 25

MS Oms

Uploaded by

Document Informationclick to expand document information

Copyright:

Available Formats

MS Oms

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

MS Oms

Uploaded by

Copyright:

Available Formats

[MS-OMS]: Office Mobile Service Protocol Specification

Comments Initial Availability

The following terms are defined in [MS-OFCGLOS]:

The following terms are defined in [MS-GLOS]:

Protocol Overview (Synopsis)

Obtaining Information from the Protocol Server

Figure 1: Obtaining information from a protocol server

Relationship to Other Protocols

Figure 2: Obtaining information from an authenticated user

Obtaining Information from an Authenticated User

Figure 4: This protocol in relation to other protocols

Versioning and Capability Negotiation

Common Message Syntax

Prefix soap tns s

Mobile message packaged as MIME formatted e-mail message

Multimedia message content class: MS-OMS-MMS

Use this if the mobile message is a multimedia message.

Sets the message header "Content-class" to one of following values:

Message Body Incoming Text Message

Incoming Multimedia Message

Content-Type: application/smil; name="mmspresent.smil"

Plain text object.

One or more recipients of this mobile message.

Header information of this mobile message.

Base64 encoded audio object.

<xs:complexType name="tAudio"> <xs:attribute name="src" type="xs:string" use="required" /> </xs:complexType>

Body part of SMIL.

Specifies phone screen resolution, in pixels, and background color.

The presentation description part for multimedia messages.

Content of the xmsBody.

contentType: MIME content type.

Content Text Static image. Multi-frame image. MIDI audio format.

MIME type text/plain image/jpeg

Plain text. Can be used by both text and multimedia messages.

AMR sound format.

Explanation Invalid or unrecognized user identifier or password.

Message subject or body contains characters or words

Code: The "ok" value MUST be set.

Value of code attribute

content child element

recipientList child element

Notifies client that the service is terminated.

Value of code attribute other

Explanation Use this error code for all other errors.

content child element Error message

recipientList child element Recipient1; Recipient2;

Header part of SMIL.

Base64 encoded image object.

Severity: The "neutral" value MUST be set.

<xs:attribute name="region" type="xs:string" use="required" /> </xs:complexType>

Metadata indicating the author of the SMIL.

name: The server MUST ignore this value.

content: The server MUST ignore this value.

The presentation description part for multimedia messages.

Layout part of SMIL.

Specifies the slide of the multimedia message.

Specifies the region of the text or image.

Specifies phone screen resolution, in pixels, and background color.