Grandstream GXP2200XML User Manual
Grandstream Networks, Inc.
GXP2200
XML Based Downloadable Phonebook Guide
GXP2200 XML Based Downloadable Phone Book Guide
Index
INTRODUCTION ........................................................................................... 3
WHAT IS XML ...................................................................................................................................... 3
WHY XML ............................................................................................................................................ 3
XML API ARCHITECTURE .................................................................................................................. 3
XML PHONEBOOK CONFIGURATION ....................................................... 6
FIRMWARE ......................................................................................................................................... 6
LCD CONFIGURATION ....................................................................................................................... 6
PROVISIONING .................................................................................................................................. 9
IMPORT/EXPORT PHONEBOOK ....................................................................................................... 9
XML PHONEBOOK SYNTAX ..................................................................... 14
HEADER ............................................................................................................................................ 14
PHONEBOOK XML STRUCTURE .................................................................................................... 14
PHONEBOOK XML ELEM ENT .......................................................................................................... 15
ROOT ELEMENT <AddressBook> ............................................................................................. 16
<pbgroup> ELEMENT ................................................................................................................ 16
<Contact> ELEMENT ................................................................................................................. 17
<Phone> ELEMENT ................................................................................................................... 18
XML PHONEBO OK EXAMPLE .................................................................. 19
FIRMWARE VERS IO N 1 .0.3.2 XML BASED DOWNLOADABLE PHONEBOOK GUIDE Page 1 of 21
Table of Figure s
GXP2200 XML Based Downloadable Phone Book Guide
Figure 1: GXP2200 XML API via HTTP ....................................................................................................... 4
Figure 2: GXP2200 XML API Structure 1 .................................................................................................... 4
Figure 3: GXP2200 XML API Structure 2 .................................................................................................... 5
Figure 4: Contacts->Options ....................................................................................................................... 6
Figure 5: XML Phone Book Download ........................................................................................................ 7
Figure 6: Import and Export Phone Book XML File ................................................................................... 10
Figure 7: Import Phone Book XML File: Settings ...................................................................................... 10
Figure 8: Import Phone Book XML File: Choose File .................................................................................11
Figure 9: Import Phone Book XML File: Import ..........................................................................................11
Figure 10: Export Phone Book XML File: Settings .................................................................................... 12
Figure 11: Export Phone Book XML File: Choose Directory ...................................................................... 12
Figure 12: Export Phone Book XML File: Export ....................................................................................... 13
Ta ble of Tables
GXP2200 XML Based Downloadable Phone Book Guide
Table 1: <AddressBook> Element ............................................................................................................. 16
Table 2: <pbgroup> Element ..................................................................................................................... 16
Table 3: <Contact> Element ...................................................................................................................... 17
Table 4: <Phone> Element ........................................................................................................................ 18
FIRMWARE VERS IO N 1 .0.3.2 XML BASED DOWNLOADABLE PHONEBOOK GUIDE Page 2 of 21
INTRODUCTION
The Grandstream GXP2200 supports XML based downloadable phone book for users to share and
maintain a phone book remotely easily. Besides directly importing vcard/csv format contacts, loading
contacts from synced-up accounts and manually editing from LCD, the GXP2200 offers this XML API as a
user-friendly download method via the phone's LCD.
For the ease of efficient deployment and management, the XML phone book file could be stored on a web
server for the phones to download. 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 GXP2200 firmware versi on 1.0.3.2 or newer. An example XML phone book file is provided at the
end of this guide. Users could start a phone book by adding contacts to the example file or exporting the
existed phone book file from phone's LCD.
WHAT IS XML
XML (eXtensible Markup Language) is a markup language* for documents and applications containing
structured information. This information contains both content (text, pictures, input box and etc.) and an
indication of what role that content plays (e.g. contents in a section header is different from contents in a
footnote). Almost all documents are structured.
*A markup language is a mechanism to identify structures in a document. The XML specification defines a
standard way to add markup to documents.
WHY XML
What benefits does XML provide to SIP endpoints? XML enables our SIP phones to serve as output
devices and allows the phones to interact with external applications in a flexible and programmable
manner.
XML API ARCHITECTURE
The XML based phone book downloading for the GXP2200 coul d use HTTP or TFTP as the transport
protocol. The fo llow ing f igure shows how it w o rks via HTTP as an example. First, the GXP2200 initiates the
HTTP GET Request to the HTTP server and waits for the response. Once the phone receives the
FIRMWARE VERS IO N 1 .0.3.2 XML BASED DOWNLOADABLE PHONEBOOK GUIDE Page 3 of 21
response with XML content in BODY, it displays the information.
Figure 1: GXP2200 XML API via HTTP
Two types of XML API architecture are introduced below, depending on whether the transaction is via LAN
or Internet.
1. A transaction in the LAN may exchange informati on in the following manner. The GXP2200 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 d isp lay. The following figure shows dow nloading XML phone book file via
HTTP within a LAN.
Figure 2: GXP2200 XML API Structure 1
2. If the above Web Server accesses Internet, it could interact with outside web server and respond with
real-time content to the GXP2200.
FIRMWARE VERS IO N 1 .0.3.2 XML BASED DOWNLOADABLE PHONEBOOK GUIDE Page 4 of 21
Figure 3: GXP2200 XML API Structure 2
As illustrated above, all the logic lies within the server side of the architecture. The GXP2200 phone just
receives the XML documents and displays it accordingly.
FIRMWARE VERS IO N 1 .0.3.2 XML BASED DOWNLOADABLE PHONEBOOK GUIDE Page 5 of 21
XML PHONEBOOK CONFIGURATIO N
FIRMWA R E
Before the XML phone book is used on GXP2200, 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
LCD CONFIGURATION
To download the XML phone book file to GXP2200, go to LCD Menu->Contacts and tap on
Options->Download to open the XML Phone Book download interface.
Figure 4: Contacts->Options
FIRMWARE VERS IO N 1 .0.3.2 XML BASED DOWNLOADABLE PHONEBOOK GUIDE Page 6 of 21
Loading...