Contents

Title and Copyright Information

Preface

• Audience
• Documentation Accessibility
• Related Documents

1 Overview of How Applications Interact with Services Gatekeeper

• Basic Concepts
  • Communication Services
  • Traffic Types
    • Application-initiated Traffic
    • Network-triggered Traffic
  • Management Structures
• Included Interfaces
• Application Testing Workflow

2 Interacting with the RESTful Facade

• General Format of an Operation
  • 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
• Authentication and Security
• Notifications and Publish/Subscribe
  • Supported Endpoint Addresses
    • Endpoint Addresses for RESTful Interfaces
  • Bayeux Protocol
    • Connections and Subscriptions
    • Bayeux Protocol Channel Name
    • Using the Data at the Endpoint Address
• Errors and Exceptions

3 Third Party Call

• About RESTful Third Party Call Interface
  • REST Service Descriptions Available at Run-time
• Make Call
• Get Call Information
• Cancel Call Request
• End Call

4 Anonymous Customer Reference

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

5 Application Subscription Management

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

6 Call Notification

• About the Call Notification Interface
  • REST Service Descriptions Available at Run-time
  • Common Data
• Start Call Notification
• Stop Call Notification
• Start Call Direction Notification
• Stop Call Direction Notification

7 Short Messaging

• 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

8 Multimedia Messaging

• 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

9 Email Communication Service

• 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

10 Terminal Status

• About the Terminal Status Interface
  • REST Service Descriptions Available at Run-time
• Get Status
• Get Status For Group
• Start Notification
• End Notification

11 Terminal Location

• 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 Payment

• 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 Audio Call

• About the Audio Call Interface
  • REST Service Descriptions Available at Run-time
• Play Audio Message
• Play Text Message
• Play VoiceXML Message
• Get Message Status
• End Message

14 Quality of Service

• 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
• Template-based Apply QoS
• Modify QoS
• Modify Template-based QoS
• Get QoS Status
• Remove QoS
• Register for QoS Notifications
• Unregister for QoS Notifications
• QoS Event Notification
• List QoS Event Notifications

15 Presence

• About the Presence Interface
  • REST Service Descriptions Available at Run-time
  • About Presentities and Watchers
• Data Common to Operations in RESTful Presence Interface
  • attributes
  • PresenceAttribute
  • unionElement
  • Activity
  • Place
  • Privacy
  • Sphere
  • Type
  • Communication
  • Means
  • TypeandValue
  • Other
• Get Open Subscriptions
• Get My Watchers
• Update Subscription Authorization
• Subscribe Presence
• Block Subscription
• Start Presence Notification
• End Presence Notification
• Get User Presence
• Publish

16 Device Capabilities

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

17 Binary Short Messaging

• About the Binary Short Messaging Interface
• Send Binary Sms
• Start Binary Sms Notification
• Stop Binary Sms Notification

18 Session Manager

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

19 Subscriber Profile

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

20 WAP Push

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