Grandstream Networks Phone Book Guide, GXP21 Series, GXP14 Series, GXP116 Series User Manual

Grandstream Networks, Inc.

XML Based Downloadable Phone Book Guide
GXP21xx/GXP14xx/GXP116x IP Phone

Version 2.0

FIRMWARE VERS IO N 1 .0.5.15 XML BASED DOWNLOADABLE PHONEBOOK GUIDE Page 2 of 15

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 ...................................................................... 11

HEADER .............................................................................................................................................11

PHONEBOOK XML STRUCTURE .....................................................................................................11

PHONEBOOK XML ELEM ENT .......................................................................................................... 12

ROOT ELEMENT <AddressBook> ............................................................................................. 12

<Contact> ELEMENT ................................................................................................................. 12

<Phone> ELEMENT ................................................................................................................... 13

<Groups> ELEMENT .................................................................................................................. 13

XML PHONEBOOK EXAMPLE .................................................................. 14

FIRMWARE VERS IO N 1 .0.5.15 XML BASED DOWNLOADABLE PHONEBOOK GUIDE Page 3 of 15

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 ..................................................................................... 9

Ta ble of Tables

XML Based Downloadable Phone Book Guide

Table 1: <AddressBook> Element ............................................................................................................. 12

Table 2: <Contact> Element ...................................................................................................................... 13

Table 3: <Phone> Element ........................................................................................................................ 13

Table 4: <Groups> Element ...................................................................................................................... 13

Table 5: GXP21xx Max Number of Contacts ............................................................................................. 15

FIRMWARE VERS IO N 1 .0.5.15 XML BASED DOWNLOADABLE PHONEBOOK GUIDE Page 4 of 15

INTRODUCTION

The Grandstream GXP21xx/GXP14xx/GXP116x supports XM L based downloadable phone book for users
to share and maintain a phone book via the web easily. Besides LDAP support and manually editing from
LCD or Web GUI, the GXP21xx/GXP14xx/GXP116x offers this XML API as a user-friendly
download/upload method via the phone's web GUI.

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 GXP21xx/GXP14xx/GXP116 x firmware version 1.0.5.15. 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
by exporting the existing phone book file from phone's Web GUI.

WHAT IS XML

XML (eXtensible Markup Language) is a markup language* for documents and applications containing
structured information. This information contains both content (text, pictur es, 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. The GXP21xx/GXP14xx/GXP116x supports three specific XML API: XML Custom Screen, XML
Phone Book, and XML Application (GXP21xx only).

XML API ARCHITECTURE

The XML based phone book downloading for the GXP21xx/GXP14xx/GXP116x could use HTTP/HTTPS

FIRMWARE VERS IO N 1 .0.5.15 XML BASED DOWNLOADABLE PHONEBOOK GUIDE Page 5 of 15

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.

1. A transaction in the LAN may exchange information in the following manner. The
GXP21xx/GXP14xx/GXP116x sends a request to the w eb serve r v ia HTTP /HTTPS /T FTP an d waits for
a response with the XML contents. The web server will handle the request and communi cate 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.

Figure 2: GXP21xx/GXP14xx/GXP116x 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 GXP21xx/GXP14xx/GXP116x.