Element: <resultnotification-message>

Valid parent

<pap>

Valid children

<address>, <quality-of-service>

The PPG sends the <resultnotification-message> element to the content provider. This notification message specifies the outcome of the push submission for a set of BlackBerry devices after the final result is known. This notification message is sent only if the original push request was accepted for delivery by the PPG.

On rare occasions, the PPG returns an address of * in the result notification. This happens when the PPG no longer has address information for the original push message but does have the final status of the message. In that case, the addresses are unknown, so the PPG substitutes *.

The acknowledgment notification message includes a child <quality-of-service> element.

Attributes

Attribute

Value(s)

Description

push-id

unique_id

This attribute specifies a string that uniquely identifies the original push request.

sender-address

URL

This attribute specifies the URL of the server within the PPG.

sender-name

text_name

This attribute specifies the name of the server within the PPG.

received-time

time_stamp

This attribute specifies the date and time at which the original push request sent from the content provider was received by the PPG.

The time stamp uses 24-hour UTC format, which is specified using the following format:

YYYY-MM-DDThh:mm:ssZ

For example, a value of 2009-03-10T23:59:00Z specifies a reply time and date of 11:59 on March 10, 2009.

event-time

time_stamp

This attribute specifies the date and time at which the push request reached its final state (delivered or failed).

The time stamp uses 24-hour UTC format, specified using the following format:

YYYY-MM-DDThh:mm:ssZ

For example, a value of 2009-03-10T23:59:00Z specifies a reply date 11:59 on March 10, 2009.

message-state

delivered

rejected

undeliverable

expired

aborted

timeout

cancelled

unknown

This attribute specifies the final state of the push request message. This attribute can have one of the following values:

  • delivered: The message was successfully delivered to the specified BlackBerry device.
  • undeliverable: The message cannot be delivered to the specified device.
  • expired: The message reached its maximum age before it could be delivered to the specified device.
  • cancelled: The message was cancelled by the push initiator before being delivered to the specified device.
  • unknown: The PPG cannot determine the final state of the message for the specified device.

code

status_code

This attribute specifies the code that indicates the outcome of the push request.

desc

description

This attribute provides text describing the outcome of the push request.



Was this information helpful? Send us your comments.