9-4 Developers Guide
9.5.2 Interface SendMessage, Operation: getMessageDeliveryStatus
This operation returns a set of delivery statuses for each recipient of an outgoing message sent via sendMessage. Call this operation with the ID returned by
sendMessage.
9.5.2.1 Code Example
String msgID = sendMsgClient.sendMessage...; ListDeliveryInformation infoList =
sendMsgClient.getMessageDeliveryStatusmsgID; for DeliveryInformation info : infoList {
System.out.println“recipient: “ + info.getAddress; System.out.println“status: “ + info.getDeliveryStatus;
}
9.5.3 Interface MessageNotificationManager, Operation: startMessageNotification
This operation starts message notification at a given endpoint for a user. This means that when messages are received for this user, the client callback
notifyMessageReception is invoked at the given MessageNotification endpoint. This also means that the web service stores received messages for this user, and the
received messages can be obtained through the ReceiveMessage interface.
9.5.3.1 Code Example
MapString, Object params = new HashMapString, Object; params.putBindingProvider.ENDPOINT_ADDRESS_PROPERTY,
http:webservicehost:7001msgNotiMgrEndpoint; MessageNotificationManagerClient msgNotiMgrClient =
new MessageNotificationManagerClientparams; SimpleReference ref = new SimpleReference;
String correlator = UUID.randomUUID.toString ref.setCorrelatorcorrelator;
Table 9–6 Interface SendMessage, Operation: getMessageDeliveryStatus
Argument Type
Required Description
messageIdentifier String
yes Identifier related to the delivery
status request.
Return Value Type
Description
status ListDeliveryInformat
ion A list of status of the messages that
were previously sent. Each item represents a sent message, its
destination address, and its delivery status.
Table 9–7 Interface MessageNotificationManager, Operation: startMessageNotification
Argument Type
Required Description
reference SimpleReference
yes Defines the application endpoint,
interfaceName, and correlator that is used to notify the application when a
message is received.
messageServiceAct ivationNumber
StringSipURI yes
The application is notified when messages are received for this SIP
address. criteria
String no
This value is ignored.
Parlay X Web Services Multimedia Messaging API 9-5
ref.setEndpointhttp:clienthost:8080notificationEndpoint; ref.setInterfaceMessageNotification;
msgNotiMgrClient.startMessageNotificationref, sip:receiverexample.com,dummy_criteria_ignored;
9.5.4 Interface MessageNotificationManager, Operation: stopMessageNotification
This operation stops message notification at an endpoint for a user. If a user no longer has notification endpoints, all received messages for that user are no longer stored.
9.5.4.1 Code Example
msgNotiMgrClient.stopMessageNotificationcorrelator;
9.5.5 Interface ReceiveMessage, Operation: getReceivedMessages
This operation returns a set of incoming messages for a given user. Messages may only be received after notification has been enabled by invoking the
startMessageNotifcation operation in the MessageNotificationManager interface.
9.5.5.1 Code Example
MapString, Object params = new HashMapString, Object; params.putBindingProvider.ENDPOINT_ADDRESS_PROPERTY,
http:webservicehost:7001receiveMessageEndpoint; ReceiveMessageClient recvMsgClient = new ReceiveMessageClientparams;
ListMessageReference msgs = recvMsgClient.getReceivedMessagessip:receiverexample.com,
MessagePriority.DEFAULT; for MessageReference ref : msgs {
System.out.printlnto: +ref.getMessageServiceActivationNumber; System.out.printlnfrom: +ref.getSenderAddress;
System.out.printlnsubject: +ref.getSubject; String id = ref.getMessageIdentifier;
if id == null || id.isEmpty { System.out.printlnmessage: +ref.getMessage;
} else {
Table 9–8 Interface MessageNotificationManager, Operation: stopMessageNotification
Argument Type
Required Description
correlator String
yes The correlator associated with an
invocation of the startMessageNotification operation.
Table 9–9 Interface ReceiveMessage, Operation: getReceivedMessages
Argument Type
Required Description
registrationIdentifier StringSipURI yes
The recipient SIP address for incoming messages.
priority MessagePriority
no This value is ignored.
Return Value Type
Description
references ListMessageReference
A list of messages received for this user. Each item may either have a
message identifier or message content, but is not guaranteed to
have both an identifier and content.