Related Manuals for Grandstream Networks Phone Book Guide
Summary of Contents for Grandstream Networks Phone Book Guide
- Page 1 Grandstream Networks, Inc. XML Based Downloadable Phone Book Guide GXP21xx/GXP14xx/GXP116x IP Phone Version 2.0...
-
Page 2: Table Of Contents
XML Based Downloadable Phone Book Guide Index INTRODUCTION ................... 4 WHAT IS XML ............................4 WHY XML ............................4 XML API ARCHITECTURE ........................4 XML PHONEBOOK CONFIGURATION ............7 FIRMWARE ............................7 WEB GUI CONFIGURATION....................... 7 PROVISIONING ..........................8 IMPORT/EXPORT PHONEBOOK ....................... 9 PHONEBOOK XML SNYTAX .............. - Page 3 Table of Figures XML Based Downloadable Phone Book Guide Figure 1: GXP21xx/GXP14xx/GXP116x XML API via HTTP ............... 5 Figure 2: GXP21xx/GXP14xx/GXP116x XML API Structure 1 ..............5 Figure 3: GXP21xx/GXP14xx/GXP116x XML API Structure 2 ..............6 Figure 4: Web GUI Configuration ........................ 7 Figure 5: Import and Export Phone Book XML File ..................
-
Page 4: Introduction
There are also applications that require a centralized directory server and have all phones synchronized with the server periodically. This document specifies the Grandstream XML based downloadable phone book configuration that will be applied to GXP21xx/GXP14xx/GXP116x firmware version 1.0.5.15. An example XML phone book file is provided at the end of this guide. -
Page 5: Figure 1: Gxp21Xx/Gxp14Xx/Gxp116X Xml Api Via Http
or TFTP as the transport protocol. The following figure shows how it works via HTTP as an example. First, the GXP21xx/GXP14xx/GXP116x initiates the HTTP GET Request to the HTTP server and waits for the response. Once the phone receives the response with XML content in BODY, it displays the information. Figure 1: GXP21xx/GXP14xx/GXP116x XML API via HTTP Two types of XML API architecture are introduced below, depending on whether the transaction is via LAN or Internet. -
Page 6: Figure 3: Gxp21Xx/Gxp14Xx/Gxp116X Xml Api Structure 2
Figure 3: GXP21xx/GXP14xx/GXP116x XML API Structure 2 As illustrated above, all the logic lies within the server side of the architecture. The GXP21xx/GXP14xx/GXP116x phone just receives the XML documents and displays it accordingly. FIRMWARE VERSION 1.0.5.15 XML BASED DOWNLOADABLE PHONEBOOK GUIDE Page 6 of 15... -
Page 7: Xml Phonebook Configuration
Before the XML phone book is used on GXP21xx/GXP14xx/GXP116x, 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 WEB GUI CONFIGURATION To download the XML phone book file to GXP21xx/GXP14xx/GXP116x, first enable the XML Phone Book Download and configure the Server Path under Web GUI->Phone Book->Phone Book Management page. -
Page 8: Provisioning
• Phone Book XML Server Path This specifies the path where the phone is going to download the XML phone book file. The maximum length is 256 characters. Since download method is already specified in the previous selection, users do not have to provide this information in the server path. The accepted format are as follows: IP_address[:port]/dir Hostname[:port]/dir Examples:... -
Page 9: Import/Export Phonebook
• P330: Enable Phone Book XML Download. Possible values: 0 (Disabled) / 1 (HTTP) / 2 (TFTP) / 3 (HTTPS); other values are ignored. The default value is 0. • P331: Phone Book XML Server Path. This is a string up to 256 characters that should contain a path to the phonebook.xml file. - Page 10 • Download XML Phone Book Click on the "Download" button to download the phonebook.xml file to your PC locally. • Upload XML Phone Book Click on the "Upload" button and then select the phonebook.xml file from your PC to upload to the phone directly.
-
Page 11: Phonebook Xml Snytax
PHONEBOOK XML SNYTAX HEADER In the first line of the XML document, the following header can be set as XML declaration. It defines the XML version and encoding. On the GXP21xx/GXP14xx/GXP116x, UTF-8 is used as encoding method for correct display. <?xml version="1.0"... -
Page 12: Phonebook Xml Element
PHONEBOOK XML ELEMENT This section describes details of the XML element used in GXP21xx/GXP14xx/GXP116x 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. <AddressBook>... -
Page 13: Phone> Element
Table 2: <Contact> Element Object Position Type Values Comments Contact Element Mandatory Each contact is an entry LastName Child element At least one of String Last name of the contact them is present FirstName Child element String First name of the contact Phone Child element Mandatory... -
Page 14: Xml Phonebook Example
XML PHONEBOOK EXAMPLE <?xml version="1.0" encoding="UTF-8"?> <AddressBook> <Contact> <LastName>Doe</LastName> <FirstName>John</FirstName> <Phone> <phonenumber>8000</phonenumber> <accountindex>1</accountindex> </Phone> <Groups> <groupid>0</groupid> </Groups> </Contact> <Contact> <LastName>Smith</LastName> <FirstName>Alan</FirstName> <Phone> <phonenumber>8001</phonenumber> <accountindex>1</accountindex> </Phone> <Groups> <groupid>1</groupid> </Groups> </Contact> <Contact> <LastName>Lee</LastName> <FirstName>Lily</FirstName> <Phone> <phonenumber>6000</phonenumber> <accountindex>2</accountindex> </Phone> <Groups> <groupid>2</groupid> </Groups> </Contact> </AddressBook>... -
Page 15: Table 5: Gxp21Xx Max Number Of Contacts
The maximum number of contacts supported on GXP21xx/GXP14xx/GXP116x is shown in the table below. Please make sure the contact entry in your XML file does not exceed the max number supported on the corresponding model. Table 5: GXP21xx Max Number of Contacts Model Max.
Need help?
Do you have a question about the Phone Book Guide and is the answer not in the manual?
Questions and answers