4/ FGC Uen Rev C IPX. Implementation Guide SMS Utility API 1.0

Transcription

1 4/ FGC Uen Rev C IPX Implementation Guide SMS Utility API 1.0

2 All rights reserved. No part of this document may be reproduced in any form without the written permission of the copyright holder. The contents of this document are subject to revision without notice due to continued progress in methodology, design, and development. Ericsson shall have no liability for any error or damages of any kind resulting from the use of this document. 4/ FGC Uen Rev C Ericsson AB 2 (9)

3 Contents 1 Introduction Prerequisites Functional overview Installation Short message integration with IPX Send SM operation Send SM request Send Unicode SM operation Send Unicode SM request Send WAP Push SM operation Send WAP Push SM request Operation response Send response Response codes Acronyms and abbreviations References / FGC Uen Rev C Ericsson AB 3 (9)

4 Change History This document is updated periodically to maintain consistency with the software releases. Revision A B C Changes from previous release New document. Changed document number from 4/ FAP to 4/ FGC Updated reference to SMS 5.0 API. 4/ FGC Uen Rev C Ericsson AB 4 (9)

5 1 Introduction Internet Payment exchange (IPX) is a solution and technology for messaging and micro payments. IPX acts as a transparent, white-label Content Acquirer and Transaction Router between Operators and Content Providers. Content Providers are provided with an easily implemented interface to connect to IPX, which handles integration to the Operators. The Content Provider s interface to IPX is independent of the Consumer s device type (PC, mobile phone, PDA, etc.). Scope of Document This document provides a complementary description to the SMS Implementation Guide [1]. This document alone does not contain sufficient information for integrating with IPX. 1.1 Prerequisites The reader of this document should have read the IPX Implementation Guide, SMS [1] before reading this document. 2 Functional overview The IPX SMS Utility API is a Web Service API that provides a set of simplified, dedicated operations that may be used by any Content Provider using the IPX SMS API. The SMS Utility API provides this set of operations: Send plain text message (using GSM default alphabet) Send WAP Push Service Indication Send Unicode text message 3 Installation IPX provides an API exposed as a web service with a SOAP interface. The SOAP protocol and the IPX server are independent of the platform used on the client side, although the installation of the SOAP tools could be different. The web service API is described in WSDL ( For those not familiar with web services, IPX also provides a set of Java classes generated from the web service WSDL description. These classes can be used as an SDK and are provided by IPX upon request. 4/ FGC Uen Rev C Ericsson AB 5 (9)

6 4 Short message integration with IPX For general notation using IPX Web Service API, see [1]. 4.1 Send SM operation This operation can be used to submit a plain text message according to the GSM default alphabet, with a minimum of parameters. The DCS is set to Send SM request The send SM request element is formatted as follows: The send SM request child elements are handled by IPX as follows: Element Type M/O/I* Default Value^ Max Description length message string M 160 The message text, containing GSM default alphabet characters only (or optionally characters from the extension table), see [1]. * M = Mandatory, O = Optional, I = Ignored. ^ The default value is used if an element value is set to null. All other child elements are handled by IPX as defined in [1]. 4/ FGC Uen Rev C Ericsson AB 6 (9)

7 4.2 Send Unicode SM operation This operation can be used to submit a Unicode text message according to the UCS2 alphabet, with a minimum of parameters. The DCS is set to Send Unicode SM request The send Unicode SM request element is formatted as follows: The send SM request child elements are handled by IPX as follows: Element Type M/O/I* Default Value^ Max Description length message string M 70 The message text, containing UCS-2 characters according to [1]. * M = Mandatory, O = Optional, I = Ignored. ^ The default value is used if an element value is set to null. All other child elements are handled by IPX as defined in [1]. 4.3 Send WAP Push SM operation This operation can be used to submit a WAP Push SI message. The DCS is set to Send WAP Push SM request The send WAP Push SM request element is formatted as follows: 4/ FGC Uen Rev C Ericsson AB 7 (9)

8 The send WAP Push SM request child elements are handled by IPX as follows: Element Type M/O/I* Default Value^ Max Description length urltitle string M 49** The text to be displayed, i.e. the info value of the SI. Any character from the UTF-8 character set can be used. url string M 49** The target URL, i.e. the href value of the SI * M = Mandatory, O = Optional, I = Ignored. ^ The default value is used if an element value is set to null. ** The maximum length 49 (guaranteed delivery) is the sum of urltitle and url elements. Which characters that are used in the urltitle will affect the maximum theoretical length. E.g. if only ASCII characters in the text, the max length of the urltitle and url elements may add up to 98 characters. All other child elements are handled by IPX as defined in [1]. 4.4 Operation response All operations share the same response element. 4/ FGC Uen Rev C Ericsson AB 8 (9)

9 4.4.1 Send response The send response element is formatted as follows: The send response child elements are handled by IPX as follows in the same way as for the SMS API [1]. 4.5 Response codes For a list of applicable response codes, see [1]. 5 Acronyms and abbreviations This chapter provides a list of acronyms and abbreviations used in this document. DCS Data Coding Scheme IPX Internet Payment exchange SDK Software Development Kit SI Service Indication SM Short Message SMS Short Messaging Service SOAP Simple Object Access Protocol UCS-2 Universal Character Set (coded in 2 octets) UTF-8 UCS Transformation Format 8 WSDL Web Services Description Language 6 References This chapter provides a list of useful references. [1] IPX Implementation Guide, SMS 5.0, 2/ FGC Uen, Rev E 4/ FGC Uen Rev C Ericsson AB 9 (9)