7 Parlay X 2.1 Multimedia Messaging/MM7

Processing Application-initiated Requests

After an application has sent a multimedia message to one or more destination addresses, two different types of response can be returned:

• Send Receipts

• Delivery Receipts

Processing Network-triggered Requests

Two types of traffic destined for an application can arrive at Services Gatekeeper from the network:

• Delivery receipts for application-initiated sent multimedia messages. See ”Delivery Receipts” for more information.

• Mobile-originated multimedia messages destined for the application

For an application to receive multimedia messages from the network, it must indicate its interest in these messages by registering for online notification in Services Gatekeeper. A notification is defined by a service activation number, which is the destination address of the multimedia message. The service activation number may be translated by some mechanism, such as short codes, in the telecom network. Use the StartMessageNotification method of the MessagingManagementMBean to register for online notification of network-triggered MMS messages from the Administration console. See the "All Classes" section of Services Gatekeeper OAM Java API Reference for details on the MessagingManagementMBean.

An application can also use the following operations to register for online notifications:

• ParlayX 2.1 StartMessageNotification. See the 3GPP TS 29.199-05 Parlay X Web Services Part 5: Multimedia Messaging specification

• REST Start Message Notification. See Services Gatekeeper Application Developer's Guide.

• OneAPI Subscribe to MMS Delivery Notification. See Services Gatekeeper Application Developer's Guide.

An application can also register to receive multimedia messages offline. Services Gatekeeper stores the messages and delivers them when the application requests them. Use the enableReceiveMms method of MessagingManagementMBean to provision offline notification of network-triggered MMS messages.

Additional criteria can be tied to the service activation number, such as the start of the first plain/text part in the multimedia message payload or the subject of the multimedia message. For the message to be accepted by Services Gatekeeper, both the service activation number and any additional criteria must match the notification.

Mobile-originated messages to applications are routed based on the criteria that are specified when the notifications are created. The behavior for matching criteria is as follows:

• If the subject of the message is not null, the subject is used for criteria matching the specified criteria.

• If the subject of the message is null, the first word of first text attachment is used for matching the criteria.

• If the criteria is not null, messages with no subject and no text attachment are not delivered to the application.

• If the criteria is null, all messages are considered a match and delivered to the application.

Each registered notification must be unique, and notification attempts with overlapping criteria are rejected. The application can either retrieve received multimedia messages from Services Gatekeeper or include a callback interface when setting up the original notification.

Following are the possible scenarios for receipt and handling of multimedia messages.

1. The application has registered for online notification. Services Gatekeeper sends the message to the application, and the application receives the message and acknowledges receiving it.

   If the MMS message is pure text, the text is included in the notification sent to the application.

   If the MMS message is not pure text, the notification sent to the application includes a reference to the multimedia attachments. The application uses that reference to retrieve the attachments.

2. The application has registered for online notification. Services Gatekeeper sends the multimedia message to the application, but the application does not acknowledge receiving it.

   Offline notification has been provisioned.

   Services Gatekeeper stores the multimedia message. The application retrieves the message as described in "Retrieving Offline MMS Messages".

3. The application has registered for online notification. Offline notification has not been provisioned.

   Services Gatekeeper sends the multimedia message to the application, but the application does not acknowledge receiving it. Services Gatekeeper returns an error to the network. It is the responsibility of the network to handle any further processing of the multimedia message.

4. The application has not registered for online notification. Offline notification has been provisioned. Services Gatekeeper stores the multimedia message.

   The application retrieves the message as described in "Retrieving Offline MMS Messages".

5. The application has not registered an online subscription, and offline notification has not been provisioned.

   Services Gatekeeper returns an error to the network. It is the responsibility of the network to handle any further processing of the multimedia message.

{"notifyMessageReception": {
  "correlator": "String",
  "message": {
    "messageServiceActivationNumber": "String",
    "priority": "Default|Low|Normal|High",
    "senderAddress": "URI",
    "dateTime": "Calendar",
    "message": "String" --> if message is pure text it can be found here
    "messageIdentifier": "String", --> if not pure text the reference is found here
    "subject": "String"
  }
}}

"inboundMessage": [
{ "dateTime": "dateTime",
"destinationAddress": "String",
"messageId": "String", --> server-geenerated message identifier
"inboundMMSMessage": "String", --> subject of the message
"resourceURL": "URL", --> link to the full message and attachments
"senderAddress": "String"},

====Content Divider====

Attachment(s)

Polling Functionality

The polling capability for retrieving offline notifications must be provisioned in advance.

To configure the polling capability:

• Set the RequestDeliveryReportFlag attribute to non-zero. See this attribute of the M for information about valid values.

• Use the enableReceiveMms operation to allow applications to poll for mobile-originated messages. See the description of the enableReceiveMms method of MessagingManagementMBean in Services Gatekeeper OAM Java API Reference for more information.

Short Code Translation

Messaging-capable networks use short codes and message prefixes to help route traffic and to make access to certain features easier for the end user. Instead of having to use the entire address, users can enter a short code that is mapped to the full address in the network. The Parlay X 2.1 Multimedia Messaging/MM7 communication service supports short codes and message prefixes, which allow the same short code to be mapped to multiple addresses based on the prefix to the enclosed message.

Event Data Records

Table 7-2 lists the IDs of the EDRs created by the Parlay X 2.1 Multimedia Messaging/MM7 communication service.

Charging Data Records

Multimedia Messaging/MM7-specific CDRs are generated under the following conditions:

• After Services Gatekeeper successfully sends a sendMessage request to the network.

• After Services Gatekeeper successfully receives and processes a delivery report sent from the network.

• After Services Gatekeeper successfully receives and processes a mobile-originated message sent from the network.

Statistics

Table 7-3 maps methods invoked from either the application or the network to the transaction types collected by the Services Gatekeeper statistics counters.

Alarms

For the list of alarms, see Services Gatekeeper Alarms Handling Guide.

ChargedParty

Description

Specifies the party to be charged for a multimedia message submitted by the Value-Added Service Provider (VASP).

If defined, the ChargedParty xparameter is forwarded in the SOAP header in the north-bound interface.

Validated by the plug-in.

Format

String

Value

Valid values: Sender, Recipient, Both, Neither

ChargedPartyCD

Description

Specifies the address of the third party expected to pay for the multimedia message.

If defined, the ChargedPartyID xparameter is forwarded in the SOAP header in the north-bound interface.

Format

String

timeStamp

Description

Specifies date and time that the multimedia message was submitted.

Format

Date/Time

expiryDate

Description

Specifies the desired time for the expiration of the multimedia message.

Format

Date/Time

allowAdaptation

Description

Specifies if VASP allows adaptation of the content.

Set to true to allow adaptation, false to prohibit it.

Format

Boolean

DeliveryCondition

Description

In the event of a single Delivery Condition, if the condition is met, the multimedia message is delivered to the recipient MMS User Agent. Otherwise the message is discarded.

Validated by the plug-in.

Format

Positive Integer

UAProf

Description

Specifies the UserAgent Name or URL to the UAProfile (resource description framework) RDF.

Used for transferring user agent capabilities from R/S to value-added service provider (VASP).

If not null, this parameter is forwarded to the application.

Format

String

StatusText

Description

Human-readable description of the numerical code that indicates the general type of an error.

If not null, this parameter is forwarded to the application.

Format

String

Properties for Parlay X 2.1 Multimedia Messaging/MM7

Table 7-4 lists the technical specifications for the communication service.

Configuration Workflow for Parlay X 2.1 MultiMedia Messaging/MM7

Following is an outline for configuring the plug-in using the Administration Console or an MBean browser.

1. Create one or more instances of the plug-in service. See the discussion about configuring and managing the plug-in manager in Services Gatekeeper System Administrator's Guide. Use the plug-in service ID listed in "Properties for Parlay X 2.1 Multimedia Messaging/MM7".

2. Select the MBean for the plug-in instance. The MBean display name is the same as the plug-in instance ID given when the plug-in instance was created.

3. Configure the behavior of the plug-in instance using the following attributes in MessagingManagementMBean:

   • HTTPBasicAuthentication

     If you are using HTTP basic authentication, also define:

     • HTTPBasicAuthenticationUsername

     • HTTPBasicAuthenticationPassword

   • DefaultPriority

   • MM7Version

   • Mm7relayserverAddress

   • VaspId

   • VasId

   • RequestDeliveryReportFlag

   • XSDVersion

   For more information on the fields and methods of MessagingManagementMBean, see the "All Classes" section of Services Gatekeeper OAM Java API Reference.

4. Specify heartbeat behavior. See the discussion about configuring heartbeats in Services Gatekeeper System Administrator's Guide.

5. Set up the routing rules to the plug-in instance. See the discussion about configuring and managing the plug-in manager in Services Gatekeeper System Administrator's Guide. Use the plug-in instance ID and address schemes listed in "Properties for Parlay X 2.1 Multimedia Messaging/MM7".

6. Provide the administrator of the MM7 server with the URL to which the MM7 server should deliver mobile originated messages and delivery reports. The default URL is:

   http://IP_Address_of_NT_server:port/context-root/plug-in_instance_ID
   

   If you are using the REL-5-MM7-1-2 XSD, the default context-root is mmm-mm7.

   If you are using the REL-5-MM7-1-5 XSD, the default context-root is mmm-mm7-rel5mm7-1-5.

   If you are using the REL-6-MM7-1-4 XSDm the default context-root is mmm-mm7-rel6mm7-1-4.

7. If required, create and load a node SLA. For details see the discussion about defining global node and service provider group node SLAs and managing SLAs in Services Gatekeeper Accounts and SLAs Guide.

8. Provision the service provider accounts and application accounts. For information, see Services Gatekeeper Portal Developer's Guide.

Provisioning Parlay X 2.1 MultiMedia Messaging/MM7 Communication Service

To provision the Parlay X 2.1 MultiMedia Messaging/MM7 communication service, do the following:

• Enable mobile-oriented messages to be stored in Services Gatekeeper for polling by applications, by using the enableReceiveMms method of MessagingManagementMBean.

• Set up for notifications about mobile-originated messages on behalf of an application, by using the startMessageNotification method of MessagingManagementMBean.

• Manage offline notifications, by using the following methods of MM7NotificationMBean:

  • listOfflineNotificationInfo

  • getOfflineNotificationInfo

  • removeOfflineNotificationInfo

• Manage offline notifications, by using the following methods of MM7NotificationMBean:

  • listOnlineNotificationInfo

  • getOnlineNotificationInfo

  • removeOnlineNotificationInfo

For a description of the attributes and operations of the MessagingManagementMBean and MM7NotificationMBean MBeans, see the "All Classes" section of Services Gatekeeper OAM Java API Reference.