Appendix A Push XML API
Push XML Reference
Element | Parent Element | Attributes | Enumeration | Description |
|
|
|
|
|
PushMessage | ManagePushMessage |
|
| Parent of the elements that |
|
|
|
| define the content, recipient, |
|
|
|
| and schedule of an alert. |
|
|
|
| Multiple PushMessage |
|
|
|
| elements can be sent in the |
|
|
|
| same HTML string. |
|
|
|
|
|
|
| message_id |
| A numeric value that uniquely |
|
|
|
| identifies the alert and is used |
|
|
|
| to track status. |
|
|
|
|
|
|
| priority | 0 | Emergency alert. |
|
|
| 1 | Normal alert. |
|
|
| 2 | Background alert. |
|
|
|
|
|
|
| action | push | Push to the display; do not |
|
|
|
| include in alert list. |
|
|
| schedule | Push to the display and alert |
|
|
|
| list. |
|
|
| delete | Delete the alert from the |
|
|
|
| schedule and alert list. |
|
|
|
|
|
|
| reloaded | true | Alert has been pushed to the |
|
|
|
| phone. |
|
|
| false | Alert has not been pushed to |
|
|
|
| the phone. Push it according to |
|
|
|
| the schedule. |
|
|
|
|
|
Recipient | PushMessage | id |
| A numeric value that uniquely |
|
|
|
| identifies the recipient. |
|
|
|
|
|
|
| type | device | This recipient is a device. |
|
|
| distribution | This recipient is a distribution |
|
|
|
| list. |
|
|
|
|
|
Subject | PushMessage | none |
| The alert title text, up to 256 |
|
|
|
| characters. The phone display |
|
|
|
| constrains the usable portion |
|
|
|
| of the title to about 20 |
|
|
|
| characters. |
|
|
|
|
|
Body | PushMessage | none |
| The main text of the alert, up to |
|
|
|
| 256 characters. |
|
|
|
|
|
Image | PushMessage | none |
| Optional image URL to include |
|
|
|
| with the alert. |
|
|
|
|
|
Audio | PushMessage | none |
| Optional audio URL to include |
|
|
|
| with the alert. |
|
|
|
|
|
