Appendix A Push XML API
Push XML API Operation
ServerRegistration Response
The ServerRegistration element is a response sent from the Application Gateway to the application after you submit the application’s URL through the Application Gateway Administration Tool. The ServerRegistration element content consists of the Application Gateway IP address and the port over which it will listen for XML strings from the application.
Note See “ServerRegistration,” page 69 for a detailed explanation of the XML.
Subscribers Response
The Subscribers element is a response sent from the Application Gateway to the application after an IP phone registers with the Application Gateway. The Subscribers element attributes define the following:
•The device, which is either the user name associated (in an LDAP directory) with the device or the phone model.
•The department associated with the phone or user (obtained from the Application Gateway connection to your LDAP server).
•The device ID (MAC address).
•The extension associated with the phone or user (obtained from LDAP).
•The action, either add, update, or remove.
Note See “Subscribers,” page 69 for a detailed explanation of the XML.
PushMessageResponse Response
The PushMessageResponse element is a response sent from the Application Gateway to the application after pushing an alert. The contents of the PushMessageResponse element is either "0" (the push was successful) or a negative number (indicating an error condition).
Note See “PushMessageResponse,” page 70 for a detailed explanation of the XML.
Broadcast Server User Guide | 63 |
