SMSEagle NPE-9300-GPRS/3G, User Manual

Page: 66 / 107

Page
66
25. Phonebook group read: HTTP GET method
HTTP GET METHOD:
https://url-of-smseagle/index.php/http_api/group_read
Parameter Description
login your user to login to SMSEagle
pass your password to login to SMSEagle
public (optional parameter) 0 = private group (default value), 1 = public group
uid (optional parameter) id of user who created the group
responsetype (optional parameter) text = format response as text (default), xml = format
response as XML object
EXAMPLES:
https://url-of-smseagle/index.php/http_api/group_read?
login=john&pass=doe&public=1&uid=12
RESPONSE:
Sample response: link
Response (when no data): No data to display
Response (when wrong logindata): Invalid login or password
Response (when wrong parameters):
Wrong or missing >>uid<< parameter
Wrong or missing >>public<< parameter
RESPONSE (XML):
Sample response:
<xml>
<groups>
<item>
<Name>private</Name>
<ID>2</ID>
<id_user>2</id_user>
<is_public>true</is_public>
</item>
<item>
<Name>Everyone</Name>
<ID>3</ID>
<id_user>1</id_user>
<is_public>true</is_public>
</item>
<item>
<Name>work</Name>
<ID>4</ID>
<id_user>1</id_user>
<is_public>true</is_public>