PAP push format

Your server-side push initiator can use the PAP push format to send a push request to the PPG. A push request allows you to push content to the specified recipients. A PAP push request is a MIME multipart message that contains a PAP control entity, which defines the delivery parameters, and the data to be pushed.

You send the request as an HTTPS POST request to the PPG. The HTTPS POST request must use the following format:

POST https://cp<CPID>.<HOST>/<PATH><Authorization _Header><PAP_Message>

The variables in the request contain the following information:

<CPID>
The content provider ID that you received from BlackBerry.
<HOST>

The evaluation or production URL that you received from BlackBerry. This evaluation URL uses the following format:

https://cpXXXX.pushapi.eval.blackberry.com

The production URL uses the following format:

https://cpXXXX.pushapi.na.blackberry.com
<PATH>
The constant path, /mss/PD_pushRequest, which must be appended to the <HOST> URL.
<Authorization Header>
The authorization header for a push request. For more information about creating this header, see Adding an authorization header to the push request.
<PAP Message>
The multipart message with the PAP control entity and data. For more information about creating this message, see Creating a PAP push message.

Elements of a PAP push message

Element Attributes Description
<pap>  

Defines a PAP control entity.

<push-message>

push-id

source-reference

ppg-notify-requested-to

deliver-before-timestamp

The globally unique push ID or message ID.

The application ID that you received from BlackBerry.

The URL that the PPG can post result notification messages to. If you include the value for the <quality-of-service> element, you should specify a value for this attribute. This attribute is optional.

The date and time, in 24-hour UTC format, that the push request must be delivered before or it is considered unsuccessful. This attribute is optional.

<address>

address-value

The recipient PIN number. It can be a single PIN number or multiple PIN numbers.

<quality-of-service>

delivery-method

The level of reliability for the push request. The value that you specify defines the criteria for a successful outcome of the push request.

The PPG supports the delivery-method attribute, which can have one of the following values:

confirmed
This value is equivalent to app-level acknowledgment. The BlackBerry device sends an acknowledgment notification message to the PPG only when the content reaches the push-enabled app on the device.
unconfirmed, preferconfirmed, or notspecified
These values are equivalent to transport-level acknowledgment. The PPG treats these values identically. The BlackBerry device sends an acknowledgment notification message to the PPG when the content reaches the BlackBerry device.

Last modified: 2015-06-11



Got questions about leaving a comment? Get answers from our Disqus FAQ.

comments powered by Disqus