Is XML HTTP Cellcube
Is XML HTTP Cellcube
Interface specification
Release 3.6
Legal notice
Proprietary and confidential.
Ref:
IS-XML-HTTPCELLCUBE
Rel: 3.6
Cellcube XML/HTTP
Interface specification
Cellcube XML/HTTP
Confidential
Page iii
Table of Contents
1. Introduction ............................................................................................................................................... 1
1.1. GSM USSD ..................................................................................................................................... 1
1.2. Cellcube .......................................................................................................................................... 1
1.3. External Service Provider interface................................................................................................. 1
1.4. USSD Browsing versus WAP and WWW - Features....................................................................... 2
1.5. USSD Browsing versus WAP and WWW - Architecture ................................................................. 2
1.6. XML/HTTP example ........................................................................................................................ 3
1.7. Architecture ..................................................................................................................................... 4
1.7.1. Stand-alone Cellcube configuration..................................................................................... 5
1.7.2. Cellcube, HTTP module option, and HTTP servers ............................................................ 5
1.7.3. Cellcube, HTTP module option and third-party HTTP services........................................... 6
2. Compliance requirements........................................................................................................................ 8
3. XML features ........................................................................................................................................... 10
3.1. Cellcube XML................................................................................................................................ 10
3.1.1. Multiple pages ................................................................................................................... 10
3.1.2. Content adaptation ............................................................................................................ 10
3.1.3. Examples........................................................................................................................... 10
3.2. Links.............................................................................................................................................. 11
3.3. Forms ............................................................................................................................................ 11
3.4. Includes......................................................................................................................................... 12
3.5. Volatile contents ............................................................................................................................ 13
3.6. Multiple languages ........................................................................................................................ 13
3.7. Server hang-up ............................................................................................................................. 14
3.8. Navigation labels ........................................................................................................................... 15
3.9. Link labels ..................................................................................................................................... 15
3.10. Navigation control........................................................................................................................ 16
3.11. Navigation shortcuts.................................................................................................................... 16
3.12. Forbid shortcuts .......................................................................................................................... 17
3.13. XML redirect................................................................................................................................ 18
3.14. Billing........................................................................................................................................... 18
3.15. Plugin functions and commands ................................................................................................. 19
3.15.1. Static Link ........................................................................................................................ 19
3.16. Dynamic content in Links ............................................................................................................ 21
3.16.1. Description....................................................................................................................... 21
3.16.2. Evaluation Format............................................................................................................ 21
3.16.3. Session Field ................................................................................................................... 22
3.16.4. Variable evaluation .......................................................................................................... 22
3.16.5. Plugin Filter...................................................................................................................... 23
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
Ref:
IS-XML-HTTPCELLCUBE
Rel: 3.6
Cellcube XML/HTTP
Interface specification
Cellcube XML/HTTP
Confidential
Page iv
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
Ref:
IS-XML-HTTPCELLCUBE
Rel: 3.6
Cellcube XML/HTTP
Interface specification
Cellcube XML/HTTP
Confidential
Page v
List of Tables
1-1. USSD Browsing versus WAP and WWW - Features ............................................................................... 2
1-2. USSD Browsing versus WAP and WWW - Architecture.......................................................................... 2
2-1. XML requirements ................................................................................................................................... 8
2-2. HTTP requirements ................................................................................................................................. 9
4-1. User identity........................................................................................................................................... 30
4-2. Customer profile .................................................................................................................................... 31
4-3. Handset capabilities .............................................................................................................................. 31
4-4. Handset capabilities .............................................................................................................................. 32
A-1. Limitations ............................................................................................................................................. 34
B-1. pages attributes..................................................................................................................................... 37
B-2. page attributes....................................................................................................................................... 37
B-3. a attributes............................................................................................................................................. 38
B-4. form attributes....................................................................................................................................... 38
B-5. entry attributes..................................................................................................................................... 38
B-6. include attributes ................................................................................................................................. 39
B-7. subst attributes..................................................................................................................................... 39
B-8. redirect attributes ............................................................................................................................... 39
B-9. l attributes............................................................................................................................................. 39
List of Figures
1-1. Standalone architecture........................................................................................................................... 5
1-2. Gateway architecture ............................................................................................................................... 5
1-3. Open gateway architecture ...................................................................................................................... 6
3-1. Plugin function synopsis ........................................................................................................................ 19
3-2. Plugin command synopsis ..................................................................................................................... 20
B-1. Cellcube XML DTD version 1.1 ............................................................................................................. 35
List of Examples
1-1. XML/HTTP overview................................................................................................................................ 3
3-1. URLs...................................................................................................................................................... 10
3-2. Links ...................................................................................................................................................... 11
3-3. Form ...................................................................................................................................................... 12
3-4. Include ................................................................................................................................................... 12
3-5. Language............................................................................................................................................... 14
3-6. Server hang-up...................................................................................................................................... 14
3-7. Navigation labels ................................................................................................................................... 15
3-8. Link label ............................................................................................................................................... 15
3-9. Shortcut ................................................................................................................................................. 16
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
Ref:
IS-XML-HTTPCELLCUBE
Rel: 3.6
Cellcube XML/HTTP
Interface specification
Cellcube XML/HTTP
Confidential
Page vi
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
Ref:
IS-XML-HTTPCELLCUBE
Rel: 3.6
Cellcube XML/HTTP
Interface specification
Chapter 1. Introduction
Confidential
Page 1
Chapter 1. Introduction
1.1. GSM USSD
Specifies a transparent bearer between mobile stations and service platforms through the GSM network.
USSD was originally intended to allow operators to offer specific services (i.e. outside the scope of GSM
specifications) to their mobile subscribers. USSD is typically invoked when a user dials a number which
matches [*#]([*#])([*#])1[0-9]([0-9])(*...)#, for example #100# or *#100*1234#. USSD
messages are similar to SMS messages, but may contain up to 182 characters, and are typically
transmitted 7 times faster.
Phase 2: USSD sessions consist of an initial request followed by an arbitrary number of interactions.
Sessions may also be initiated by the network rather than by the user.
Phase 2+: USSD messages carry extended routing information for use with SIM-specific or TE-specific
services.
1.2. Cellcube
USSD Browsing services are implemented in Cellcube, a hardware and software service platform managed
by GSM operators and connected to GSM networks, provisioning databases and prepaid/postpaid billing
systems.
USSD Browsing services are described in XML-formatted files containing menus, redirections and
hyper-links to other files and directories. Thanks to this open XML format, Cellcube can provide a consistent,
service-independent presentation layer for navigating through menus, filling forms, consulting help, etc. With
an optional XML/HTTP module, Cellcube also supports links to remote HTTP servers. This allows Cellcube
to act as an intelligent gateway between GSM networks and external service providers (ESPs).
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
Ref:
IS-XML-HTTPCELLCUBE
Cellcube XML/HTTP
Confidential
Interface specification
Rel: 3.6
Chapter 1. Introduction
Page 2
Since Cellcube is tightly integrated with the operators GSM network and billing system, it can be configured
to: 1
Provide user information to external service providers (user identity, commercial profile, preferences)
USSD Browsing
WWW
Message length
(characters)
Up to 182a
Hyper-links
Yes
Yes
Yes
Forms
Yes
Yes
Yes
Images
No
Yes
Yes
Unlimited
Notes:
a. Depending on networks and handset capabilities
USSD Browsing
WWW
Display
Phone screen
Phone screen
Browser
Input
Phone MMI
Phone MMI
Keyboard/mouse
Bearer 1
Navigation context
Cellcube
Phone firmware
WWW browser
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
Ref:
IS-XML-HTTPCELLCUBE
Cellcube XML/HTTP
Confidential
Interface specification
Rel: 3.6
Chapter 1. Introduction
Page 3
Functions
USSD Browsing
WWW
Cookies
Cellcube
WWW browser
Bookmarks
Cellcube
Phone firmware
WWW browser
Cache
Cellcube
Phone firmware
WWW browser
Bearer 2
GSM CSD
Billing (duration-based)
Cellcube
GSM network
XML/WML/HTML
decoding
Cellcube
WAP GW
WWW browser
Bearer 3
HTTP/TCP/IP
HTTP/TCP/IP
Billing(content-based)
Cellcube
Service provider
Service provider
Provisioning
Cellcube
Service provider
Service provider
Service preferences
Cellcube
Service provider
Service provider
Location information
Cellcube
Send SMS/MMS/EMS
Cellcube
Bearer 4
HTTP/TCP/IP
Contents
Service provider
Service provider
Service provider
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
Ref:
IS-XML-HTTPCELLCUBE
Cellcube XML/HTTP
Confidential
Interface specification
Rel: 3.6
Chapter 1. Introduction
Page 4
Handset
#100# [SEND]
Cellcube
#100#
Welcome to news.com
1:Weather
2:Sport
2 [SEND]
GET / HTTP/1.0
<page>
Welcome to news.com
<a href="weather.xml">Weather</a>
<a href="sport.xml">Sport</a>
</page>
Sport
1:Soccer
2:Sailing
1 [SEND]
ESP
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
Ref:
IS-XML-HTTPCELLCUBE
Cellcube XML/HTTP
Confidential
Interface specification
Rel: 3.6
Chapter 1. Introduction
Page 5
1.7. Architecture
1.7.1. Stand-alone Cellcube configuration
Figure 1-1. Standalone architecture
GSM network
Cellcube
XML
File transfer
(batch)
XML authoring
environment
Local files
Other operator platforms
(provisioning, prepaid, ...)
In the configuration of Figure 1-1, Cellcube retrieves XML documents from the local filesystem. Documents
must comply with the requirements described in this specification, but can be authored with any XML editing
software or even with a text editor.
Even though these documents are static files, they may contain invocations of Cellcubes plugin functions
and commands. This makes it possible to implement complex dynamic services by combining generic
building blocks.
XML
XML/HTTP
GSM network
Cellcube
HTTP servers
XML
Local files
Other operator platforms
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
Ref:
IS-XML-HTTPCELLCUBE
Cellcube XML/HTTP
Confidential
Interface specification
Rel: 3.6
Chapter 1. Introduction
Page 6
In the configuration of Figure 1-2, some services are implemented in HTTP servers managed by the
operator. Cellcube retrieves Cellcube-compliant XML documents from these servers with HTTP requests in
real-time. Any HTTP server product may be used as long as it complies with the Cellcube Interface and
HTTP requirements described in this specification. Cellcube-compliant XML documents may be generated
from existing data sources and applications with off-the-shelf XML tools such as XSL translators.
With this architecture, developing USSD Browsing services is very similar to developing WWW or WAP
services. Cellcube aims to provide all the functionality that is required to bridge the gap between USSD and
legacy WAP and WWW infrastructures:
page splitting
cookies
language preferences
bookmarks
GSM network
Remote
HTTP servers
Cellcube
Local
HTTP servers
XML
Local files
In the configuration of Figure 1-3, Cellcube routes specific USSD service codes or menu items to HTTP
servers operated by third parties. The operator manages privacy and security authorizations such as which
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
Ref:
IS-XML-HTTPCELLCUBE
Rel: 3.6
Cellcube XML/HTTP
Interface specification
Chapter 1. Introduction
Confidential
Page 7
servers need to know about the users identity and location, which servers are allowed to invoke privileged
plugin functions and commands, etc.
Notes
1. Actual functionality depends on the level of integration with the GSM network.
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
Ref:
IS-XML-HTTPCELLCUBE
Cellcube XML/HTTP
Interface specification
Rel: 3.6
Confidential
Page 8
"Cellcube Mandatory" means that a feature is always implemented and available for all ESPs.
The feature is an optional functionality of Cellcube and must be specifically licensed by the operator, or
The feature is provided for reference and will be available in future releases of the product, or
The feature must be explicitly authorized by the operator. Authorization may be ESP-specific or
user-specific (e.g. depending on privacy preferences).
In both cases, ESPs should contact the operator in order to know which optional features are available.
"ESP Mandatory" means that the ESP must support the feature in order to offer USSD Browsing services.
"ESP Optional" means that the ESP is not required to support the feature.
Please contact Cellicium for up-to-date information about feature availability and release schedules.
Table 2-1. XML requirements
Feature
Roadmap Cellcube
ESP
Summary
Cellcube XML
v1
HTML support
Hyper-links
v1
Forms
v1
Text input
Includes
v1
Inclusion of pages
Volatile contents
v1
Multiple languages
v1
Multi-language documents
Server hang-up
v1
Navigation labels
v1
Link labels
v1
Navigation control
v1
Navigation shortcuts
v1
Forbid shortcuts
v1
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
Ref:
IS-XML-HTTPCELLCUBE
Cellcube XML/HTTP
Interface specification
Rel: 3.6
Confidential
Page 9
Feature
Roadmap Cellcube
ESP
Summary
XML redirect
v1
Billing
Plugin functions and
commands
v1
Avail
Cellcube
ESP
Summary
Service code
allocation
v1
URL input
IP networking
v1
HTTP
v1
QoS requirements
v1
HTTP errors
v1
Error notification
v1
HTTP-S
Encrypted connections
Keep-Alive
Cache-Control
User identity
Customer profile
Handset capabilities
User location
HTTP cookies
v1
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
Ref:
IS-XML-HTTPCELLCUBE
Rel: 3.6
Cellcube XML/HTTP
Interface specification
Confidential
Page 10
Text that does not fit in a single USSD message will be split into multiple messages. Links will be added
automatically so that the user can navigate between fragments. The length of fragments may depend on
GSM networks and handset capabilities.
Link labels may be formatted in various ways depending on the capabilities of the handset.
Characters which are not supported by the users handset may be translated, e.g. would be replaced
with e.
3.1.3. Examples
Example 3-1. URLs
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE pages SYSTEM "cellflash-1.1.dtd">
<pages descr="News">
<page>
Headlines<br/>
<a href="#item1">Interest rates cut</a><br/>
<a href="#item2">Concorde resumes service</a><br/>
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
Ref:
IS-XML-HTTPCELLCUBE
Rel: 3.6
Cellcube XML/HTTP
Interface specification
Chapter 3. XML features
Confidential
Page 11
</page>
<page tag="item1">
WASHINGTON-In a much anticipated move, the Federal Reserve
announced new rate cuts amid growing economic concerns.<br/>
<a href="#item2">Next article</a>
</page>
<page tag="item2">
PARIS-Air France resumed its Concorde service Monday.
The plane had been grounded following a tragic accident.
</page>
</pages>
Assuming the file in Example 3-1 is served from http://www.news.com/business.xml, URLs will be
interpreted as follows:
http://www.news.com/business.xml
http://www.news.com/business.xml#
http://www.news.com/business.xml#item1
will display the first article and a link to the second article.
http://www.news.com/business.xml#item2
3.2. Links
Links in Cellcube XML pages are similar to HTML links. Cellcube will automatically display pages with
hyper-links as menus with numbered items. URLs may be relative, i.e. the server address, absolute path, or
file name may be omitted.
Example 3-2. Links
<a
<a
<a
<a
<a
href="http://www.myservice.com:8080/path/to/file.xml">Remote link</a>
href="/path/to/file.xml">Absolute local link</a>
href="otherfile.xml">Relative local link</a>
href="#otherpage">Relative local link (same file)</a>
href="#">Back to the main page</a>
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
Ref:
IS-XML-HTTPCELLCUBE
Cellcube XML/HTTP
Confidential
Interface specification
Rel: 3.6
Page 12
3.3. Forms
Cellcube supports simple input with XML elements similar to HTML forms. The contents of the form will be
sent with a HTTP GET (default). Alternatively, method="POST" can be specified in the XML form element.
Example 3-3. Form
Handset
Cellcube
ESP
---
Weather service.
ZIP code ?
75000 [SEND]
75000
<page>
Weather service.
<form action="/cgi/weather">
<entry kind="digits" var="zip">
<prompt>ZIP code ?</prompt>
</entry>
</form>
</page>
3.4. Includes
Cellcube pages may include the contents of other pages. Note that Cellcube may limit the number of
includes in order to avoid infinite loops.
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
Ref:
IS-XML-HTTPCELLCUBE
Cellcube XML/HTTP
Confidential
Interface specification
Rel: 3.6
Page 13
Handset
#100# [SEND]
Cellcube
#100#
ESP
Select a marketplace
1:New York
2:Paris
3:London
<page>
<a href="paris.xml">Paris</a>
<a href="london.xml">London</a>
</page>
The mobile user selects an invalid menu item. Cellcube replies with an informational error message. The
user invokes Back to return to the menu.
The mobile user invokes a system command (bookmarks, bill inquiry, ...). Cellcube replies with a system
message. The user invokes Back to return to the service page.
The mobile user hangs up or is temporarily disconnected by the network. The user reconnects within the
session recovery delay (typically 2 minutes). Navigation resumes at the page where the session was
interrupted.
This behavior can be disabled by setting the attribute volatile="true" in XML page elements.
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
Ref:
IS-XML-HTTPCELLCUBE
Cellcube XML/HTTP
Confidential
Interface specification
Rel: 3.6
Page 14
Handset
Cellcube
ESP
--<page>
<lang>
<fr>La mto de la semaine</fr>
<en>This weeks weather</en>
<l code="de">Wetter Woche</de>
</lang>
</page>
read language preferences
This weeks weather
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
Ref:
IS-XML-HTTPCELLCUBE
Cellcube XML/HTTP
Confidential
Interface specification
Rel: 3.6
Page 15
Handset
Cellcube
ESP
--<page nav="end">
Thank you for using news.com !
</page>
Note that the use of complex alphanumeric labels might prevent Cellcube from adapting contents and
navigation for phase 1 handsets.
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
Ref:
IS-XML-HTTPCELLCUBE
Cellcube XML/HTTP
Interface specification
Rel: 3.6
Confidential
Page 16
ESPs can alter the behavior of these commands with the hist and ismenu attributes in XML page
elements:
hist="donthist"
hist="dohist"
selects which page in a sequence of redirections will be used when the user invokes
Back.
hist="bookmark"
ismenu="true"
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
Ref:
IS-XML-HTTPCELLCUBE
Cellcube XML/HTTP
Confidential
Interface specification
Rel: 3.6
Page 17
Handset
#100*2# [SEND]
Cellcube
#100*2#
ESP
GET / HTTP/1.0
<page>
Welcome to news.com
<a href="weather.xml">Weather</a>
<a href="sport.xml">Sport</a>
</page>
shortcut used
Sport
1:Soccer
2:Sailing
<page>
Sport
<a href="soccer.xml">Soccer</a>
<a href="sailing.xml">Sailing</a>
</page>
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
Ref:
IS-XML-HTTPCELLCUBE
Cellcube XML/HTTP
Confidential
Interface specification
Rel: 3.6
Page 18
Handset
Cellcube
ESP
--<page>
Select a product
<a href="/order?p=1">Product1</a>
<a href="/order?p=2">Product2</a>
</page>
Select a product
1:Product1
2:Product2
2*1 [SEND]
2*1
Please confirm !
1:Accept
2:Cancel
3.14. Billing
Cellcube may bill services to the users mobile subscription account on behalf of ESPs. This is achieved
with cost attribute in XML page elements. The value of this attribute refers to pre-configured tariff plans and
billing procedures which must be customized for each billing environment.
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
Ref:
IS-XML-HTTPCELLCUBE
Rel: 3.6
Cellcube XML/HTTP
Interface specification
Chapter 3. XML features
Confidential
Page 19
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
Ref:
IS-XML-HTTPCELLCUBE
Cellcube XML/HTTP
Interface specification
Rel: 3.6
Confidential
Page 20
erl://MOD:NAME
<page>
<subst.../>
</page>
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
Ref:
IS-XML-HTTPCELLCUBE
Rel: 3.6
Cellcube XML/HTTP
Interface specification
Chapter 3. XML features
Confidential
Page 21
<page tag="home">
<redirect src="erl://svc_util:subscr?prepaid=#pre,postpaid=#post"/>
</page>
<page tag="pre">
Your credit is: <include src="erl://svc_prepaid:credit"/><br/>
<a href="#reload">Reload</a>
<a href="#main">Main menu</a>
</page>
<page tag="post">
Your current bill is <subst name="BILL"/><br/>
<a href="#main">Main menu</a>
</page>
</pages>
Evaluation Request: $
Evaluation Begin: (
Evaluation End: )
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
Ref:
IS-XML-HTTPCELLCUBE
Rel: 3.6
Cellcube XML/HTTP
Interface specification
Chapter 3. XML features
Confidential
Page 22
Note: to prevent these characters from being interpreted, you will need to escape them inside evaluation
string: $ must be written \\$, and ( must be written \\(.
ussd_code
subscription
language
bearer
anonymous
vlr
msisdn
imsi
imei
ussdsize
end_ussdsize
Example 3-15. plugin call with dynamic argument: session field evaluation
An Users USSD session has these characteristics.
imsi: 208990099991234
msisdn: +33699991234
vlr: +33900001234
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
Ref:
IS-XML-HTTPCELLCUBE
Rel: 3.6
Cellcube XML/HTTP
Interface specification
Chapter 3. XML features
Confidential
Page 23
(public,var)="1"
(public,var2)="value2"
(test,var)="test_ok"
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
Ref:
IS-XML-HTTPCELLCUBE
Cellcube XML/HTTP
Interface specification
Rel: 3.6
Confidential
Page 24
URL
#100
http://www.news.com/
**#100
http://www.weather.com/tomorrow.xml
URL
#100
file:/main_menu.xml
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
Ref:
IS-XML-HTTPCELLCUBE
Cellcube XML/HTTP
Interface specification
Rel: 3.6
Confidential
Page 25
Service code
URL
#100
file:/url_input.xml
4.3. IP networking
The network connection between Cellcube and ESPs must be over IPv4, either through a private
connection, or through the Internet. For "Pull" services, connections will always be initiated by Cellcube.
4.4. HTTP
ESPs must expect HTTP 1.0 and 1.1 GET, HEAD and POST requests from Cellcube.
Cellcube POST requests:
ESP replies;
The body must be strictly compliant with the Cellcube DTD (see Appendix B)
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
Ref:
IS-XML-HTTPCELLCUBE
Rel: 3.6
Cellcube XML/HTTP
Interface specification
Chapter 4. HTTP interface features
Confidential
Page 26
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
Ref:
IS-XML-HTTPCELLCUBE
Cellcube XML/HTTP
Confidential
Interface specification
Rel: 3.6
Page 27
Handset
Cellcube
---
ESP
An error occurred. We
will be investigating it
shortly. Please try
again later.
close
close
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
Ref:
IS-XML-HTTPCELLCUBE
Cellcube XML/HTTP
Confidential
Interface specification
Rel: 3.6
Page 28
Handset
Cellcube
ESP
---
An error occurred. We
will be investigating it
shortly. Please try
again later.
<page>
Welcome to news.com
<a href="weather.xml">Weather</a>
<a href="sport.xml">Sport</a>
parsing fails
close
POST /cgi-bin/reject HTTP/1.0
close
4.8. HTTP-S
HTTP-S may be used as an alternative to HTTP in order to authenticate the ESP. Depending on the security
requirements of the service, the ESP should configure its HTTP server so that it requires SSL client
authentication.
4.9. Keep-Alive
The HTTP header field Connection: Keep-Alive can be used to negotiate that a single TCP connection
will be used to transport multiple requests and responses. This improves HTTP throughput.
Notes:
Cellcube may send requests from several users on a single TCP connection. This is different from the
behavior of single-user Web browsers.
Cellcube may load-balance requests from the same USSD session over multiple HTTP connections.
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
Ref:
IS-XML-HTTPCELLCUBE
Cellcube XML/HTTP
Confidential
Interface specification
Rel: 3.6
Page 29
4.10. Cache-Control
Cellcube may use HTTP Cache-Control: header fields in order to reduce network traffic.
The ESP should use Cache-Control: private for user-dependent data, and Cache-Control: public
otherwise. Validity of the cached pages is one hour for public cache, and equal to the session duration for
private cache.
Cellcube can also force the use of one of those cache types. See [MAN_CELLCUBE_SW] parameter
pserver::xmlhttp_hosts.
A page will be searched for in the following order until found:
public cache,
private cache,
Handset
#100# [SEND]
Cellcube
#100#
ESP
Welcome to news.com
1:Sport
1 [SEND]
<pages>
<page>
Welcome to news.com
<a href="\#sport">Sport</a>
</page>
<page tag="sport">
Sport
<a href="soccer.xml">Soccer</a>
<a href="sailing.xml">Sailing</a>
</page>
</pages>
1
index.xml#sport found in cache
Sport
1:Soccer
2:Sailing
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
Ref:
IS-XML-HTTPCELLCUBE
Cellcube XML/HTTP
Confidential
Interface specification
Rel: 3.6
Page 30
Handset
Cellcube
---
ESP
GET /login?user=XXX&password=YYY
HTTP/1.0 200 OK
Set-Cookie: session=12345; path=/
Login successful.
1:Continue
1 [SEND]
<page>
Login successful.
<a href="continue.xml">Continue</a>
</page>
GET /continue.xml HTTP/1.0
Cookie: session=12345
Value
User-Identity
User-UID
User-MSISDN
E164 address.
User-IMSI
E212 address.
User-Language
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
Ref:
IS-XML-HTTPCELLCUBE
Rel: 3.6
Cellcube XML/HTTP
Interface specification
Chapter 4. HTTP interface features
Confidential
Page 31
Contents
User-Subscription
Contents
Handset-Phase
1 or 2
Handset-Input
Handset-MaxSize
Integer
Handset-TAC
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
Ref:
IS-XML-HTTPCELLCUBE
Rel: 3.6
Cellcube XML/HTTP
Interface specification
Confidential
Name
Contents
Handset-FAC
Handset-SNR
Handset-IMEI
IMEI.
Page 32
4.15. Variables
Cellcube can provide ESPs with information about variables stored during the USSD session.
These variables is stored thanks svc_variable plugins see [FS_CELLCUBE_STDPLUGINS] for more
information.
Each variable is defined by a service name and a variable name. For each ESP a list of authorized service
name can be defined.
Example 4-12. Variable
If during USSD session, two variables are defined (public,var)=3 and (private,var)=4.
ESPs ,which its configuration authorize to receive public variables, will receive inside Header or Cookie:
public-var: 3.
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
Ref:
IS-XML-HTTPCELLCUBE
Rel: 3.6
Cellcube XML/HTTP
Interface specification
Chapter 4. HTTP interface features
Confidential
Page 33
Contents
Loc-VLR
Loc-Lat
Loc-Lon
Loc-Country
Country code
Loc-City
City name
Loc-ZIP
ZIP code.
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
Ref:
IS-XML-HTTPCELLCUBE
Cellcube XML/HTTP
Interface specification
Rel: 3.6
Appendix A. Limitations
Confidential
Page 34
Appendix A. Limitations
Table A-1 lists the Absolute Maximum Value and Recommended Maximum Value for some parameters.
Quality of service may be affected if these limitations are exceeded.
Table A-1. Limitations
Parameter
Abs Max
Rec Max
10 KB
10
1 KB
# of redirections per
message
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
10
Notes
Ref:
IS-XML-HTTPCELLCUBE
Cellcube XML/HTTP
Interface specification
Rel: 3.6
Confidential
Page 35
lang (l|da|de|el|en|es|fi|fr|it|nl|pt|sv)*>
l (%pckw;)*>
l code CDATA #REQUIRED>
da (%pckw;)*>
de (%pckw;)*>
el (%pckw;)*>
en (%pckw;)*>
es (%pckw;)*>
fi (%pckw;)*>
fr (%pckw;)*>
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
Ref:
IS-XML-HTTPCELLCUBE
Cellcube XML/HTTP
Interface specification
Rel: 3.6
<!ELEMENT
<!ELEMENT
<!ELEMENT
<!ELEMENT
it
nl
pt
sv
(%pckw;)*>
(%pckw;)*>
(%pckw;)*>
(%pckw;)*>
<!ELEMENT a (%citem;|help)*>
<!ATTLIST a
cost
CDATA #IMPLIED
href
CDATA #REQUIRED
key
CDATA #IMPLIED>
<!ELEMENT form
(entry|choice)*>
<!ATTLIST form
action
CDATA #REQUIRED
method
(GET|POST) "GET"
keywords
(default|disable|user_defined) "default"
back
CDATA #IMPLIED
menu
CDATA #IMPLIED
home
CDATA #IMPLIED
help
CDATA #IMPLIED
sms
CDATA #IMPLIED
bookmark
CDATA #IMPLIED
price
CDATA #IMPLIED
reset_lang CDATA #IMPLIED>
<!ELEMENT entry (prompt,default?)>
<!ATTLIST entry
var
CDATA #IMPLIED
pref
CDATA #IMPLIED
width
CDATA #IMPLIED
kind
(alphanum|digits) "alphanum"
type
(text|password|ccnumber) "text">
<!ELEMENT prompt (%citem;)*>
<!ELEMENT default (%citem;)*>
<!ELEMENT choice (item)*>
<!ATTLIST choice
var
CDATA #IMPLIED
default CDATA #IMPLIED
pref
CDATA #IMPLIED>
<!ELEMENT item (%citem;)*>
<!ATTLIST item
code
CDATA #REQUIRED>
<!ELEMENT include EMPTY>
<!ATTLIST include
src CDATA #REQUIRED>
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
Confidential
Page 36
Ref:
IS-XML-HTTPCELLCUBE
Cellcube XML/HTTP
Confidential
Interface specification
Rel: 3.6
Type
Default
Notes
descr
String
None
Informational
expiration
lifetime
Type
Default
Notes
cost
String
""
Section 3.14
tag
String
""
Section 3.1.1
hist
default
donthist
dohist
bookmark
default
Section 3.10
volatile
true
false
false
Section 3.10
nav
default
end
stop
default
Section 3.7
Section 3.12
backtext
""
"notext"
String
""
Section 3.8
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
Page 37
Ref:
IS-XML-HTTPCELLCUBE
Cellcube XML/HTTP
Confidential
Interface specification
Rel: 3.6
Attribute
Type
Default
Notes
menutext
""
"notext"
String
""
Section 3.8
log
String
""
ismenu
true
false
false
Section 3.10
descr
String
""
Informational
Type
Default
Notes
cost
String
""
href
String
None
Section 3.2
key
String
""
Section 3.9
Type
Default
Notes
action
String
None
Section 3.3
method
GET
POST
GET
Section 3.3
keywords
back
menu
home
help
sms
bookmark
price
reset_lang
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
Page 38
Ref:
IS-XML-HTTPCELLCUBE
Cellcube XML/HTTP
Confidential
Interface specification
Rel: 3.6
Type
Default
Notes
var
String
""
Section 3.3
pref
width
kind
alphanum
digits
alphanum
type
text
password
ccnumber>
text
Type
Default
Notes
src
String
None
Section 3.4
Type
Default
Notes
name
String
None
Section 3.15
Type
Default
Notes
src
String
None
Section 3.13
Type
Default
Notes
code
String
None
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
Page 39
Ref:
IS-XML-HTTPCELLCUBE
Rel: 3.6
Cellcube XML/HTTP
Confidential
Interface specification
Appendix C. XML example
Page 40
tag="cutlink01"
tag="cutlink02"
tag="cutlink03"
tag="cutlink04"
tag="cutlink05"
tag="cutlink06"
tag="cutlink07"
tag="cutlink08"
tag="cutlink09"
into 3+3
........
........
........
........
........
........
........
........
........
hist="bookmark"><title>Page01</title>At
hist="bookmark"><title>Page02</title>At
hist="bookmark"><title>Page03</title>At
hist="bookmark"><title>Page04</title>At
hist="bookmark"><title>Page05</title>At
hist="bookmark"><title>Page06</title>At
hist="bookmark"><title>Page07</title>At
hist="bookmark"><title>Page08</title>At
hist="bookmark"><title>Page09</title>At
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
page
page
page
page
page
page
page
page
page
01</page>
02</page>
03</page>
04</page>
05</page>
06</page>
07</page>
08</page>
09</page>
Ref:
IS-XML-HTTPCELLCUBE
Rel: 3.6
Cellcube XML/HTTP
Interface specification
Appendix C. XML example
<a href="#back1">default</a><br/>
<a href="#back2">dohist</a><br/>
<a href="#back3">donthist</a><br/>
<a href="#back4">bookmark</a><br/>
<a href="#back5">ismenu</a><br/>
</page>
<page tag="back1" hist="">
<a href="#backend">From default</a>
</page>
<page tag="back2" hist="dohist">
<a href="#backend">From dohist</a>
</page>
<page tag="back3" hist="donthist">
<a href="#backend">From donthist</a>
</page>
<page tag="back4" hist="bookmark">
<title>Back4</title>
<a href="#backend">From bookmark</a>
</page>
<page tag="back5" ismenu="true">
<a href="#back5_1">Down 1</a>
</page>
<page tag="back5_1">
<a href="#back5_2">Down 2</a>
</page>
<page tag="back5_2" ismenu="true">
<a href="#back5_3">Down 3</a>
</page>
<page tag="back5_3">
<a href="#back5_4">Down 4</a>
</page>
<page tag="back5_4">
Try "back" and "menu" from here.
</page>
<page tag="backend">Back to where ?</page>
<page tag="close" nav="end">
Closing.<br/>
<a href="#">Unusable link</a>
</page>
<page tag="stop" nav="stop">
Please confirm your payment.<br/>
<a href="#cutlink01">Confirm</a>
<a href="#cutlink02">Cancel</a>
</page>
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
Confidential
Page 41
Ref:
IS-XML-HTTPCELLCUBE
Rel: 3.6
Cellcube XML/HTTP
Interface specification
Appendix C. XML example
Confidential
Page 42
<page tag="tags">
<title>Testing printing or not of menu and back links</title>
Page with menu and back links<br/>
<a href="#tags_nomenu">No menu</a>
<a href="#tags_noback">No back</a>
<a href="#tags_long1">Too long for back</a>
<a href="#tags_long2">Too long for menu</a>
</page>
<page tag="tags_nomenu" menutext="notext">
<title>Page without menu link</title>
Page without menu link
</page>
<page tag="tags_noback" backtext="notext">
<title>Page without back link</title>
Page without back link
</page>
<page tag="tags_long1">
<title>Page without back link because too long</title>
1.......10........20........30........40........50........60
........70........80........90.......100.......110.......120
.......130.......140...146
</page>
<page tag="tags_long2">
<title>Page without back and menu links because too long</title>
1.......10........20........30........40........50........60
........70........80........90.......100.......110.......120
.......130.......140....147
</page>
<page tag="longlink">
<title>Page with a link that uses all page -> truncated</title>
<a href="#longlinkdest">
1-------10--------20--------30--------40--------50--------60--------70--------80--------90------</a>
<a href="#longlinkdest">Second link</a>
</page>
<page tag="longlinkdest">
Page
</page>
</pages>
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
Ref:
IS-XML-HTTPCELLCUBE
Rel: 3.6
Cellcube XML/HTTP
Interface specification
Appendix C. XML example
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
Confidential
Page 43
Ref:
IS-XML-HTTPCELLCUBE
Cellcube XML/HTTP
Interface specification
Rel: 3.6
References
Confidential
Page 44
References
[FS_CELLCUBE_STDPLUGINS] Cellicium, CELLCUBE_SW, Cellcube standard plugins: Functional
specification.
[MAN_CELLCUBE_SW] Cellicium, CELLCUBE_SW, Cellcube software application: Reference manual.
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
Ref:
IS-XML-HTTPCELLCUBE
Cellcube XML/HTTP
Interface specification
Rel: 3.6
Glossary
E1/T1/J1
A physical layer used by SS7 (among others). See G703/G704.
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
Confidential
Page 45
Ref:
IS-XML-HTTPCELLCUBE
Cellcube XML/HTTP
Interface specification
Rel: 3.6
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
Confidential
Page 46
Ref:
IS-XML-HTTPCELLCUBE
Cellcube XML/HTTP
Interface specification
Rel: 3.6
Confidential
Page 47
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential
Ref:
IS-XML-HTTPCELLCUBE
Cellcube XML/HTTP
Interface specification
Rel: 3.6
Confidential
Page 48
Cellicium 2001,2002,2003,2004,2005,2006
All rights reserved - Proprietary and confidential