Developer's Guide for Parlay X

     Previous  Next    Open TOC in new window    View as PDF - New Window  Get Adobe Reader - New Window
Content starts here

Using the Parlay X 2.1 interfaces

The Parlay X 2.1 interfaces provided by Network Gatekeeper follows the same architecture and structure as the Parlay X 1.0 interfaces. This section provides a description of the Parlay X 2.1 interfaces and how they are supported by Network Gatekeeper.

The Parlay X 2.1 interfaces exposed are compliant with the 3GPP Specification (TS 29.199 2005-12).

In section Parlay X 2.1 interfaces, the endpoints of the web services and which operations supported are stated. For a full description of the interfaces, refer to the specification.

 


Using the Access Web Service

All applications using Parlay X 2.1 must login to WebLogic Network Gatekeeper using the non-Parlay X Access interface in the same manner as applications based on Parlay X 1.0.

This interface returns a login ticket, which must be included in the SOAP header of all subsequent requests. More information on using this interface and on login tickets in general can be found in the section Workflow.

The service endpoint for Access used with Parlay X 2.1 is:
http://<IP-address>:<port>/parlayx2/services/Access

 


Parlay X 2.1 WSDL files

To acquire the WSDL file for each service, add ?wsdl to the service endpoint URL. For example:
http://<IP-address>:<port>/parlayx2/services/SendSms?wsdl

The notification WSDLs can be found at:
http:/<IP-address>:<port>/parlayx2/wsdl/

Where <IP-address> and <port> are the locations at which the Network Gatekeeper is configured to expose the Web Services interfaces.

The WSDL binding style is WS-I basic profile, doc/lit compliant

 


Parlay X 2.1 interfaces

Network Gatekeeper exposes the following Parlay X 2.1 interfaces:

See the sections below for detailed information about methods and parameters.

Part 1: Common

The following datatypes an exceptions are supported.

Data Types

Type
Compliant
Comments
TimeMetric
Yes
 
ChargingInformation
Yes
See note below.
SimpleReference
Yes
 

Exceptions

Exception
Compliant
Comments
ServiceException
Yes
 
PolicyException
Yes
 

Note: In some situations, applications sending SMS or MMS messages need to include charging data as an inline message part. According to specification, this data is to be presented in a ChargingInformation structure

Element name
Element type
Optional
Description
description
xsd:string
No
Description text to be used for information and billing text
currency
xsd:string
Yes
Currency identifier as defined in ISO 4217[12]
amount
xsd:string
Yes
Amount to be charged
code
xsd:string
Yes
Charging code, referencing a contract under which the charge is applied

The Parlay X 2.1 implementation supports this structure, but has a total string length (description + currency + amount + code) limit of 85 characters. If the data length exceeds this limit, a ServiceException, id SVC1005, is thrown.

Part 4: Short Messaging

Interface SendSms

Service Endpoint found at:
http://<IP-address>:<port>/parlayx2/services/SendSms

Operation
Compliant
Comments
sendSms
Yes
sendSmsLogo
Yes
Logos must be in either SmartMessaging or EMS format.
The image is not scaled.
The SmsFormat parameter is required.
sendSmsRingtone
Yes
Ringtones must be in either SmartMessaging or EMS (iMelody) format.
The SmsFormat parameter is required
getSmsDeliveryStatus
Yes

Interface SmsNotification

Service Endpoint is given by the application

Operation
Compliant
Comments
notifySmsReception
Yes
 
notifySmsDeliveryReceipt
Yes
 

Interface ReceiveSms

Service Endpoint found at:
http://<IP-address>:<port>/parlayx2/services/ReceiveSms

Operation
Compliant
Comments
getReceivedSms
Yes
The format of the parameter registrationIdentifier is <mailbox ID>\<mailbox password>
Mailbox ID and password are supplied by the service provider.
Example:
"tel:50000\apassword"

SmsNotificationManager

Service Endpoint found at:
http://<IP-address>:<port>/parlayx2/services/SmsNotificationManager

Operation
Compliant
Comments
startSmsNotification
Yes
The format of the parameter SmsServiceActivationNumber is tel:<mailbox ID>;mboxPwd=<mailbox password>
Mailbox ID and password are supplied by the service provider.
Example:
"tel:50000;mboxPwd=apassword"
Also see http://www.ietf.org/rfc/rfc3966.txt
stopSmsNotification
Yes
 

Part 5: Multimedia Messaging

Interface SendMessage

Service Endpoint found at:
http://<IP-address>:<port>/parlayx2/services/SendMessage

Operation
Compliant
Comments
sendMessage
Yes
Messages sent as Attachments. Only MMS applicable; Email not supported.
getMessageDeliveryStatus
Yes
The priority parameter not supported.

Interface ReceiveMessage

Service Endpoint found at:
http:/<IP-address>:<port>/parlayx2/services/ReceiveMessage

Operation
Compliant
Comments
getReceivedMessages
Yes
The registrationIdentifier is required. The priority parameter is not supported.
The format of the parameter registrationIdentifier is tel:<mailbox ID>\<mailbox password>
Mailbox ID and password are supplied by the service provider.
Example:
"tel:50000\apassword"
getMessageURIs
No
 
getMessage
Yes
 

Interface MessageNotification

Service Endpoint is provided by the application

Operation
Compliant
Comments
notifyMessageReception
Yes
 

Interface MessageNotificationManager

Service Endpoint found at:
http://<IP-address>:<port>/parlayx2/services/MessageNotificationManager

Operation
Compliant
Comments
startMessageNotification
Yes
The format of the parameter MessageServiceActivationNumber is tel:<mailbox ID>;mboxPwd=<mailbox password>
Mailbox ID and password are supplied by the service provider.
Example:
"tel:50000;mboxPwd=apassword"
Also see http://www.ietf.org/rfc/rfc3966.txt
stopMessageNotification
Yes
 

Part 9: Terminal Location

Interface TerminalLocation

Service Endpoint found at:
http://<IP-address>:<port>/parlayx2/services/TerminalLocation

Operation
Compliant
Comments
getLocation
Yes
Charging based on Requestor not supported
AcceptableAccuracy not supported
getTerminalDistance
Yes
Charging based on Requestor not supported
getLocationForGroup
Yes
Charging based on Requestor not supported
AcceptableAccuracy not supported

Interface TerminalLocationNotificationManager

Service Endpoint found at:
http://<IP-address>:<port>/parlayx2/services/
TerminalLocationNotificationManager

Operation
Compliant
Comments
startGeographicalNotification
No
 
startPeriodicNotification
Yes
Duration not supported
endNotification
Yes
 

Interface TerminalLocationNotification

Service Endpoint provided by the application

Operation
Compliant
Comments
locationNotification
Yes
 
locationError
Yes
Address not supported
locationEnd
Yes
 

Support for dual senderName and senderAddress parameters

The Parlay X 1.0 implementation in WebLogic Network Gatekeeper uses a non-standard structure for the senderName parameter in the sendSms, sendSmsLogo and SendSmsRingtone operations of the SendSMS interface and the senderAddress parameter in the sendMessage operation of the SendMessage interface. The format for this string is as follows:

tel:<mailbox ID>\<mailbox password>\tel:<originator address>.

This format continues to be supported for Parlay X 2.1 (It must be used if the application also uses Parlay X 1.0 interfaces.).

The Network Gatekeeper Parlay X 2.1 implementation also supports the specification-defined format for the senderName parameter.

To use this format the mailbox ID and mailbox password must be configured by the operator when the application account is created in the Network Gatekeeper.


  Back to Top       Previous  Next