Application Development Guide

Document Roadmap

Document Scope and Audience

Guide to This Document

Terminology

Related Documentation

Creating Applications for WebLogic Network Gatekeeper

Basic Concepts

Communication Services

Traffic Types

Application-initiated Traffic

Network-triggered Traffic

Management Structures

Functional Overview

Application Testing Workflow

Interacting with Network Gatekeeper

The SOAP Header

Authentication

SOAP Header Element for Authentication

Username Token

X.509 Certificate Token

SAML Token

Session Management

Session Mode

Sessionless Mode

Service Correlation

Parameter Tunneling

SOAP attachments

Managing SOAP headers and SOAP attachments programmatically

Session Manager Web Service

Endpoint

Interface: SessionManager

Operation: getSession

Input message: getSession

Output message: getSessionResponse

Referenced faults

Operation: changeApplicationPassword

Input message: changeApplicationPassword

Output message: changeApplicationPasswordResponse

Referenced faults

Operation: getSessionRemainingLifeTime

Input message: getSessionRemainingLifeTime

Output message: getSessionRemainingLifeTimeResponse

Referenced faults

Operation: refreshSession

Input message: refreshSession

Output message: refreshSessionResponse

Referenced faults

Operation: destroySession

Input message: destroySession

Output message: destroySessionResponse

Referenced faults

Examples

Extended Web Services Binary SMS

Namespaces

Endpoint

Sequence Diagram

XML Schema data type definition

BinaryMessage structure

Web Service interface description

Interface: BinarySms

Operation: sendBinarySMS

Input message: sendBinarySMS

Output message: sendBinarySMSResponse

Referenced faults

WSDLs

Error Codes

Sample Send Binary SMS

Extended Web Services WAP Push

Namespaces

Endpoint

Sequence Diagram

XML Schema data type definition

PushResponse structure

ResponseResult structure

ReplaceMethod enumeration

MessageState enumeration

Web Service interface description

Interface: PushMessage

Operation: sendPushMessage

Input message: sendPushMessage

Output message: sendPushMessageResponse

Referenced faults

Interface: PushMessageNotification

Operation: resultNotificationMessage

Input message: resultNotificationMessage

Output message: resultNotificationMessageResponse

Referenced faults

WSDLs

Sample Send WAP Push Message

Extended Web Services Subscriber Profile

Namespaces

Endpoint

Address schemes

XML Schema data type definition

PropertyTuple structure

Web Service interface description

Interface: SubscriberProfile

Operation: get

Input message: get

Output message: getResponse

Referenced faults

Operation: getProfile

Input message: getProfile

Output message: getResponse

Referenced faults

WSDLs

Extended Web Services Common

Namespace

XML Schema datatype definition

AdditionalProperty structure

ChargingInformation structure

SimpleReference structure

Fault definitions

ServiceException

PolicyException

Parlay X 2.1 Interfaces

Parlay X 2.1 Part 2: Third Party Call

Interface: ThirdPartyCall

MakeCall

GetCallInformation

EndCall

CancelCall

Error Codes

Parlay X 2.1 Part 3: Call Notification

Interface: CallDirection

HandleBusy

HandleNotReachable

HandleNoAnswer

HandleCalledNumber

Interface: CallNotification

NotifyBusy

NotifyNotReachable

NotifyNoAnswer

NotifyCalledNumber

Interface: CallNotificationManager

StartCallNotification

StopCallNotification

Interface: CallDirectionManager

StartCallDirectionNotification

StopCallDirectionNotification

Error Codes

Parlay X 2.1 Part 4: Short messaging

Interface: SendSms

SendSms

SendSmsLogo

SendSmsRingtone

GetSmsDeliveryStatus

Interface: SmsNotification

NotifySmsReception

NotifySmsDeliveryReceipt

Interface: ReceiveSms

GetReceivedSms

Interface: SmsNotificationManager

StartSmsNotification

StopSmsNotification

Error Codes

Parlay X 2.1 Part 5: Multimedia messaging

Interface: SendMessage

SendMessage

GetMessageDeliveryStatus

Interface: ReceiveMessage

GetReceivedMessages

GetMessageURIs

GetMessage

Interface: MessageNotification

NotifyMessageReception

NotifyMessageDeliveryReceipt

Interface: MessageNotificationManager

StartMessageNotification

StopMessageNotification

Error Codes

Parlay X 2.1 Part 9: Terminal location

Interface: TerminalLocation

GetLocation

GetTerminalDistance

GetLocationForGroup

Interface: TerminalLocationNotificationManager

StartGeographicalNotification

StartPeriodicNotification

EndNotification

Interface: TerminalLocationNotification

LocationNotification

LocationError

LocationEnd

Error Codes

Parlay X 2.1 Part 14: Presence

Interface: PresenceConsumer

subscribePresence

getUserPresence

startPresenceNotification

endPresenceNotification

Interface: PresenceNotification

statusChanged

statusEnd

notifySubscription

subscriptionEnded

Interface: PresenceSupplier

publish

getOpenSubscriptions

updateSubscriptionAuthorization

getMyWatchers

getSubscribedAttributes

blockSubscription

Error Codes

About notifications

General Exceptions

General error codes

Code examples

Example: sendSMS

Example: startSmsNotification

Example: getReceivedSms

Example: sendMessage

Example: getReceivedMessages and getMessage

Example: getLocation

Parlay X 3.0 Interfaces

Interaction between Audio Call, Third Party Call, and Call Notification

Parlay X 3.0 Part 2: Third Party Call

Interface: ThirdPartyCall

makeCallSession

addCallParticipant

transferCallParticipant

getCallParticipantInformation

getCallSessionInformation

deleteCallParticipant

endCallSession

Parlay X 3.0 Part 3: Call Notification

Interface: CallDirection

HandleBusy

HandleNotReachable

HandleNoAnswer

HandleCalledNumber

Interface: CallNotification

notifyBusy

notifyNotReachable

notifyNoAnswer

notifyCalledNumber

notifyAnswer

notifyPlayAndCollectEvent

notifyPlayAndRecordEvent

Interface: CallNotificationManager

startCallNotification

startPlayAndCollectNotification

startPlayAndRecordNotification

stopCallNotification

stopMediaInteractionNotification

Interface: CallDirectionManager

StartCallDirectionNotification

StopCallDirectionNotification

Parlay X 3.0 Part 11: Audio call

Interface: PlayMedia

playTextMessage

playAudioMessage

playVoiceXmlMessage

playVideoMessage

getMessageStatus

endMessage

Interface: CaptureMedia

startPlayAndCollectInteraction

startPlayAndRecordInteraction

stopMediaInteraction

Interface: Multimedia

addMediaForParticipants

deleteMediaForParticipants

getMediaForParticipant

getMediaForCall

General Exceptions

Access Web Service (deprecated)

Endpoint

Interface: Access

Operation: applicationLogin

Input message: applicationLoginRequest

Output message: applicationLoginResponse

Referenced faults

Operation: applicationLogout

Input message: applicationLogoutRequest

Output message: applicationLogoutResponse

Referenced faults

Operation: changeApplicationPassword

Input message: changeApplicationPasswordRequest

Output message: changeApplicationPasswordResponse

Referenced faults

Operation: getLoginTicketRemainingLifeTime

Input message: getLoginTicketRemainingLifeTimeRequest

Output message: getLoginTicketRemainingLifeTimeReturn

Referenced faults

Operation: refreshLoginTicket

Input message: refreshLoginTicketRequest

Output message: refreshLoginTicketResponse

Referenced faults

Exceptions

AccessException

GeneralException

Examples

Defining the security header