Versions Compared

Old Version 3

changes.mady.by.user Former user

Saved on

compared with

New Version 4

changes.mady.by.user Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

When the APN agent receives an APNUDR, it sends out the message contained to the Apple device indicated referenced by the DeviceToken.

...

APNUDR UDR Fields

The following fields are included in the APNUDR UDR:

Field

Description

Body (string)

This field contains the body content of the text message to be sent.

CustomPayload (string)

This field contains a custom message that includes with all the tags to be included in the message. When this field is populated (not set to null), it will override the contents of the Body and Title fields.

Info

Example - CustomPayload

Code Block
{"acme2" : [ "bang",  "whiz" ]}

DeviceToken (string)

This field contains the token to for the device that will receive the message is to be sent to.

Title (string)

This field contains the title of the text message to be sent.

Info

Example - Generated message from Body and Title fields

APL:

Code Block
consume {    
	APNUDR aUDR = udrCreate(APNUDR);
	aUDR.Body ="This is an example.";
	aUDR.DeviceToken="7bd78578c2d702201cb291cdec4ad8e736c893b531deae602451e80617b53ae9";
	aUDR.Title="Example Title";
	udrRoute(aUDR);
}

Message:

Code Block
{"aps":{"alert":{"body":"This is an example.","title":"Example Title"}}}

APNResult

When Once the APN agent has sent out a text message based on a received in response to an APNUDR UDR, it returns an APNResult UDR.

...

APNResult UDR Fields

The following fields are included in the APNUDR UDR:

Field

Description

Code (int)

This field contains indicates the result code of the attempt to send a push notification attempt, with the following result codes:

  • 0 - OK

  • 1 - Rejected

  • 2 - Timed out

  • 3 - Error

Message (string)

This field contains provides a descriptive text description for each result code:

  • 0 - Empty

  • 1 - Message from Apple describing reason for rejection

  • 2 - Timeout

  • 3 - Content of any exception that has occurred

Notification (APNUDR)

This field contains the original APNUDR UDR that received by the agent received.