Removing a Buddy from a Buddy List Manipulating your presence rules document

Parlay X Web Services Multimedia Messaging API 9-1 9 Parlay X Web Services Multimedia Messaging API This chapter describes support for the Parlay X 2.1 Multimedia Messaging Web Services interfaces for developing applications. The Web service functions as a Messaging Agent which can send, receive, and listen to notifies on behalf of the users of the Web service. This chapter contains the following sections: ■ Section 9.1, Introduction ■ Section 9.2, Installing the Web Services ■ Section 9.3, Configuring Web Services ■ Section 9.4, Messaging Web Services Interface Descriptions ■ Section 9.5, Using the Messaging Web Services Interfaces

9.1 Introduction

The following sections describe the semantics of each of the supported operations along with implementation-specific details for the Parlay X Gateway. The product support the interfaces defined in the Parlay X 2.1 Multimedia Messaging Web Services specification.

9.2 Installing the Web Services

The Web services are packaged as a standard .ear file and can be deployed the same as any other Web services through Admin Console. The .ear file contains three .war files that implement the three interfaces. The Web services use the Oracle SDP Platform, Client and Presence Commons shared libraries.

9.3 Configuring Web Services

There are four mbean attributes that are configurable for the Messaging Web service: 1. SIPOutboundProxy - SipURI of the outbound proxy for SIP message. Empty string means no outbound proxy. Currently, only support IP address. For example, sip:127.0.0.1:5060; lr;transport=tcp. 2. SessionTimeout - Set the time in seconds after which HTTP sessions time out. Data for all timed out sessions is discarded. 3. MessageLifetime - Set the time in seconds after which messages expire from the message store. Setting this to 0 causes messages to be kept in the store indefinitely 9-2 Developers Guide never expire. Messages stay in the message store for at most MessageLifetime + MessageScanPeriod seconds. Setting this attribute has immediate effect for instance, reducing the value could cause some messages to be immediately expired if they are older than the lifetime. 4. MessageScanPeriod - Set the period in seconds for scanning for and deleting expired messages. Setting this to 0 disables scanning. Setting this attribute has immediate effect.

9.4 Messaging Web Services Interface Descriptions

The messaging Web services consist of four interfaces: ■ SendMessage: Use these methods to send messages Table 9–1 . ■ ReceiveMessage: Use these methods to receive message content Table 9–2 . ■ MessageNotificationManager: Use these methods to manage which users are notified when messages are received through the Web service Table 9–3 . ■ MessageNotification: The client callback defined in this interface is used to send notifications Table 9–4 . Table 9–1 SendMessage Interface Operation Description sendMessage Sends a SIP MESSAGE to designated users. Returns an outgoing message ID. getMessageDeliveryStatus Returns a set of delivery statuses for each recipient of an outgoing message sent through sendMessage. Table 9–2 ReceiveMessage Interface Operation Description getMessage Receives an incoming message. getMessageURIs Not implemented. getReceivedMessages Returns a set of incoming messages for a given user. Table 9–3 MessageNotificationManager Interface Operation Description startMessageNotification Starts message notification at a given endpoint for a user. Notifies endpoint when messages are received for user. stopMessageNotification Stops message notification at an endpoint for a user. Table 9–4 MessageNotification Interface Operation Description notifyMessageDeliveryReceipt Client callback invoked to notify the user of a message’s final delivery status. notifyMessageReception Client callback invoked to notify the client that the user received a message.