Grandstream GXV3275 GMI Web Service Guide - Manual (Page 5)

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