Grandstream Networks, Inc.
XML Application Guide
Page 5 of 24
Last Updated: 3/2009
NOTE:
As of April 2008 Grandstream Networks is working on a solution to be able to download phonebooks
that are 100+ entries large. The phones currently only support 500 entries if they are entered manually.
As a recommendation we suggest all XML phonebooks to be limited to 100 entries for the time being.
The following Phonebook API configuration will work with all GXP Series models.
P
HONEBOOK
API
C
ONFIGURATION
The XML Custom Screen API is configurable in 4 steps:
1.
Enable Downloadable Phonebook
(P330):
NO/YES-HTTP/YES-TFTP (default NO). Possible
values 0 (NO)/1 (HTTP)/2 (TFTP), other values ignored.
2.
Phonebook XML Path (P331):
This is a string of up to
128 characters
that contains a path to the
XML file. It must follow the host/path format.
i.e.
“directory.grandstream.com/engineering”
3.
Phonebook Download Interval (P332):
This field sets the time interval to download the
phonebook (in hours) automatically. Valid value range is 0-720 (default 0).
4.
Remove manually remove edited entries on download:
YES/NO (default NO) P333, possible
values 0/1, other values ignored.
The XML phonebook feature is activated when “
Enable Downloadable Phonebook
” is set to
YES
(HTTP or
TFTP) and a valid “
Phonebook XML Path
” is set.
The phone will download the
gs_phonebook.xml
file specified in “
Phonebook XML Path
”. The XML
application is effective immediately after download. Save the file for future use. During this process the LCD
will display a message to indicate the XML Phonebook download is in progress.
NOTE:
•
The phonebook file name is fixed and cannot be changed based on personal preference.
•
If the “
Phonebook Download Interval
” is set to a non-zero value
x
, the phonebook is automatically
updated every
x
hours.
•
If the “
Remove manually edited entries on download
” option is set to
No
(by default), the phone will
keep ALL previously stored phonebook entries, insert the downloaded phonebook entries, and then
save the phonebook. If set to
Yes
, the downloaded phonebook entries will replace the existing
phonebook stored on the phone.
•
At any time, you can immediately download the phonebook by choosing the “
Download
Phonebook
” in the GUI Phone Book Menu (you can use the down arrow key when the phone is on-
hook).
