1/38

Contents

Title and Copyright Information

Preface

• Audience
• Documentation Accessibility
• Related Documents

Part I Overview of Creating Applications for Services Gatekeeper

1 About Creating Applications that Interact with Services Gatekeeper

• Basic Concepts
  • Understanding the Interfaces
  • Understanding Communication Services
  • Understanding Traffic Types
    • Understanding Application-Initiated Traffic
    • Understanding Network-Triggered Traffic
    • Securing Applications from Malicious Traffic
    • Adding Proxy Servers for Callbacks and Notifications
  • Understanding Mobile Applications
    • Preparing a Development Environment
    • Creating a Mobile Application
    • Testing a Mobile Application
    • Distributing a Mobile Application
  • Understanding Management Structures
  • Understanding How to Test Applications

2 Understanding the Supported Application Interfaces

• Overview of Services Gatekeeper Supported Interfaces
  • SOAP-Based Interfaces
  • RESTful Interfaces
  • RESTful OneAPI Interfaces
  • Native Interfaces

3 Managing Communication Sessions

• Understanding the Session Manager Web Service
• Session Management for SOAP, RESTful, and OneAPI Interfaces
  • About Sessions
  • Changing the Session Mode
• Session Manager WSDL File
• SessionManager WSDL Interface Reference
  • 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
• Session Manager Examples

Part II Creating Applications Using the RESTful Interfaces

4 Using the RESTful Interfaces

• Supported RESTful Interfaces
• Understanding RESTful Operations
  • Request-URI and HTTP Methods
    • General Format of a Request-URI
    • POST
    • PUT
    • GET
    • DELETE
  • Status-Line
  • Headers
    • Headers for Multipart Messages with Attachments
    • Service Correlation
      • How Service Correlation IDs are Provided
  • Message Body
    • Request Body
    • Response Body
  • Example of a Request and Response
• RESTful Authentication and Security
• RESTful Notifications and Publish/Subscribe
  • Supported Endpoint Addresses
    • Endpoint Addresses for RESTful Interfaces
  • Using the Bayeux (Cometd) Protocol to Communicate with the Server
    • Understanding Bayeux Connections and Subscriptions
    • Understanding the Bayeux Protocol Channel Name
    • Using the Data at the Endpoint Address
• Understanding RESTful Errors and Exceptions

5 Adding RESTful Third Party Call Support

• About the RESTful Third Party Call Interface
  • REST Service Descriptions Available at Runtime
• RESTful Third Party Call Interface Reference
• Make Call
• Get Call Information
• Cancel Call
• End Call

6 Adding RESTful Anonymous Customer Reference Support

• About Anonymous Customer References
• Configuring ACR Support in Services Gatekeeper
  • Creating an ACR Plug-in Instance
  • Setting ACR Plug-in Parameters
  • Creating Multiple ACRs for a Single Subscriber
• RESTful APIs for ACR Support
• Create ACR
• Query ACR
• Change ACR Status
• Errors and Exceptions
• EDRs

7 Adding RESTful Application Subscription Management Support

• About Application Subscription Management
  • REST Service Descriptions Available at Run-time
• Subscribe
• Unsubscribe
• Suspend
• Unsuspend
• Notify
• Confirm
• queryBySubscriberAddress
• queryByApplicationName
• queryBySubscriptionID

8 Adding RESTful Short Messaging Support

• About the Short Messaging Interface
  • REST Service Descriptions Available at Run-time
• Send SMS
• Send SMS Ringtone
• Send SMS Logo
• Get Received SMS
• Get SMS Delivery Status
• Start SMS Notification
• Stop SMS Notification

9 Adding RESTful Multimedia Messaging Support

• About the Multimedia Messaging Interface
  • REST Service Descriptions Available at Run-time
• Send Message
• Get Received Messages
• Get Message
• Get Message Delivery Status
• Start Message Notification
• Stop Message Notification

10 Adding RESTful Email Communication Service Support

• About the Email Communication Interface
  • REST Service Descriptions Available at Run-time
• Send Message
• Get Received Messages
• Get Message
• Get Message Delivery Status
• Start Message Notification
• Stop Message Notification

11 Adding RESTful Terminal Location Support

• About the Terminal Location Interface
  • REST Service Descriptions Available at Run-time
• Get Location
• Get Location for Group
• Get Terminal Distance
• Start Geographical Notification
• Start Periodic Notification
• End Notification

12 Adding RESTful Payment Support

• About the Payment Interface
  • REST Service Descriptions Available at Run-time
• Charge Amount
• Refund Amount
• Charge Split Amount
• Reserve Amount
• Reserve Additional Amount
• Charge Volume
• Refund Volume
• Charge Split Volume
• Get Amount
• Charge Reservation
• Release Reservation
• Reserve Volume
• Reserve Additional Volume
• Get Amount Reserve Charging

13 Adding RESTful Quality of Service Support

• About the QoS Interface
  • REST Service Descriptions Available at Run-time
• Example QoS Scenario
• Configuring QoS for Services Gatekeeper
• Using OAuth with QoS
• Apply QoS
• Apply Template-Based QoS
• Modify QoS
• Template-Based Modify QoS
• Get QoS Status
• Remove QoS
• Register for QoS Notifications
• Unregister for QoS Notifications
• QoS Event Notification
• List QoS Event Notifications

14 Adding RESTful Device Capabilities Support

• About the Device Capabilities Interface
  • REST Service Descriptions Available at Run-time
• Get Capabilities
• Get Device Id

15 Adding RESTful Binary Short Messaging Support

• About the Binary Short Messaging Interface
  • REST Service Descriptions Available at Runtime
• RESTful Binary SMS Interface Reference
• Send Binary Sms
• Start Binary Sms Notification
• Stop Binary Sms Notification

16 Adding RESTful Session Manager Support

• About the Session Manager Interface
  • REST Service Descriptions Available at Run-time
• Get Session
• Get Session Remaining Lifetime
• Destroy Session

17 Adding RESTful Subscriber Profile Support

• About the Subscriber Profile Interface
  • REST Service Descriptions Available at Run-time
• Get
• Get Profile

18 Adding RESTful WAP Push Support

• About the WAP Push Interface
  • REST Service Descriptions Available at Run-time
• Send Push Message

Part III Creating Applications Using the OneAPI RESTful Interfaces

19 Using the OneAPI RESTful Interfaces

• About the OneAPI Facade Architecture
  • Support for Anonymous Customer References
  • Components of the RESTful Facade
• Supported OneAPI Interfaces
  • SMS
  • MMS
  • Terminal Location
  • Payment
• About Configuring OneAPI Server Functionality
• General Format of an Operation
  • Request-URI and HTTP Methods
    • General Format of a Request-URI
    • POST
    • PUT
    • GET
    • DELETE
  • Headers
    • Headers for Multipart Messages with Attachments
  • Status Line
  • Message Body
    • Request Body
    • Response Body
  • Example of a Request and Response
• Authentication and Security
• Notifications
• Errors and Exceptions

Part IV Creating Applications Using the SOAP Interfaces

20 Using the SOAP Interfaces

• Understanding the SOAP Interfaces
• Requirements for Using the SOAP-Based Interfaces
  • Understanding SOAP-Based Authentication
    • SOAP Header Element for Authentication
      • Username/Password Authentication (Username Token)
      • Digital Signatures (X.509 Certificate Token)
      • Encryption (SAML Token)
  • Setting Callback Timeout Limits
  • Understanding How Service Correlation Orchestrates Services
  • Understanding Parameter Tunneling
  • Understanding SOAP Payload Attachments
• Managing SOAP Headers and Attachments Programmatically

21 Adding a SOAP2SOAP Communication Services

• About SOAP2SOAP Communication Services

22 Adding SOAP-Based Quality of Service Support

• About the SOAP-Based QoS Interface
• SOAP-Based Service Descriptions Available at Run-time
• Example Parlay X 4.0 Application-Driven QoS/Diameter Scenario
• Configuring Services Gatekeeper to Use the QoS Communication Services

23 About the Supported SOAP Parlay X 2.1 Facades

• 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
  • Sending Custom Message Content for Split and Submit Messaging Requests
    • Using DifferentContentForSingleAddressInBulk to Customize Split Messages
  • 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
  • Understanding Parlay X 2.1 Terminal Location Precision
  • Interface: TerminalLocation
    • GetLocation
    • GetTerminalDistance
    • GetLocationForGroup
  • Interface: TerminalLocationNotificationManager
    • StartGeographicalNotification
    • StartPeriodicNotification
    • EndNotification
  • Interface: TerminalLocationNotification
    • LocationNotification
    • LocationError
    • LocationEnd
  • 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

24 About the Supported SOAP Parlay X 3.0 Facades

• Parlay X 3.0 Part 6: Payment
  • Interface: AmountCharging
    • chargeAmount
    • refundAmount
    • chargeSplitAmount
  • Interface: VolumeCharging
    • chargeVolume
    • refundVolume
    • chargeSplitVolume
    • getAmount
    • chargeReservation
    • releaseReservation
  • Interface: ReserveAmountCharging
    • reserveAmount
    • reserveAdditionalAmount
    • chargeReservation
    • releaseReservation
  • Interface: ReserveVolumeCharging
    • reserveVolume
    • reserveAdditionalVolume
    • getAmountReserveCharging
• Parlay X 3.0 Part 13: Address List Management
  • Interface: GroupManagement
    • createGroup
    • queryGroups
    • deleteGroup
    • setAccess
    • queryAccess
    • General Exceptions
  • Interface: Group
    • addMember
    • addMembers
    • queryMembers
    • deleteMember
    • deleteMembers
    • addGroupAttribute
    • queryGroupAttribute
    • deleteGroupAttribute
    • addGroupMemberAttribute
    • queryGroupMemberAttributes
    • deleteGroupMemberAttribute
  • Interface: Member
    • addMemberAttribute
    • queryMemberAttributes
    • deleteMemberAttribute
• Parlay X 3.0 Part 18: Device Capabilities and Configuration
  • Interface: DeviceCapabilities
    • getCapabilities
    • getDeviceId
    • General Exceptions
  • Interface: DeviceCapabilitiesNotificationManager
    • startNotification
    • endNotification
  • Interface: DeviceCapabilitiesNotification
    • deviceNotification
    • deviceError
    • deviceEnd
  • Interface: DeviceConfiguration
    • pushConfiguration
    • getConfigurationList
    • getConfigurationHistory
• General Exceptions

25 About the Supported SOAP Parlay X 4.0 Facades

• Parlay X 4.0 Part 17 Application-Driven QoS
  • Interface: Application-driven QoS
    • applyQoSFeature
      • Request Example
      • Response Parameters
      • Response Example
    • getQoSHistory
      • Request Parameters
      • Request Example
      • Response Parameters
      • Response Example
    • getQoSStatus
      • Request Parameters
      • Request Example
      • Response Parameters
      • Response Example
    • modifyQoSFeature
      • Request Parameters
      • Request Example
      • Response Parameters
      • Response Example
    • notifyQoSEvent
      • Request Parameters
      • Response Parameters
    • removeQoSFeature
      • Request Parameters
      • Request Example
      • Response Parameters
      • Response Example
  • Interface: ApplicationQoSNotificationManager
    • startQoSNotification
      • Request Parameters
      • Request Example
      • Response Parameters
    • stopQoSNotification
      • Request Parameters
      • Response Parameters

26 About the Supported SOAP Native Facade

• About the Native Interfaces
• MM7
  • Supported MM7 Operations
    • MM7_submit
    • MM7_deliver
    • MM7_cancel
    • MM7_replace
    • MM7_delivery_report
    • MM7_read_reply_report
• SMPP
  • Bind PDUs and Sessions
  • Error Handling
  • Supported Operations
    • bind_transmitter PDU
    • bind_transmitter_resp PDU
    • bind_receiver PDU
    • bind_receiver_resp PDU
    • bind_transceiver PDU
    • bind_transceiver_resp PDU
    • outbind PDU
    • unbind PDU
    • unbind_resp PDU
    • generic_nack PDU
    • submit_sm PDU
    • submit_sm_resp PDU
    • submit_multi PDU
    • submit_multi_resp PDU
    • deliver_sm PDU
    • deliver_sm_resp PDU
    • data_sm PDU
    • data_sm_resp PDU
    • query_sm PDU
    • query_sm_resp PDU
    • cancel_sm PDU
    • cancel_sm_resp PDU
    • replace_sm PDU
    • replace_sm_resp PDU
    • enquire_link PDU
    • enquire_link_resp PDU
    • alert_notification PDU
• UCP
  • Error Handling
    • ERROR_CODE_OPERATION_NOT_ALLOWED
    • ERROR_CODE_AUTH_FAILURE
    • ERROR_CODE_OPERATION_NOT_SUPPORTED
    • ERROR_CODE_SYNTAX_ERROR
  • Native UCP Operations: Application-Facing Interface
    • submitSM
    • openSession
    • ack
    • nack
    • deliverSM
    • deliveryNotification
  • Native UCP Operations: Network-Facing Interface
    • ack
    • nack

Part V Creating Applications Using Extended Web Service Interfaces

27 Understanding the Extended Web Services Common Definitions

• Namespace
• XML Schema Datatype Definition
  • AdditionalProperty Structure
  • ChargingInformation structure
  • SimpleReference structure
• Fault Definitions
  • ServiceException
  • PolicyException

28 Adding Extended Web Service Binary SMSs Support

• Understanding the Binary SMS Web Service
• Namespaces
• Endpoints
• Sequence Diagram
  • Send SMS
  • Receive SMS
• XML Schema data type definition
  • BinaryMessage structure
  • BinarySmsMessage structure
  • Interface: BinarySms
    • Operation: sendBinarySMS
  • Interface: BinarySmsNotificationManager
    • Operation: StartBinarySmsNotification
    • Operation: StopBinarySmsNotification
  • Interface: BinarySmsNotification
    • Operation: NotifyBinarySmsReception
• Configuring Automatic Chunking of Binary SMSs
• WSDLs
• Error Codes
• Sample Send Binary SMS

29 Adding WAP Push Extended Web Service Message Support

• Understanding the WAP Push Extended Web Service Interface
• Namespaces
• Endpoint
• Sequence Diagram
• XML Schema Data Type Definition
  • PushResponse Structure
  • ResponseResult structure
  • ReplaceMethod enumeration
  • MessageState enumeration
• WAP Push Extended Web Service Interface Descriptions
  • Interface: PushMessage
    • Operation: sendPushMessage
  • Interface: PushMessageNotification
    • Operation: resultNotificationMessage
• WSDLs
• Sample Send WAP Push Message

30 Adding Subscriber Profile Extended Web Service Support

• Understanding the Subscriber Profile Extended Web Service Interface
• Namespaces
• Endpoint
• Address schemes
• XML Schema data type definition
  • PropertyTuple Structure
• WAP Push Extended Web Service Interface Descriptions
  • Interface: SubscriberProfile
    • Operation: get
    • Operation: getProfile
• WSDLs