Grandstream Networks, Inc. - GXV3240/3275 GMI Web Service v1.9

GXV3240/3275 GMI Web Service v1.9 User Guide

Grandstream Networks, Inc.

GXV3240/3275 GMI Web Service v1.9

User Guide

GXV3240/3275 GMI Web Service v1.9 User Guide

Page 1 of 44

GXV3240/3275 GMI Web Service v1.9 User Guide

Index

OVERVIEW .................................................................................................. 3

GMI WEB SERVICE INTERFACE ............................................................... 4

webServiceLogin(ip, username, password, callbckFunction) ................................................................ 4

getUptime(callbackFunction) ................................................................................................................. 5

getPN(callbackFuntion) .......................................................................................................................... 5

getHardware(callbackFunction) ............................................................................................................. 6

getVendor(callbackFuntion) ................................................................................................................... 6

getProduct(callbackFuntion) .................................................................................................................. 7

getProductInfo(callbackFunction) .......................................................................................................... 8

originateCall(account, isvideo isdialplan, destnum, headerstring, callbackFuntion) ............................. 8

getNetworkInfo(callbackFunction) ......................................................................................................... 9

getAccountInfo(callbackFunction) ........................................................................................................ 10

getGroup(gpID, callbackFuntion) ......................................................................................................... 10

getContact(ctID, gpID, ctName, callbackFuntion)................................................................................ 11

getGroupCount(callbackFuntion) ......................................................................................................... 12

getContactCount(callbackFuntion) ...................................................................................................... 13

phbkresponse(phbkGroup, callbackFuntion) ....................................................................................... 13

setContact(phbkContact, callbackFuntion) .......................................................................................... 14

removeContact(ctID, callbackFunction) ............................................................................................... 15

clearGroup(gpID, callbackFunction) .................................................................................................... 16

removeGroup(gpID, callbackFunction) ................................................................................................ 17

moveToDefault(ctID, callbackFuntion) ................................................................................................. 18

downloadPhonebook(phbkConfigure, flag, callbackFunction)............................................................. 19

setPhonebook(phbkConfigure, flag, callbackFunction) ....................................................................... 21

getMessage(id, callFunction) ............................................................................................................... 24

setNewMessage(num, account, text, flag, callbackFunction) .............................................................. 25

sendDraftMessage(id, callbackFunction)putportphbk ......................................................................... 26

removeMessage(id, flag, callbackFunction) ........................................................................................ 26

saveMessage(callbackFunction) ......................................................................................................... 27

getLastCall(type, callbackFunction) ..................................................................................................... 28

removeCall(id, flag, callbackFuntion) ................................................................................................... 28

saveCallHistory(callbackFunction) ....................................................................................................... 29

setUpgrade(upgradeConf, reboot, callbackFunction) .......................................................................... 30

setParameter(confItem[ ], callbackFuntion) ......................................................................................... 33

GXV3240/3275 GMI Web Service v1.9 User Guide

Page 2 of 44

getParameter(confItem[ ], callbackFuntion) ......................................................................................... 34

launchService(name, arg, callbackFunction) ....................................................................................... 34

closeService(name, callbackFunction) ................................................................................................ 37

grabWindow(path, callbackFuntion) .................................................................................................... 37

touchScreen(x, y, msec, callbackFunction) ......................................................................................... 38

getGMIVersion ..................................................................................................................................... 39

getPhoneStatus .................................................................................................................................... 39

getPhoneMem ...................................................................................................................................... 40

getcStatus ............................................................................................................................................ 40

EndCall ................................................................................................................................................ 41

getMinPlugins ...................................................................................................................................... 42

swipScreen(start_x, start_y, end_x,end_y, callbackFunction) ............................................................. 42

GMI SERVICE EXAMPLE ......................................................................... 44

USING JAVASCRIPT ........................................................................................................................... 44

GXV3240/3275 GMI Web Service v1.9 User Guide

Page 3 of 44

OVERVIEW

GMI (Grandstream Manager Interface) is a management API developed by Grandstream Networks, Inc.

Designed for Grandstream IP Multimedia phones, it allows partners to develop customized applications on

the phone.

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, getGMIVersion

interface is added 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/3275 GMI Web Service v1.9 User Guide

Page 4 of 44

GMI WEB SERVICE INTERFACE

GMI Service provides basic API to facilitate users calling the existing application on 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 names 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.

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, it is recommended

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

GXV3240/3275 GMI Web Service v1.9 User Guide

Page 5 of 44

"{"res": "error", "msg" : "authentication failed"}"

2. callbackFunction(data) will process the data returned from HTTP

request

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"}"

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 HTTP request 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

getPN(callbackFuntion)

Description

Retrieve GXV3240/GXV3275 P/N number

Parameters

callbackFunction: Call back function

Http Request

• URL: "http://"+ ip + "/manager?"

• action: "pn"

•

format: "json"

GXV3240/3275 GMI Web Service v1.9 User Guide

Page 6 of 44

•

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

"{"res": "success", "pn": "9620001902A"}"

• Return failed

"{"res": "error", "msg" : "can't get pn version"}"

2. callbackFunction(data) will process the data ret

urned from HTTP

request

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 HTTP request 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

getVendor(callbackFuntion)

Description

Retrieve GXV3240/GXV3275 vendor information

(login is not required)

Parameters

callbackFunction: Call back function

GXV3240/3275 GMI Web Service v1.9 User Guide

Page 7 of 44

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."}"

• Return failed

"{"res": "error", "msg" : "can't get vendor"}"

2. callback

Function(data) will process the data returned from HTTP

request

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

GXV3240/3275 GMI Web Service v1.9 User Guide

Page 8 of 44

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

"{"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

originateCall(account, isvideo isdialplan, destnum, headerstring,

callbackFuntion)

Description

Make calls

Parameters

• account: account index (i

nt 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

GXV3240/3275 GMI Web Service v1.9 User Guide

Page 9 of 44

• 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

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 in AJAX 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

GXV3240/3275 GMI Web Service v1.9 User Guide

Page 10 of 44

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:

•

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

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"

GXV3240/3275 GMI Web Service v1.9 User Guide

Page 11 of 44

• 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, i

t

will be exported into text format stored in the phone.

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 con

tacts 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 numb

er 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"

GXV3240/3275 GMI Web Service v1.9 User Guide

Page 12 of 44

• 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

getGroupCount(callbackFuntion)

Description

Retrieve the number of groups in phonebook

Parameters

callbackFunction: Call back function

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

GXV3240/3275 GMI Web Service v1.9 User Guide

Page 13 of 44

"{"res": "success", "msg": "3"}"

• Return failed

"{"res": "error", "msg" : "can't get group count"}"

2. callbackFunction(da

ta) will process the data returned from HTTP

request

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

phbkresponse(phbkGroup, callbackFuntion)

Description

• Conf

igure phonebook group information (edit group and add

group)

• Phonebook group structure

PhbkGroup

{

gpID; //Group ID, string

gpName; //Group name, string

}

• If gpID is empty, the group with gpID will be ad

ded. If gpID is

existed, group gpID will be edited.

GXV3240/3275 GMI Web Service v1.9 User Guide

Page 14 of 44

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 HT

TP

request

setContact(phbkContact, callbackFuntion)

Description

•

Configure phonebook contact information (edit contact and add

contact)

• Phonebook contact structure

PhbkContact

{

ctID; //Contact ID

ctName; //Contact name

gpID; //Group ID

work; //Work number

GXV3240/3275 GMI Web Service v1.9 User Guide

Page 15 of 44

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

removeContact(ctID, callbackFunction)

Description

Remove contact ctID from phonebook. If ctID is empty, remove all

GXV3240/3275 GMI Web Service v1.9 User Guide

Page 16 of 44

contacts

Parameters

•

ctID: Contact ID

•

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

orma

t=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

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

GXV3240/3275 GMI Web Service v1.9 User Guide

Page 17 of 44

mat=json&jsoncallback=?

Return

1. HTTP request return:

• Clear successful

"{"res": "success"}"

• Clear failed

"{"res" : "error", "msg": "clear group failed" }"

• Return data failed

"{"res": "error", "msg" : "can't clear group"}"

• "groupID" is empty

"{"res" : "error", "msg": "ID is empty" }"

2. callbackFu

nction(data) will process the data returned from HTTP

request

Note

The default group cannot be cleared. The ctID of the default group is

0.

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)

GXV3240/3275 GMI Web Service v1.9 User Guide

Page 18 of 44

"{"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.

moveToDefault(ctID, callbackFuntion)

Description

Move the contact to default phonebook group

Parameters

• ctID: Contact ID

• callbackFunction: Call back function

Http Request

• URL: "http://"+ ip + "/manager?"

• action: "movetodefault"

• contactID: ctID

• format: "json"

• jsoncallback: "?" (This is the HTTP reque

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

GXV3240/3275 GMI Web Service v1.9 User Guide

Page 19 of 44

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

• 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:

GXV3240/3275 GMI Web Service v1.9 User Guide

Page 20 of 44

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)

• 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:

GXV3240/3275 GMI Web Service v1.9 User Guide

Page 21 of 44

"{"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)

setPhonebook(phbkConfigure, flag, callbackFunction)

Description

• Phonebook import/export

• Phonebook configuration structure

phbkConfigure

{

mode;

url;

interval;

redup;

clearold;

filetype;

encode;

}

Parameters

• phbkConfigure: Phonebook download configuration

• flag: For import/export

• 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

GXV3240/3275 GMI Web Service v1.9 User Guide

Page 22 of 44

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

1. Export phonebook

(1) Save configuration

• URL: "http://"+ ip + "/manager?"

• action: "putportphbk"

• flag: "0"

• opmode: "1"

• portEncode: "UTF-8"

• portType: "0"

• 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=putportphbk&opmode=1

&flag=0&portType=0&portEncode=UTF-8&format=json&jsoncall

back=?

(2) Save phonebook.xml

• URL: "http://"+ ip + "/manager?"

• action: "savephbk"

• format: "json"

• jsoncallback ------"?"

• For example,

http://192.168.121.230/manager?action=savephbk&format=json

&jsoncallback=?

(3) When "savephbk" succeed, the phoneook.xm

l will be exported to

GXV3240/3275 GMI Web Service v1.9 User Guide

Page 23 of 44

the phone, then users

can download the phonebook.xml from link as

follow:

http://192.168.121.230/phonebook/phonebook.xml

2. Import phonebook

(1) Upload the local phonebook.xml to the phone first.

Then use the

HTTP POST method to send the phonebook

content.

HTTP request header:

http://192.168.121.230/upload?type=phonebook&format=json

(2) Import phonebook

• URL: "http://" + ip +"/manager?"

• action: "putportphbk"

• flag: "1"

• opmode: "0"

• portEncode: "UTF-8"

• portType: "0"

• portReplace: "0"

• portClear: "1"

• format: "json"

• jsoncallback: "?"

• For example:

http://192.168.121.230/manager?action=putportphbk&opmode=0&fla

g=1&portType=0&portEncode=UTF-8&portReplace=0&portClear=1&

format=json&jsoncallback=?

Return

1. HTTP request return:

• "putportphbk": Import successful

"{"res": "success", "flag":"1"}"

• "putportphbk": Import failed

"{"res" : "error", "msg" : "configuration file not found"}"

• "savephbk": Save successful

"{"res": "success"}"

2. callbackFunction(data) will process the

data returned from HTTP

request

Note

1. If the HTTP request returns "savephbk" successfully, users could

send HTTP requests to check whether the phonebook.xml saving

process is done. For example:

http://192.168.121.230/manager?action=portphbkresponse&format=j

son

Return:

•

Saving done:

GXV3240/3275 GMI Web Service v1.9 User Guide

Page 24 of 44

"{"res": "success", "phbkresponse":"0"}"

• Saving in process:

"{"res": "success", "phbkresponse":"1"}"

2. If the HTTP request returns "putportphbk" successfully, users could

send HTTP requests to check whether the phonebook.xml

import

process is done. For example:

http://192.168.121.230/manager?action=phbkresponse&format=json

Return:

• Import done: "{"res": "success", "phbkresponse":"0"}"

• Importing in process:

"{"res": "success", "phbkresponse":"1"}"

• Contacts full

"{"res": "success", "phbkresponse":"2"}"

• Parse failed

"{"res": "success", "phbkresponse":"3"}"

• Import failed

"{"res": "success", "phbkresponse":"4"}"

• Phone is processing

"{"res": "success", "phbkresponse":"9"}

• Invalid file

"{"res": "success", "phbkresponse":"10"}"

getMessage(id, callFunction)

Description

Get message according to message id. When id=-1, get the last

message

Parameters

• id: Message ID

•

callbackFunction: Call back function

Http Request

• URL: "http://"+ ip + "/manager?"

• action: "getmessage"

• id: "-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=getmessage&id=-1&for

mat=json&jsoncallback=?

Return

1. HTTP request return:

• Successful

GXV3240/3275 GMI Web Service v1.9 User Guide

Page 25 of 44

"{"res": "success", "msg" : [{"id" : "15", "number" : "8107314",

"account" : "0", "state", "1", "message" : "hello"}]}"

• Failed

"{"res" : "error", "msg" : "get message failed"}"

• Parameters in wrong format (GMI version 9 or newer)

"{"res" : "error", "msg" : "wrong format"}"

setNewMessage(num, account, text, flag, callbackFunction)

Description

Send message; save message

Parameters

• num: The number to send the message to

• account: Account index

• text: Message content

• flag: Save or send message. 0 - save message to Draft box; 1 -

send message

• callbackFunction: Call back function

Http Request

• URL: "http://"+ ip + "/manager?"

• action: "setnewmessage"

• number: "8107314"

• account: "0"

• content: "hello"

• flag: "1"

• format: "json"

• jsoncallback: "?" (This is the HTTP reques

t for the call back

function, usually used in AJAX and JQuery)

• For example:

http://192.168.121.230/manager?action=setnewmessage&number=

8107314&account=0&content=hello&flag=1&format=json&jsoncallba

ck=?

Return

1. HTTP request return:

• Successful

"{"res": "success"}"

• Failed

"{"res" : "error", "msg" : "set new message failed"}"

• Parameters in wrong format (GMI version 9 or newer)

"{"res" : "error", "msg" : "wrong format"}"

• Database operation error (GMI version 9 or newer)

GXV3240/3275 GMI Web Service v1.9 User Guide

Page 26 of 44

"{"res" : "error", "msg" : "0"}"

sendDraftMessage(id, callbackFunction)putportphbk

Description

Send message from Draft box. After the message is sent, it will be

moved from Draft box to Outbox

Parameters

• id: Message ID

•

callbackFunction: Call back function

Http Request

• URL: "http://"+ ip + "/manager?"

• action: "senddraftmessage"

• messageID: "12"

• 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=senddraftmessage&messa

geID=12&format=json&jsoncallback=?

Return

HTTP request return:

• Send successful

"{"res": "success"}"

• Send failed

"{"res" : "error", "msg" : "send new message failed"}"

removeMessage(id, flag, callbackFunction)

Description

Remove message

Parameters

• flag: Remove type. 1 -

remove all messages from Inbox, Outbox

or Draft box; 0 - remove one message

• id: Message identifier.

flag=1, id=0 - remove all messages in Inbox

flag=1, id=1 - remove all messages in Outbox

flag=1, id=2 - remove all messages in Draftbox

flag=0, id is the message ID -

remove message with message ID

= id

•

callbackFunction: Call back function

Http Request

• URL: "http://"+ ip + "/manager?"

• action: "removemessage"

GXV3240/3275 GMI Web Service v1.9 User Guide

Page 27 of 44

• ID: "1"

• flag: "1"

• format: "json"

• jsoncallback: "?" (This is the HTTP request for t

he call back

function, usually used in AJAX and JQuery)

• For example:

http://192.168.121.230/manager?action=removemessage&ID=1&fla

g=1&format=json&jsoncallback=?

Return

1. HTTP request return:

• Remove successful

"{"res": "success"}"

• Remove failed

"{"res" : "error", "msg" : "remove message failed"}"

• Parameters in wrong format (GMI version 9 or newer)

"{"res" : "error", "msg" : "wrong format"}"

saveMessage(callbackFunction)

Description

Save message.xml

Parameters

callbackFunction: Call back function

Http Request

• URL: "http://"+ ip + "/manager?"

• action: "savemessage"

• 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=savemessage&format=json

&jsoncallback=?

Return

HTTP request return:

• Save successful

"{"res": "success"}"

Note

After HTTP request returns saving successful, users could download

message.xml to the phone using the following link:

http://192.168.121.230/message/message.xml

GXV3240/3275 GMI Web Service v1.9 User Guide

Page 28 of 44

getLastCall(type, callbackFunction)

Description

Get the last call log (answered calls, dialed calls or missed calls)

entry information

Parameters

• type: Call log type. 0 - answered calls; 1 - dialed calls; 2 -

missed

calls

• callbackFunction: Call back function

Http Request

• URL: "http://"+ ip + "/manager?"

• action: "getlastcall"

• type: "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=getlastcall&type=1&format

=json&jsoncallback=?

Return

HTTP request return:

• Successful

"{"res": "success"，

"msg" : [{"id" : "15", "number" : "8107314",

"account" : "0", "isVideo", "0"}]}"

• Failed

"{"res" : "error", "msg" : "get last call failed"}"

• "type" wrong format

"{"res" : "error", "msg" : "wrong type format"}"

removeCall(id, flag, callbackFuntion)

Description

Remove call log

Parameters

• flag: Remove type. 1 - remove all the logs in answered

calls,

dialed calls or missed calls; 2 - remove one call

• id: Call log identifier

flag=1, id=0 - remove all answered call log

flag=1, id=1 - remove all dialed call log

flag=1, id=2 - remove all missed call log

flag=0, id is the log ID - remove the log with id =ID

• callbackFunction: Call back function

Http Request

• URL: "http://"+ ip + "/manager?"

• action: "removeall"

GXV3240/3275 GMI Web Service v1.9 User Guide

Page 29 of 44

• ID: "1"

• flag: "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=removecall&ID=1&flag=1&f

ormat=json&jsoncallback=?

Return

1. HTTP request return:

• Remove successful

"{"res": "success"}"

• Remove failed

"{"res" : "error", "msg" : "remove call failed"}"

• Parameters in wrong format (GMI version 9 or newer)

2. "{"res" : "error", "msg" : "wrong format"}"

saveCallHistory(callbackFunction)

Description

Save callhistory.xml

Parameters

callbackFunction: Call back function

Http Request

• URL: "http://"+ ip + "/manager?"

• action: "savecallhistory"

• 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=savecallhistory&format=jso

n&jsoncallback=?

Return

HTTP request return:

• Save successful

"{"res": "success"}"

Note

After HTTP request returns saving successful, users could download

callhistory.xml to the phone with the following link:

http://192.168.121.230/callhistory/callhistory.xml

GXV3240/3275 GMI Web Service v1.9 User Guide

Page 30 of 44

setUpgrade(upgradeConf, reboot, callbackFunction)

Description

• Set up upgrading configuration

•

Configuration item structure. Each configuration item contains

two fields with the following format:

ConfItem

{

value; //P value

key; //nvram address (P parameter)

}

• The ConfItem list is as follows:

UpgradeConf

{

ConfItem updaterule

ConfItem updatevia

ConfItem firpath

ConfItem confpath

ConfItem firpre

ConfItem firpost

ConfItem confpre

ConfItem confpost

ConfItem dhcp66

ConfItem autoup

ConfItem keypadup

ConfItem authconffile

ConfItem hourofday

ConfItem dayofweek

ConfItem peroid

ConfItem xmlpass

ConfItem httpuser

ConfItem httppass

}

Parameters

• UpgradeConf: Upgrade configuration

• Reboot: 0 - Save configuration without reboot; 1 - Yes, reboot

• callbackFunction: Call back function

Structure Parameter

Settings

Configuration Name

Value

Configuration

nvram

Address

(key)

GXV3240/3275 GMI Web Service v1.9 User Guide

Page 31 of 44

Updaterule: Firmware

Upgrade and Provisioning

0------Always

Check at bootup

1------When F/W

pre/suffix

2------Skip the

Firmware Check

238

Updatevia: Upgrade Via 0------TFTP

1------HTTP

2------HTTPS

212

Firpath: Firmware Server

Path

192

Confpath: Config Server Path

237

Firpre: Firmware File Prefix

232

Firpost: Firmware File Postfix

233

Confpre: Config File Prefix

234

Confpost: Config File Postfix

235

dhcp66: DHCP Option 66

Override Server

0------No

1------Yes

145

Autoup: Automatic Upgrade 0------No

1------Check

Every Day

2------Check

Every Week

3------Check at

a Period Time

194

Keypadup: Auto Reboot to

Upgrade Without Prompt

0------No

1------Yes

88

Authconffile: Authenticate

Config File

0------No

1------Yes

240

Hourofday: Hour

285

Dayofweek: Day

286

Period: Automatic Upgrade

193

GXV3240/3275 GMI Web Service v1.9 User Guide

Page 32 of 44

Check Interval (min)

Xmlpass: XML Configuration

file Password

1359

Httpuser: Http/Https

Username

1360

Httppass: Http/Https

Password

1361

Http Request

1. Save configuration

• URL: http://" + ip +"/manager?"

• action: "put"

• var-0000: 238 //Key. P238 is for automatic upgrade

val-0000: 0 //P238 Value

var-0001: 212 //Key. P212 is for upgrade method

val-0001: 1 //P212 value

....

var-xxxx

val-xxxx

• 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=put&var-0000=238&val-

0000=0&var-0001=212&val-0001=1&format=json&jsoncallback=

?

2. Upgrade

• URL: http://" + ip +"/manager?"

• action: "upgrade"

• var-0000: 238 //Key. P238 is for automatic upgrade

val-0000: 0 //P238 Value

var-0001: 212 //Key. P212 is for upgrade method

val-0001: 1 //P212 value

....

var-xxxx

val-xxxx

• 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=upgrade&var-0000=238&val

GXV3240/3275 GMI Web Service v1.9 User Guide

Page 33 of 44

-0000=0&var-0001=212&val-0001=1&format=json&jsoncallback=?

Return

1. HTTP request return:

• Upgrade setup successful

"{"res": "success", "flag":"1"}"

• Upgrade setup failed

"{"res": "error", "msg":"phone rebooting"}"

2.

callbackFunction(data) will process the data returned from HTTP

request

setParameter(confItem[ ], callbackFuntion)

Description

•

Phone's configuration (set up video, call and other parameters)

•

Configuration item structure. Each configuration item contains two

fields with the following format:

ConfItem

{

value; //P value

key; //nvram address (P parameter)

}

Parameters

•

ConfItem: Phone's configuration (array)

•

callbackFunction: Call back function

Http Request

•

URL: http://" + ip +"/manager?"

•

action: "put"

•

var-0000: val1 //Key

val-0000: var1 //Value

var-0001: val2 //Key

val-0001: var2 //Value

....

var-xxxx

val-xxxx

•

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/manage

r?action=put&var-0000=7044&val-0000

=0&var

-0001=904&val-0001=15&format=json&jsoncallback=?

Return

1. HTTP request return:

•

Configure successful

"{"res": "success", "flag":"1"}"

•

Configure failed

GXV3240/3275 GMI Web Service v1.9 User Guide

Page 34 of 44

"{"res": "error", "msg":"phone rebooting"}"

2.

callbackFunction

(data) will process the data returned from HTTP

request

getParameter(confItem[ ], callbackFuntion)

Description

1. HTTP request return:

• Configure successful

"{"res": "success", "flag":"1"}"

• Configure failed

"{"res": "error", "msg":"phone rebooting"}"

2. c

allbackFunction(data) will process the data returned from HTTP

request

Parameters

• ConfItem: Phone's configuration (array)

• callbackFunction: Call back function

Http Request

• URL: http://" + ip +"/manager?"

• action: "get"

• var-0000: val1 //Key

var-0001: val2 //Key

....

var-xxxx

• 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=get&var-0000=7044&var-00

01=904&format=json&jsoncallback=?

Return

1. HTTP request return:

• Successful

"{"res": "success", "7044":"1", "904":"15"}"

• Failed

"{"res": "error", "msg":"new memory failed or no value"}"

2. callbackFunction(data) will process the data returned from HTTP

request

launchService(name, arg, callbackFunction)

Description

•

Open an application.

• GXV32xx/GXP2200 applications: Blue Background

GXV3240/3275 GMI Web Service v1.9 User Guide

Page 35 of 44

•

GXV3175 applications: Green Background

•

All models applications: Red Background

Applications List

Name

Description

phonebook

Contacts

BLF

Busy lamp filed

BunnyHunt

Game

Calculator

Calendar

CallHistory

Call History

colorcode

Game

Facebook

FindPair

Game

Flickr

gottet

Game

peg

Game

Simsu

Game

Message

Browser

AlarmClock

Alarm Clock

Buzzy

Game

FileManager

File Manager

Gobang

Game

GoogleVoice

Google Voice

InternetRadio

Internet Radio

IP2Location

Check IP Address Location

LastMF

Last.FM

MediaPlay

Media Player

MovieTrailer

Movie Trailer

NewsVideos

News Video

Phanfare

Photobucket

PIP

Camera

Qchecker

Game

SlideShowApp

Slides show

Solitaire

Game

SystemInfo

System Information

GXV3240/3275 GMI Web Service v1.9 User Guide

Page 36 of 44

SystemSetting

System Settings

Tudou

Video Website

Twitter

Youtube

SetupGuide

Setup Guide

Message

Video

Video Player

Audio

Audio Player

Parameters

•

name: Application name (case insensitive)

•

args: Input parameters

• callbackFunction: Call back function

Http Request

•

URL: http://" + ip +"/manager?"

•

action: "launchservice"

•

name: name

•

args: http://192.168.121.29/a.html

•

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=launchservice&name=Browser

&arg=http://192.168.121.29/a.

html&format=json&jsoncallback=?

Return

1. HTTP request return:

•

Launch successful

"{"res": "success"}"

•

Server cannot get data. Open failed

"{"res": "error", "msg" : "open application failed"}" //dbus returns

null

•

"name" is empty

"{"res" : "error", "msg": "name is empty" }"

•

Run application failed

"{"res" : "error", "msg": "run application failed" }"

2. callbackFunction(data) will process the data returned from HTTP

request

GXV3240/3275 GMI Web Service v1.9 User Guide

Page 37 of 44

closeService(name, callbackFunction)

Description

Close an application (GMI 8）

Parameters

• name —— application name (2.34-Application List)

• callbackFunction: Call back function

Http Request

• URL: "http://" + ip +"/manager?"

• Action: "closeservice"

• Name: name

• 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=closeservice&name=BLF

&format=json& jsoncallback=?"

Return

1. HTTP request return:

• Close successful：

"{"res": "success"}"

• Failed：

"{"res": "error", "msg" : "close application failed"}"

• name is empty

"{"res" : "error", "msg": "name is empty" }"

2.

callbackFunction(data) will process the data returned from HTTP

request

grabWindow(path, callbackFuntion)

Description

Screenshots, and save the screenshots to specific directory (GMI 8)

Parameters

• path ------ Save Path (Path and File Name)

• callbackFunction: Call back function

Http Request

• URL: "http://" + ip +"/manager?"

• Action: "grabwindow"

• Path: path

• 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=grabwindow&

path=/pro/pic&time=10&format=json& jsoncallback=?"

GXV3240/3275 GMI Web Service v1.9 User Guide

Page 38 of 44

Return

1. HTTP request return:

• "{"res": "success"}"

• "{"res": "error", "msg" : "save grab failed"}" //dbus return empty

• "{"res" : "error", "msg": "path is empty" }" //path is empty

• "{"res" : "error", "msg": "filename is empty" }"

• "{"res" : "error", "msg": "save pictrue failed" }" //Save failed

•

"{"res" : "error", "msg": "wrong extension" }" //Postfix is

wrong

• "{"res" : "error", "msg": "lost the extension" }" //No postfix

2. callbackFunction(data) will process the data returned from HTTP

request

touchScreen(x, y, msec, callbackFunction)

Description

Simulate to tap on touch screen (GMI 10)

Parameters

• x ------ abscissa value

• y ------ ordinate values

• msec ------ ms duration

• callbackFunction: Call back function

Http Request

• URL: "http://" + ip +"/manager?"

• Action: "touchscreen"

• px” x

• py: y

• msec: 3000

• 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=touchscreen&px=100&py=200

&msec=3000&format=json& jsoncallback=?"

Return

1. HTTP request return:

• "{"res" : "success"}"

• "{"res" : "error", "msg": "the point out of screen" }"

2. callbackFunction(data) will process t

he data returned from HTTP

request

GXV3240/3275 GMI Web Service v1.9 User Guide

Page 39 of 44

getGMIVersion

Description

Get phone's GMI version number

Parameters

N/A

Http Request

• URL: http://" + ip +"/manager?"

• action: "gmiVersion"

• For example:

http://192.168.121.230/manager?action=gmiVersion

Return

GMI Vers

ion number. For example, 6. The version number increases by

1 on each new GMI version.

getPhoneStatus

Description

Get phone's process status (GMI version 6 or newer)

Parameters

funcname: Process name

Http Request

• URL: http://" + ip +"/manager?"

• action: "phoneStatus"

• funcname: process name

• 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=phoneStatus&funcname=gs_g

ui

http://192.168.121.230/manager?action=phoneStatus&funcname=gs_g

ui&format=json&jsoncallback=?

Return

•

If the return data is retrieved in json format and there is jsoncallback,

the return data is as follows:

jsoncallback(S)

where jsoncallback is the callback function name

• O

therwise, the process status will be returned directly, for example,

S. The status are listed as below:

R: running

S: sleeping in an interruptible wait

D: waiting in uninterruptible disk sleep

Z: zombie

T: traced or stopped (on a signal)

W: paging

GXV3240/3275 GMI Web Service v1.9 User Guide

Page 40 of 44

Unknown: unknown status or cannot get status return data

getPhoneMem

Description

Get phone's memory status (GMI version 6 to 8)

Parameters

funcname: Process name

Http Request

• URL: http://" + ip +"/manager?"

• action: "phoneMem"

• funcname: process name

• 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=phoneStatus&funcname=gs_g

ui

http://192.168.121.230/manager?action=phoneStatus&funcname=gs_p

hone&format=json&jsoncallback=?

Return

•

If the return data is retrieved in json format and there is jsoncallback,

the return data is as follows:

jsoncallback(S)

where jsoncallback is the callback function name

• Otherwise, the physical memory of the process wi

ll be returned. For

example, 3176 kB

•

If the process memory is unknown or cannot get memory,

"Unknown" will be returned.

getcStatus

Description

Get phone's line status (GMI version 8 or newer)

Parameters

line: Line index number. From 0 to 2 for line 1 to line 3

Http Request

• URL: http://" + ip +"/manager?"

• action: "lineStatus"

• 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=lineStatus&line=0

Return

1. If the return data is retrieved in json format and there is jsoncallback,

GXV3240/3275 GMI Web Service v1.9 User Guide

Page 41 of 44

the return data is as follows:

jsoncallback(S)

where jsoncallback is the callback function name

2. Otherwise, the line status value will be returned.

• -1: Retrieve line status failed

• 0: CALL_IDLE. The line is in idle and users can make calls

• 1: CALL_DIALING. Dialing

• 2: CALL_RINGING. Ringing

• 3: CALL_CALLING. Calling

• 4: CALL_CONNECTED. Connected

• 5: CALL_ONHOLD. Call on hold

• 6: CALL_TRANSFERED. Call is already transferred

• 7: CALL_ENDING. Call is being ended

• 8: CALL_FAILED. Call cannot be established

• 9: CALL_TRANSFER. Call is being transferred

• 10: CALL_CONFERENCE. In conference

• 11: CALL_PAGING

• 12: CALL_RINGBACK. Ringback

• 13: CALL_IPCALL. Direct IP Call

3. Other return data

• "line" cannot be empty

{"res": "error", "msg": "line can't be null"}

• "line" value is not valid

{"res": "error", "msg": "line invalid"}

• Cannot get line status

{"res": "error", "msg": "can't get line status"}

EndCall

Description

Stop current call (GMI 8 and later)

Parameters

N/A

Http Request

• URL: "http://" + ip +"/manager?"

• Action: "endcall"

•

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=endcall

Return

Get via json with jsoncallback, the results should be：

jsoncallback(S), jsoncallback are callback Function names.

GXV3240/3275 GMI Web Service v1.9 User Guide

Page 42 of 44

Return 0, normally it is not needed to return this value.

getMinPlugins

Description

Get a list of phone minimization program (GMI 6 to 8)

Parameters

N/A

Http Request

• URL: "http://" + ip +"/manager?"

• action: "phoneMem"

•

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=minPlugins

Return

Get via json with jsoncallback, the results should be：

jsoncallback(S), jsoncallback are callback Function names.

Return values are json type strings，list below：

{"res" : "success", "msg": "SetupGuide,SystemSetting"}

Minimized applications have setup wizard and system settings.

swipScreen(start_x, start_y, end_x,end_y, callbackFunction)

Description

Slide the screen (GMI 9)

Parameters

• start_x ------ Initial abscissa value

• start_y ------ Initial ordinate value

• end_x ------ End abscissa value

• end_y ------ End ordinate value

• callbackFunction: Call back function

Http Request

• URL: "http://" + ip +"/manager?"

• Action: "swipescreen"

• start_x: start_x

• start_y: start_y

• end_x: end_x

• start_y: start_y

• 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=swipescreen&start_x=400&

start_y=200&end_x=0&end_y=0&format=json& jsoncallback=?"

GXV3240/3275 GMI Web Service v1.9 User Guide

Page 43 of 44

Return

HTTP request return:

• "{"res" : "success"}"

• "{"res" : "error", "msg": "the

point out of screen" }"

callbackFunction(data) will process the data returned from

HTTP request

GXV3240/3275 GMI Web Service v1.9 User Guide

Page 44 of 44

GMI SERVICE EXAMPLE

USING JAVASCRIPT

Add the following code in the file webservice.html.

function showLogin(data)

{

if(data.res == "success")

{

$("#connectresult").html("<font color='red'>Connect success</font>");

}

function login()

{

ip = $("#ip").val();

username = $("#username").val();

password = $("#password").val();

webService.webServiceLogin(ip, username, password, showLogin);

}

</script>

…...

Phone IP: <input id="ip" value="Input Phone IP here">

UserName: <input id="username" value="admin">

Password: <input id="password" value="admin">

<button onclick="login()">Connect</button>

</div>

<br>

<h4>2. Connect info</h4>

not connected

</div>

….......