XML PHONEBOOK SYNTAX ..............9 HEADER ..............................9 PHONEBOOK XML STRUCTURE ......................9 PHONEBOOK XML ELEMENT ......................11 ROOT ELEMENT <AddressBook> ....................11 <pbgroup> ELEMENT ........................11 <Contact> ELEMENT ........................12 <Phone> ELEMENT ........................12 XML PHONEBOOK EXAMPLE ..............13 GXP2130/GXP2140/GXP2160 XML Phonebook Guide...
Page 3
Table of Figures GXP2130/GXP2140/GXP2160 XML Based Downloadable Phone Book Guide Figure 1: GXP2130/GXP2140/GXP2160 XML API via HTTP ............... 3 Figure 2: GXP2130/GXP2140/GXP2160 XML API Structure 1 ..............3 Figure 3: GXP2130/GXP2140/GXP2160 XML API Structure 2 ..............4 Figure 4: Web Configuration ......................... 5 Figure 5: Contacts->Local Phonebook ......................
XML API ARCHITECTURE The XML based phone book downloading for the GXP2130/GXP2140/GXP2160 could use HTTP or TFTP as the transport protocol. The following figure shows how it works via HTTP as an example. First, the GXP2130/GXP2140/GXP2160 initiates the HTTP GET Request to the HTTP server and waits for the response.
GXP2130/GXP2140/GXP2160 sends a request to the web server via HTTP/TFTP and waits for a response with the XML contents. The web server will handle the request and communicate with the application server to get the information for the XML phone book content display. The following figure shows downloading XML phone book file via HTTP within a LAN.
GXP2130/GXP2140/GXP2160 phone just receives the XML documents and displays it accordingly. XML PHONEBOOK CONFIGURATION FIRMWARE Before the XML phone book is used on GXP2130/GXP2140/GXP2160, please make sure the firmware on the phone is upgraded to the latest version. Please refer to the following link for firmware upgrading information: http://www.grandstream.com/support/firmware...
1. If "[:port]" is not specified, port 80 will be used as default for HTTP and Port 69 will be used as default for TFTP; 2. The GXP2130/GXP2140/GXP2160 will always look for the phone book file phonebook.xml for downloading if no file name is specified in the server path.
Search, Local Phonebook, Local Group or Broadsoft Phonebook. LCD CONFIGURATION To download the XML phone book file to GXP2130/GXP2140/GXP2160, go to LCD Menu-> Contacts-> Local Phonebook and press Download soft key to start downloading XML Phone Book. XML BASED DOWNLOADABLE PHONEBOOK GUIDE...
PROVISIONING Users may also use the config file to provision the phone with the above XML phone book downloading options. In this case, the GXP2130/GXP2140/GXP2160 needs to be rebooted and provisioned. The corresponding P values are as shown below. ...
XML version and encoding. On the GXP2130/GXP2140/GXP2160, UTF-8 and GBK can be used as encoding method for correct display. Example: <?xml version="1.0" encoding="UTF-8"?> PHONEBOOK XML STRUCTURE An XML phone book example for GXP2130/GXP2140/GXP2160 can be found in the last section of this document. The main structure is represented as below. version pbgroup...
Page 12
<AddressBook> <version>Enter version number here. Usually 1</version> <pbgroup> <id>Enter group id here</id> <name>Enter group name here</name> </pbgroup> <pbgroup> <!-- Enter another group information here, same format as above --> </pbgroup> <Contact> <FirstName>Enter first name here</FirstName> <LastName>Enter last name here</LastName> <Frequent>Favorite contact or not</Frequent>...
PHONEBOOK XML ELEMENT This section describes details of the XML element used in GXP2130/GXP2140/GXP2160 XML phone book file. Please note that the element name is case-sensitive when being used in XML document. ROOT ELEMENT <AddressBook> <AddressBook> is the root element of the XML document. This element is mandatory.
<Contact> ELEMENT <Contact> <FirstName>Enter first name here</FirstName> <LastName>Enter last name here</LastName> <Frequent>Favorite contact or not</Frequent> <Phone type="Specify phone type here"> <phonenumber>Enter phone number here</phonenumber> <accountindex>Enter account index here</accountindex> </Phone> <Department>Enter department name here</ Department > <Group>Enter group ID here</Group> </Contact> Table 3: <Contact>...
Table 4: <Phone> Element Object Position Type Values Comments Phone Element Mandatory It has attribute "type". type: Work/Home/Mobile/Fax/Other phonenumber Child element Mandatory Number Phone number accountindex Child element Mandatory Number From 0 to 5 for account 1 to account 6 XML PHONEBOOK EXAMPLE <?xml version="1.0"...
Page 17
<accountindex>0</accountindex> </Phone> <Department/> <Group>3</Group> </Contact> </AddressBook> Note: The maximum number of contacts supported on GXP2130/GXP2140/GXP2160 is 2000. XML BASED DOWNLOADABLE PHONEBOOK GUIDE Page 15 of 15...