WebSphere brand IBM WebSphere Telecom Web Services Server, Version 7.1

Usage records for Parlay X SMS over SMPP

Parlay X SMS over SMPP uses the Usage Record component Web service to record events related to a service request.

Parlay X SMS over SMPP service record

Usage records for Parlay X SMS over SMPP 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 descriptions
Attribute 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 sendSms, sendSmsLogo, and sendSmsRingtone operations

The following table lists part names and service attributes used by sendSms, sendSmsLogo, and sendSmsRingtone. One usage record is written per target (without delivery confirmation).
Table 2. sendSms, sendSmsLogo, and sendSmsRingtone service attributes and descriptions
Attribute Description
DELIVERY_STATUS The delivery result for the address. One of the following:
  • Successfully delivered to Terminal. (Final state)
  • Unsuccessful delivery. The message could not be delivered before it expired. (Final state)
  • Cannot provide delivery receipt notification. A notifySmsDeliveryReceipt operation generates aDeliveryNotificationNotSupported message, indicating that delivery receipt for the specified address in a sendSms request is not supported. When this state is stored, a ServiceException is also returned. Therefore, this state must be set by the front end, and no queued request will take place. (Final state)
  • Successful delivery to network. (Not the final state)
  • Delivery status unknown because it was handed off to another network. The network has reported that it cannot deliver the message because the device is not available. (Not the final state)
  • The message is still queued for delivery. (A temporary state, pending transition to one of the other states)
START_TIME Time the operation began
REQUESTER Value of the requester ID
TARGET The target address for this message
SERVICE The service name requesting this operation
NETWORK_ID Name of the network
ASSIGNMENT_ID Parlay assignment ID associated with the request

Service data for getSmsDeliveryStatus operation

The following table lists part names and service attributes used by getSmsDeliveryStatus. One usage record is written per operation.
Table 3. getSmsDeliveryStatus service attributes and descriptions
Attribute Description
START_TIME Time of the beginning of the operation
SERVICE The service name requesting this operation
REQUESTER The requester URI, converted to a string that identifies the application that issued the service request
REQUEST_IDENTIFIER Identifies a specific SMS delivery request

Service data for getReceivedSms operation

The following table lists part names and service attributes used by getReceivedSms. One usage record is written per operation.
Table 4. getReceivedSms service attributes and descriptions
Attribute Description
REGISTRATION_IDENTIFIER The registration identifier for the particular request.
START_TIME Time of the beginning of the operation.
SERVICE Service name requesting this operation.
REQUESTER The requester URI, converted to a string that identifies the application that issued the service request.

Service data for startSmsNotification operation

The following table lists part names and service attributes used by startSmsNotification. One usage record is written per operation.
Table 5. startSmsNotification service attributes and descriptions
Attribute Description
CORRELATOR Correlation information from the end point. Used to communicate with endpoint for callbacks, this information must be unique for this service and requester.
START_TIME Time the operation began
SERVICE_ACTIVATION_NUMBER The target address known as the smsServiceActivationNumber; must be unique
SERVICE The service name requesting this operation
REQUESTER The requester URI, converted to a string that identifies the application that issued the service request

Service data for stopSmsNotification operation

The following table lists part names and service attributes used by startSmsNotification. One usage record is written per operation.
Table 6. stopSmsNotification service attributes and descriptions
Attribute Description
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 Service name requesting this operation
REQUESTER The requester URI, converted to a string that identifies the application that issued the service request

Service data for service exceptions

The following table lists part names and service attributes used for service exceptions.
Table 7. Service data service attributes and descriptions
Attribute Description
FAILURE_DETAIL A detailed error message
FAILURE_REASON An error message ID indicating the nature of the error

Service data for notifySmsDeliveryReceipt

Usage records are not generated for the notifySmsDeliveryReceipt operation.




Terms of use
(C) Copyright IBM Corporation 2009. All Rights Reserved.