Grandstream Networks GXV3240 User manual

GXV3240/GXV3275 GMI WEB SERVICE GUIDE
Grandstream Networks, Inc.
GXV3240/GXV3275
GMI Web Service Guide v1.9 User Guide

GXV3240/GXV3275 GMI WEB SERVICE GUIDE V1.9 Page 1 of 40
Index
OVERVIEW .........................................................................................................................................3
GMI WEB SERVICE INTERFACE.....................................................................................................4
1. webServiceLogin(ip, username, password, callbckFunction)...............................................4
2. getUptime(callbackFunction)................................................................................................5
3. getPN(callbackFuntion)........................................................................................................5
4. getHardware(callbackFunction)............................................................................................6
5. getVendor(callbackFuntion)..................................................................................................6
6. getProduct(callbackFuntion).................................................................................................7
7. getProductInfo(callbackFunction) ........................................................................................7
8. originateCall(account, isvideo isdialplan, destnum, headerstring, callbackFuntion)............8
9. getNetworkInfo(callbackFunction).......................................................................................9
10. getAccountInfo(callbackFunction)..................................................................................9
11. getGroup(gpID, callbackFuntion) .................................................................................10
12. getContact(ctID, gpID, ctName, callbackFuntion)........................................................11
13. getGroupCount(callbackFuntion)..................................................................................11
14. getContactCount(callbackFuntion)................................................................................12
15. phbkresponse(phbkGroup, callbackFuntion).................................................................12
16. setContact(phbkContact, callbackFuntion) ...................................................................13
17. removeContact(ctID, callbackFunction) .......................................................................14
18. clearGroup(gpID, callbackFunction).............................................................................15
19. removeGroup(gpID, callbackFunction).........................................................................16
20. moveToDefault(ctID, callbackFuntion).........................................................................16
21. downloadPhonebook(phbkConfigure, flag, callbackFunction).....................................17
22. setPhonebook(phbkConfigure, flag, callbackFunction)................................................19
23. getMessage(id, callFunction) ........................................................................................22
24. setNewMessage(num, account, text, flag, callbackFunction) .......................................23
25. sendDraftMessage(id, callbackFunction)putportphbk...................................................24
26. removeMessage(id, flag, callbackFunction)..................................................................24
27. saveMessage(callbackFunction)....................................................................................25
28. getLastCall(type, callbackFunction)..............................................................................25
29. removeCall(id, flag, callbackFuntion)...........................................................................26
30. saveCallHistory(callbackFunction)...............................................................................27
31. setUpgrade(upgradeConf, reboot, callbackFunction)....................................................27
32. setParameter(confItem[ ], callbackFuntion)..................................................................30
33. getParameter(confItem[ ], callbackFuntion)..................................................................31
34. launchService(name, arg, callbackFunction).................................................................32
35. closeService(name, callbackFunction)..........................................................................33
36. grabWindow(path, callbackFuntion).............................................................................34
37. touchScreen(x, y, msec, callbackFunction) ...................................................................35
38. getGMIVersion..............................................................................................................35
39. getPhoneStatus ..............................................................................................................36
40. getPhoneMem................................................................................................................36

GXV3240/GXV3275 GMI WEB SERVICE GUIDE V1.9 Page 2 of 40
41. getcStatus.......................................................................................................................37
42. EndCall..........................................................................................................................38
43. getMinPlugins ...............................................................................................................38
44. swipScreen(start_x, start_y, end_x,end_y, callbackFunction).......................................39
GMIService EXAMPLE.....................................................................................................................40
USING JAVASCRIPT.................................................................................................................40

GXV3240/GXV3275 GMI WEB SERVICE GUIDE V1.9 Page 3 of 40
OVERVIEW
GMI (Grandstream Manager Interface) is a management API developed by Grandstream
Networks, Inc. Designed for our IP Multimedia phones, it allows partners to develop customized
applications on the phone.
Note:
The number of GMI web service interfaces is growing with increasing customer demands. Some
interfaces in this guide are newly introduced after certain GMI version. To avoid compatibility
issue, we added getGMIVersion interface for users to retrieve current GMI interface version. For
interfaces that require specific GMI version, please use getGMIVersion to match the returned
version number. For interfaces that do not have GMI version requirement, they exist in all GMI
versions and there is no need to identify GMI version.

GXV3240/GXV3275 GMI WEB SERVICE GUIDE V1.9 Page 4 of 40
GMI WEB SERVICE INTERFACE
GMI Service provides basic API to facilitate users calling the existing application on the
GXV3240/GXV3275 to retrieve the phone's status. Different development environments provide
different interface types. Usually, JavaScript and Windows MFC can be used for development.
No matter what programming language is used, the functions in the interface have the same
name and parameters, which are included in GMIService class. Users could define the interface
according to the parameters and HTTP request. This section describes details for each interface.
Note：Parameter account in each interface represents the account index. This is the index
number retrieved from getAccountInfo interface.
1. webServiceLogin(ip, username, password, callbckFunction)
Description
Login GXV3240/GXV3275 web GUI with IP address, username and
password. This interface has to be executed first before using other
interfaces (except getVendor, getProduct and getProductInfo
interfaces).
In addition, in order to avoid the conflict between Web UI and GMI
Service that causes users cannot log in Web UI, we recommend that
users log in with user name "gmiadmin". "gmiadmin" has the same
password as Web UI administrator login user name "admin".
Parameters
ip: Phone's IP address
username: Web GUI login username
password: Web GUI login password
callbackFunction: Call back function
Http Request
url: "http://"+ ip + "/manager?"
action: "login"
username: "admin"
secret: "123"
format: "json"
jsoncallback: "?" (This is the HTTP request for the call back function,
usually used in AJAX and JQuery)
For example:
http://192.168.121.230/manager?action=login&username=admin&secre
t=123&format=json&jsoncallback=?
Return
1. HTTP request return:
Login successful
"{"res": "success", "msg" : "authentication accepted"}"
Login failed if username or password is missing or incorrect
"{"res": "error", "msg" : "authentication failed"}"
2. callbackFunction(data) will process the data returned from HTTP
request

GXV3240/GXV3275 GMI WEB SERVICE GUIDE V1.9 Page 5 of 40
Note
For the HTTP requests in each interface introduced below, if the
action data is empty or incorrect, the following message will be
returned:
"{"res": "error", "msg": "command not found"}"
For the interfaces introduced below, if the HTTP requests' interval is
more than 900s, the request will be disconnected. The following
message will be returned and users will need login again.
"{"res": "error", "msg": "authentication required"}"
2. getUptime(callbackFunction)
Description
Retrieve current system up time
Parameters
callbackFunction: Call back function
Http Request
url: "http://"+ ip + "/manager?"
action: "uptime"
format: "json"
jsoncallback: "?" (This is the HTTPrequest for the call back function,
usually used in AJAX and JQuery)
For example:
http://192.168.121.230/manager?action=uptime&format=json&jsoncallb
ack=?
Return
1. HTTP request return:
Return successful
"{"res": "success", "day": "1", "hour" : "12", "min" : "23", "sec" : "45"}"
Return failed
"{"res": "error", "msg": "can't get uptime"}"
2. callbackFunction(data) will process the data returned from HTTP
request
3. getPN(callbackFuntion)
Description
Retrieve GXV3240/GXV3275 P/N number
Parameters
callbackFunction: Call back function
Http Request
url: "http://"+ ip + "/manager?"
action: "pn"
format: "json"
jsoncallback: "?" (This is the HTTP request for the call back
function, usually used in AJAX and JQuery)
For example:
http://192.168.121.230/manager?action=pn&format=json&jsoncallback
=?
Return
1. HTTP request return:
Return successful

GXV3240/GXV3275 GMI WEB SERVICE GUIDE V1.9 Page 6 of 40
"{"res": "success", "pn": "9620001902A"}"
Return failed
"{"res": "error", "msg" : "can't get pn version"}"
2. callbackFunction(data) will process the data returned from HTTP
request
4. getHardware(callbackFunction)
Description
Retrieve GXV3240/GXV3275 Hardware version
Parameters
callbackFunction: Call back function
Http Request
url: "http://"+ ip + "/manager?"
action: "hardware"
format: "json"
jsoncallback: "?" (This is the HTTPrequest for the call back function,
usually used in AJAX and JQuery)
For example:
http://192.168.121.230/manager?action=hardware&format=json&jsonca
llback=?
Return
1. HTTP request return:
Return successful
"{"res": "success", "hardware": "V2.0A"}"
Return failed
"{"res": "error", "msg" : "can't get hardware version"}"
2. callbackFunction(data) will process the data returned from HTTP
request
5. getVendor(callbackFuntion)
Description
Retrieve GXV3240/GXV3275 vendor information
(login is not required)
Parameters
callbackFunction: Call back function
Http Request
url: "http://"+ ip + "/manager?"
action: "vendor"
format: "json"
jsoncallback: "?" (This is the HTTP request for the call back
function, usually used in AJAX and JQuery)
For example:
http://192.168.121.230/manager?action=vendor&format=json&jsonca
llback=?
Return
1. HTTP request return:
Return successful
"{"res": "success", "vendor": "Grandstream Networks, Inc."}"

GXV3240/GXV3275 GMI WEB SERVICE GUIDE V1.9 Page 7 of 40
Return failed
"{"res": "error", "msg" : "can't get vendor"}"
2. callbackFunction(data) will process the data returned from HTTP
request
6. getProduct(callbackFuntion)
Description
Retrieve GXV3240/GXV3275 product information
(login is not required)
Parameters
callbackFunction: Call back function
Http Request
url: "http://"+ ip + "/manager?"
action: "vendor"
format: "json"
jsoncallback: "?" (This is the HTTP request for the call back
function, usually used in AJAX and JQuery)
For example:
http://192.168.121.230/manager?action=product&format=json&jsonc
allback=?
Return
1. HTTP request return:
Return successful
"{"res": "success", "product": "GXV3240"}"
"{"res": "success", "product": "GXV3275"}"
Return failed
"{"res": "error", "msg" : "can't get product model"}"
2. callbackFunction(data) will process the data returned from HTTP
request
7. getProductInfo(callbackFunction)
Description
Retrieve GXV3240/GXV3275 vendor and product information (login
is not require). The interface is combined by getVendor and
getProduct.
Parameters
callbackFunction: Call back function
Http Request
url: "http://"+ ip + "/manager?"
action: "productinfo"
format: "json"
jsoncallback: "?" (This is the HTTP request for the call back
function, usually used in AJAX and JQuery)
For example:
http://192.168.121.230/manager?action=productinfo&format=json&js
oncallback=?
Return
1. HTTP request return:
Return successful

GXV3240/GXV3275 GMI WEB SERVICE GUIDE V1.9 Page 8 of 40
"{"res": "success", "product": "GXV3240","vendor": "Grandstream
Networks, Inc."}"
"{"res": "success", "product": "GXV3275","vendor": "Grandstream
Networks, Inc."}"
Return failed
"{"res": "error", "msg" : "can't get product information"}"
2. callbackFunction(data) will process the data returned from HTTP
request
8. originateCall(account, isvideo isdialplan, destnum, headerstring,
callbackFuntion)
Description
Make calls
Parameters
account: account index (int type, the index value can be retrieved
from getAccountInfo interface)
isvideo: audio call or video call. 0 - audio; 1 - video
isdialplan: 0 or 1
destnum: the number to be dialed
headerstring: SIP request header
callbackFunction: Call back function
Http Request
url: "http://"+ ip + "/manager?"
action: "originatecall"
destnum: "8108819"
account: 0
isvideo: 0
isdialplan: 0
headerstring: ""
format: "json"
jsoncallback: "?" (This is the HTTP request for the call back function,
usually used in AJAX and JQuery)
For example:
http://192.168.121.230/manager?action=originatecall&destnum=810881
9&account=0&isvideo=0&isdialplan=0&headerstring=&format=json&jso
ncallback=?
Return
HTTP request return:
Call originated
"{"res": "success", "msg": "call originated"}"
Destination number is empty
"{"res": "error", "msg" : "destnum can't be null"}"
Timeout
"{"res": "error", "msg" : "timeout"}"
callbackFunction(data) will process the data returned from HTTP
request

GXV3240/GXV3275 GMI WEB SERVICE GUIDE V1.9 Page 9 of 40
9. getNetworkInfo(callbackFunction)
Description
Retrieve GXV3240/GXV3275 network status
Parameters
callbackFunction: Call back function
Http Request
url: "http://"+ ip + "/manager?"
action: "network"
format: "json"
jsoncallback: "?" (This is the HTTP request for the call back
function, usually used inAJAX and JQuery)
For example:
http://192.168.121.230/manager?action=network&format=json&jsonc
allback=?
Return
1. HTTP request return:
"{"res":"success", "mac":"00-0b-82-29-5c-a7", "ip":"192.168.121.230",
"mask":"255.255.255.0","gateway":"192.168.121.1","dns":"192.168.1
21.253", "type" : "dhcp"}"
2. callbackFunction(data) will process the data returned from HTTP
request
10. getAccountInfo(callbackFunction)
Description
Retrieve GXV3240/GXV3275 account information
Parameters
callbackFunction: Call back function
Http Request
url: "http://"+ ip + "/manager?"
action: "accountStatus"
format: "json"
jsoncallback: "?" (This is the HTTP request for the call back
function, usually used in AJAX and JQuery)
For example:
http://192.168.121.230/manager?action=status&format=json&jsoncall
back=?
Return
1. HTTP request return:
{"Response":"Success","Data":[{"Index":"1","Server":"192.168.120.25
4","Number":"3882","Status":"1","Activate":"1"},
{"Index":"0","Server":"sip.ipvideotalk.com:48879","Number":"8118263
","Status":"1","Activate":"1"},
{"Index":"2","Server":"192.168.121.22","Number":"1001","Status":"1","
Activate":"1"}]}
2. String definition:

GXV3240/GXV3275 GMI WEB SERVICE GUIDE V1.9 Page 10 of 40
Index: The account index. From 0 to 5 for account 1 to account 6.
This is the account index used in originateCall function.
Server: The SIP server address for the account.
Number: The account number.
Status: account status. 0 - unregistered; 1 and 2 - registered; 3
and 5 - dialing; 4 - ringing; 6 - talking
Activate: account activated/deactivated. 1 - activated; 0 -
deactivated
11. getGroup(gpID, callbackFuntion)
Description
Retrieve phonebook group information for group gpID. If gpID is empty,
return information for all groups
Parameters
gpID: phonebook group ID
callbackFunction: Call back function
Http Request
url: "http://"+ ip + "/manager?"
action: "getgroup"
groupID: ""
format: "json"
jsoncallback: "?" (This is the HTTP request for the call back function,
usually used in AJAX and JQuery)
For example:
http://192.168.121.230/manager?action=getgroup&groupID=&format=js
on&jsoncallback=?
Return
1. HTTP request return:
Return successful
"{"res": "success", "msg": [{"groupID":"0","groupName":"default"},
{"groupID":"100","groupName":"blacklist"}]}"
No groups
"{"res": "error", "msg" : "0"}"
Return failed
"{"res": "error", "msg" : "can't get groups information"}"
Parameters in wrong format (GMI version 9 or newer)
"{"res": "error", "msg" : "wrong format"}"
2. callbackFunction(data) will process the data returned from HTTP
request
Note:
When using this interface, if the interface amount is greater than 12, it
will be exported into text format stored in the phone.

GXV3240/GXV3275 GMI WEB SERVICE GUIDE V1.9 Page 11 of 40
12. getContact(ctID, gpID, ctName, callbackFuntion)
Description
1. Retrieve contact information
If ctID is specified but ctName is empty, return the contact ctID
If ctName is specified, return the contacts which has string ctName
in its name field
If ctID and ctName are empty but gpID is specified, return all the
contacts in group gpID
If ctID, ctName and gpID are empty, return all contacts
2. Before using getContact interface, users could get the number of
contacts by getContactCount interface first. If the number of contacts is
more than 20, it is recommended to use setPhonebook interface
instead of getContact interface.
Parameters
callbackFunction: Call back function
Http Request
url: "http://"+ ip + "/manager?"
action: "getcontact"
contactID: ""
groupID: ""
contactName: ""
format: "json"
jsoncallback: "?" (This is the HTTP request for the call back function,
usually used in AJAX and JQuery)
For example:
http://192.168.121.230/manager?action=getcontact&contactID=&groupI
D=&contactName=&format=json&jsoncallback=?
Return
1. HTTP request return:
Return successful
"{"res": "success", "msg":
[{"contactID":"0","contactName":"xxx","groupID":"0","work":"8819","h
ome":"", "mobile":"","fax":"","photo":"","email":""},
{“ontactID”:”1","contactName":"grandstream","groupID":"0","work":"3
587","home":"", "mobile":"","fax":"","photo":"","email":""}]}"
No contacts
"{"res": "error", "msg" : "0"}"
Return failed
"{"res": "error", "msg" : "can't get contacts information"}"
Parameters in wrong format (GMI version 9 or newer)
"{"res": "error", "msg" : "wrong format"}"
2. callbackFunction(data) will process the data returned from HTTP
request
13. getGroupCount(callbackFuntion)
Description
Retrieve the number of groups in phonebook
Parameters
callbackFunction: Call back function

GXV3240/GXV3275 GMI WEB SERVICE GUIDE V1.9 Page 12 of 40
Http Request
url: "http://"+ ip + "/manager?"
action: "getgroupcount"
format: "json"
jsoncallback: "?" (This is the HTTP request for the call back function,
usually used in AJAX and JQuery)
For example:
http://192.168.121.230/manager?action=getgroupcount&format=json&js
oncallback=?
Return
1. HTTP request return:
Return successful
"{"res": "success", "msg": "3"}"
Return failed
"{"res": "error", "msg" : "can't get group count"}"
2. callbackFunction(data) will process the data returned from HTTP
request
14. getContactCount(callbackFuntion)
Description
Retrieve the number of contacts in phonebook
Parameters
callbackFunction: Call back function
Http Request
url: "http://"+ ip + "/manager?"
action: "getcontactcount"
format: "json"
jsoncallback: "?" (This is the HTTP request for the call back function,
usually used in AJAX and JQuery)
For example:
http://192.168.121.230/manager?action=getcontactcount&format=json&j
soncallback=?
Return
1. HTTP request return:
Return successful
"{"res": "success", "msg": "9"}"
Return failed
"{"res": "error", "msg" : "can't get contact count"}"
2. callbackFunction(data) will process the data returned from HTTP
request
15. phbkresponse(phbkGroup, callbackFuntion)
Description
Configure phonebook group information (edit group and add
group)
Phonebook group structure
PhbkGroup

GXV3240/GXV3275 GMI WEB SERVICE GUIDE V1.9 Page 13 of 40
{
gpID; //Group ID, string
gpName; //Group name, string
}
If gpID is empty, the group with gpID will be added. If gpID is
existed, group gpID will be edited.
Parameters
PhbkGroup: Phonebook group information
callbackFunction: Call back function
Http Request
url: "http://"+ ip + "/manager?"
action: "setgroup"
groupInfo: gpID::gpName
Note: each field is connected with “::”
format: "json"
jsoncallback: "?" (This is the HTTP request for the call back
function, usually used in AJAX and JQuery)
For example:
http://192.168.121.230/manager?action=setgroup&groupInfo=1::gran
dstream&format=json&jsoncallback=?
Return
1. HTTP request return:
Return successful
"{"res": "success", "msg": "1"}" //gpID is "1"
Return failed
"{"res": "error", "msg" : "can't set group"}"
groupInfo is empty
"{"res" : "error", "msg": "group information is empty" }"
Group setup failed
"{"res" : "error", "msg": "set group failed" }"
groupInfo wrong format
"{"res" : "error", "msg": "wrong format" }"
Database operation error (GMI version 9 or newer)
"{"res" : "error", "msg": "0" }"
2. callbackFunction(data) will process the data returned from HTTP
request
16. setContact(phbkContact, callbackFuntion)
Description
Configure phonebook contact information (edit contact and add
contact)
Phonebook contact structure
PhbkContact
{
ctID; //Contact ID
ctName; //Contact name

GXV3240/GXV3275 GMI WEB SERVICE GUIDE V1.9 Page 14 of 40
gpID; //Group ID
work; //Work number
home; //Home number
mobile; //Mobile number
fax; //Fax number
mail; //Email address
}
If ctID is empty, contact will be added with a ctID in the returned info.
If ctID is existed, contact ctID will be edited
If contacts need to be added in batch, it is recommended to use
setPhonebook interface to import the contacts
Parameters
PhbkContact: Contact information
callbackFunction: Call back function
Http Request
url: "http://"+ ip + "/manager?"
action: "setcontact"
contactInfo: ctID::ctName::gpID::work::home::mobile::fax::mail
Note: each field is connected with “::”
format: "json"
jsoncallback: "?" (This is the HTTP request for the call back function,
usually used in AJAX and JQuery)
For example:
http://192.168.121.230/manager?action=setcontact&contactInfo=1::gran
dstream::0::5211::2512::1234::0120::::&format=json&jsoncallback=?
Return
1. HTTP request return:
Return successful
"{"res": "success", "msg": "1"}" //ctID is "1"
Return failed
"{"res": "error", "msg" : "can't set contact"}"
"contactInfo" is empty
"{"res" : "error", "msg": "contact information is empty" }"
Contact setup failed
"{"res" : "error", "msg": "set contact failed" }"
"contactInfo" wrong format
"{"res" : "error", "msg": "wrong format" }"
Database operation error (GMI version 9 or newer)
"{"res" : "error", "msg": "0" }"
2. callbackFunction(data) will process the data returned from HTTP
request
17. removeContact(ctID, callbackFunction)
Description
Remove contact ctID from phonebook. If ctID is empty, remove all
contacts
Parameters
ctID: Contact ID

GXV3240/GXV3275 GMI WEB SERVICE GUIDE V1.9 Page 15 of 40
callbackFunction: Call back function
Http Request
url: "http://"+ ip + "/manager?"
action: "removecontact"
contactID: "1"
format: "json"
jsoncallback: "?" (This is the HTTP request for the call back function,
usually used in AJAX and JQuery)
For example:
http://192.168.121.230/manager?action=removecontact&contactID=1&f
ormat=json&jsoncallback=?"
Return
1. HTTP request return:
Remove successful
"{"res": "success"}"
Remove failed
"{"res" : "error", "msg": "remove contact failed" }"
Return data failed
"{"res": "error", "msg" : "can't remove contact"}"
Parameters in wrong format (GMI version 9 or newer)
"{"res" : "error", "msg": "wrong format" }"
Database operation error (GMI version 9 or newer)
"{"res" : "error", "msg": "0" }"
2. callbackFunction(data) will process the data returned from HTTP
request
18. clearGroup(gpID, callbackFunction)
Description
Clear contacts in the group. All the cleared contacts in the group will
be moved to the default group
Parameters
gpID: Group ID
callbackFunction: Call back function
Http Request
url: "http://"+ ip + "/manager?"
action: "cleargroup"
groupID: gpID
format: "json"
jsoncallback: "?" (This is the HTTP request for the call back
function, usually used in AJAX and JQuery)
For example:
http://192.168.121.230/manager?action=cleargroup&groupID=1&for
mat=json&jsoncallback=?
Return
1. HTTP request return:
Clear successful
"{"res": "success"}"
Clear failed
"{"res" : "error", "msg": "clear group failed" }"

GXV3240/GXV3275 GMI WEB SERVICE GUIDE V1.9 Page 16 of 40
Return data failed
"{"res": "error", "msg" : "can't clear group"}"
"groupID" is empty
"{"res" : "error", "msg": "ID is empty" }"
2. callbackFunction(data) will process the data returned from HTTP
request
Note
The default group cannot be cleared. The ctID of the default group is
0.
19. removeGroup(gpID, callbackFunction)
Description
Remove phonebook group according to group ID. If gpID is empty,
delete all the groups.
Parameters
gpID: Group ID
callbackFunction: Call back function
Http Request
url: "http://"+ ip + "/manager?"
action: "removegroup"
groupID: gpID
format: "json"
jsoncallback: "?" (This is the HTTP request for the call back function,
usually used in AJAX and JQuery)
For example:
http://192.168.121.230/manager?action=removegroup&groupID=1&for
mat=json&jsoncallback=?
Return
1. HTTP request return:
Remove successful
"{"res": "success"}"
Remove failed
"{"res" : "error", "msg": "remove group failed" }"
Return data failed
"{"res": "error", "msg" : "can't remove group"}"
Parameters in wrong format (GMI version 9 or newer)
"{"res" : "error", "msg": "wrong format" }"
Database operation error (GMI version 9 or newer)
"{"res" : "error", "msg": "0" }"
2. callbackFunction(data) will process the data returned from HTTP
request
Note
The default group and blacklist cannot be removed. The gpID of the
default group is 0; the gpID of the blacklist is 100.
20. moveToDefault(ctID, callbackFuntion)
Description
Move the contact to default phonebook group
Parameters
ctID: Contact ID

GXV3240/GXV3275 GMI WEB SERVICE GUIDE V1.9 Page 17 of 40
callbackFunction: Call back function
Http Request
url: "http://"+ ip + "/manager?"
action: "movetodefault"
contactID: ctID
format: "json"
jsoncallback: "?" (This is the HTTP request for the call back function,
usually used in AJAX and JQuery)
For example:
http://192.168.121.230/manager?action=movetodefault&contactID=1&fo
rmat=json&jsoncallback=?
Return
1. HTTP request return:
Move successful
"{"res": "success"}"
Move failed
"{"res" : "error", "msg": "move contact to default failed" }"
Return data failed
"{"res": "error", "msg" : "can't move contact to default"}" //dbus
returns null
"contactID" is empty
"{"res" : "error", "msg": "ID is empty" }"
Parameters in wrong format (GMI version 9 or newer)
"{"res" : "error", "msg": "wrong format" }"
Database operation error (GMI version 9 or newer)
"{"res" : "error", "msg": "0" }"
2. callbackFunction(data) will process the data returned from HTTP
request
Note
If the ctID is the default group ID, it won't be processed.
21. downloadPhonebook(phbkConfigure, flag, callbackFunction)
Description
Set up phonebook download configurations and download
phonebook.xml
Phonebook download configuration structure
phbkConfigure
{
mode;
url;
interval;
redup;
clearold;
filetype;
encode;
}
Parameters
phbkConfigure: Phonebook download configuration

GXV3240/GXV3275 GMI WEB SERVICE GUIDE V1.9 Page 18 of 40
confItem: nvram configuration
flag(int): 0 - save phonebook configuration; 1 - save phonebook
configuration and download phonebook
callbackFunction: Call back function
Structure Parameter
Settings
1. mode:
0------OFF
1------TFTP
2------HTTP
2. url: Download Server Address
3. interval
1------None
7200------2 hours
14400------4 hours
21600------6 hours
28800------8 hours
43200------12 hours
4. encode: UTF-8, GBK, UTF-16, UTF-32, Big5, Big5-HKSCS,
Shift-JIS, ISO8859-1, ISO8859-15, Windows-1251, EUC-KR
5. redup:
0------No
1------Yes
6. clearold:
0------No
1------Yes
7. fileType: File Format
0------XML
1------Vcard
2------CSV
Http Request
Phone Download Operation:
url: "http://"+ ip + "/manager?"
action: "putdownphbk"
flag: "1" (Save the configuration and download phonebook)
downMode: "2" (Download mode. 0: OFF, 1: TFTP, 2: HTTP)
downUrl: Download phonebook URL
downInterval: "0" (0: no automatic download)
downReplace: "0" (replace duplicate items, 0: No, 1: Yes)
downClear: "1" (clear old list, 0: No, 1: Yes)
downEncode: "UTF-8" (phonebook file encoding format)
format: "json"
jsoncallback: "?" (This is the HTTP request for the call back
function, usually used in AJAX and JQuery)

GXV3240/GXV3275 GMI WEB SERVICE GUIDE V1.9 Page 19 of 40
For example:
http://192.168.121.230/manager?action=putdownphbk&flag=1downM
ode=2&downUrl=http://192.168.121.29/WebService/Phonebook.xml&
downInterval=0&downReplace=0&downClear=1&downEncode=UTF-8
&downtype=0&format=json&jsoncallback=?
Return
1. HTTP request return:
Phonebook configuration saved
"{"res": "success", "flag":"1"}"
Phonebook configuration cannot be saved
"{"res" : "error", "msg" : "configuration file not found"}"
GXV3240/GXV3275 is rebooting
"{"res": "error", "msg" : "phone rebooting"}"
2. callbackFunction(data) will process the data returned from HTTP
request
Note
In the HTTP request, if flag=1, when the phone is downloading and
importing phonebook, users could send HTTP request to check if
the downloading/importing is done.
For example:
http://192.168.121.230/manager?action=phbkresponse&format=js
on
Return:
"{"res": "success", "phbkresponse":"0"}"
phbkresponse value:
0: Download successful (for downloading and importing)
1: Downloading
2: Contacts full (for downloading and importing)
3: Parse failed (For downloading and importing)
4: Downloading failed
5: Downloading mode is OFF
6: Download address invalid
8: File encoding format wrong
9: Importing (For importing)
10: File format invalid (for importing)
22. setPhonebook(phbkConfigure, flag, callbackFunction)
Description
Phonebook import/export
Phonebook configuration structure
phbkConfigure
{
mode;
url;
interval;
redup;