The Parlay X Multimedia Messaging over MM7 Web
service implementation uses the Usage Record component Web service to get, send, and start notification messages.
Parlay X Multimedia Messaging over MM7 service
record
Usage records for Parlay X Multimedia Messaging over MM7 are
created by calling the Usage Record component Web service,
which creates entries in the USAGERECORDS table.
The following table describes the information that is passed to the
Usage Record component Web service for this Web service implementation.
Table 1. Usage record component service attributes and descriptionsAttribute |
Description |
RECORDID |
A unique record identifier |
SEGMENT |
Segment number used for subsequent truncated records. This number is incremented each time an overflow of the SERVICEDATA field is encountered and a subsequent record is added. Used by the SMS-based service implementations; a value of 0 is written for all others.
|
GLOBALID |
Global transaction identifier |
SERVICE |
Name of the service |
HOST |
Name of the host on which the usage record is being recorded |
EVENTTYPE |
Name of the operation being performed |
RECORDTIME |
The time that the usage record was written |
STATUSCODE |
One of the following: 0 = VALID
1 = FAILED_PRIVACY
2 = FAILED_ADDRESS_PLAN_VALIDATION
3 = EXCEEDED_MAX_TARGETS
4 = FAILED_PACER
5 = FAILED_CALL_LEVEL_PRIVACY
6 = FAILED_PROCESS_UP_TO_LIMIT
7 = FAILED_ADMISSION_CONTROL
8 = FAILED_SERVICE_NOT_RUNNING
9 = FAILED_JMS_ENQUEUE
10 = UNKNOWN_SCHEME
11 = FAILED_OPERATION
12 = FAILED_OTHER
13 = INVALID
14 = GROUPS_NOT_ALLOWED
15 = UNRESOLVED_GROUPS
16 = FAILED_TRAFFIC_SHAPING
|
SERVICEDATA |
Semicolon-delimited list of attributes described in the following tables, written in the format key=value;key=value... |
Service data for sendMessage operation
The
following table lists part names and service attributes used by sendMessage.
One usage record is written per target (without delivery confirmation).
Table 2. sendMessage service attributes and descriptionsAttribute |
Description |
SERVICE |
The service implementation that is writing the
usage record |
eventTYPE |
The operation name |
REQUESTER |
The originator of the request |
START_TIME |
The start time for the request for example, yyyy-MM-dd'T'HH:mm:ssZ |
Service data for sendMessage Delivery Status operation
The
following table lists part names and service attributes used by sendMessage
to report delivery status. One usage record is written per operation.
Table 3. sendMessage Delivery Status service attributes and descriptionsAttribute |
Description |
SERVICE |
The service implementation that is writing the
usage record |
eventTYPE |
The operation name |
REQUESTER |
The originator of the request |
DELIVERY_STATUS |
Delivery status - possible values are: DeliveredToTerminal
DeliveryImpossible
DeliveryNotificationNotSupported
DeliveredToNetwork
DeliveryUncertain
MessageWaiting
|
TARGET |
The target, for example the tel: prefix
followed by a telephone number |
The following table lists part names and service attributes
used by getMessageDeliveryStatus.
Table 4. getMessageDeliveryStatus
service attributes and descriptionsAttribute |
Description |
SERVICE |
The service implementation that is writing the
usage record |
eventTYPE |
The operation name |
REQUESTER |
The originator of the request |
REQUEST_IDENTIFIER |
The requestIdentifier value
that was included in the request |
Service data for startMessageNotification operation
The following table lists part names and service attributes
used by getReceivedMessages.
Table 5. getReceivedMessages service
attributes and descriptionsAttribute |
Description |
SERVICE |
The service implementation that is writing the
usage record |
eventTYPE |
The operation name |
REQUESTER |
The originator of the request |
The following table lists part names and service attributes
used by getMessage.
Table 6. getMessage service attributes and
descriptionsAttribute |
Description |
SERVICE |
The service implementation that is writing the
usage record |
eventTYPE |
The operation name |
REQUESTER |
The originator of the request |
The
following table lists part names and service attributes used by startMessageNotification.
One usage record is written per operation.
Table 7. startMessageNotification
service attributes and descriptionsAttribute |
Description |
SERVICE |
The service implementation that is writing the
usage record |
eventTYPE |
The operation name |
REQUESTER |
The originator of the request |
START_TIME |
The start time for the request for example, yyyy-MM-dd'T'HH:mm:ssZ |
CORRELATOR |
Correlation information from the end point -
Used to communicate with endpoint for callbacks, this information
must be unique for this service and requester |
SERVICE_ACTIVATION_NUMBER |
The service activation number, for example a
telephone number |
NOTIFICATION_ENDPOINT |
An endpoint URI used for notifications by the
service |
Service data for stopMessageNotification operation
The
following table lists part names and service attributes used by stopMessageNotification.
One usage record is written per operation.
Table 8. stopMessageNotification
service attributes and descriptionsAttribute |
Description |
SERVICE |
The service implementation that is writing the
usage record |
eventTYPE |
The operation name |
REQUESTER |
The originator of the request |
CORRELATOR |
Correlation information from the end point -
Used to communicate with endpoint for callbacks, this information
must be unique for this service and requester |
Service data for notifyMessageReception, notifyMessageDeliveryReceipt
Usage
records are not generated for the notifyMessageReception and notifyMessageDeliveryReceipt
operations.