Difference between revisions of "MOR API phonebooks get"
From Kolmisoft Wiki
Jump to navigationJump to search
m (moved MOR API phonebooks api to MOR API phonebooks get) |
|
(No difference)
|
Revision as of 10:33, 25 May 2013
Description
MOR API Phonebooks list
Usage
- Call: /api/phonebooks_get
- For Backwards-compatibility old name 'phonebooks' is also usable. Call: /api/phonebooks
- Methods: POST, GET(if allowed, not recomended)
Parametres
- user_id - User ID in MOR database, whose phonebooks we want to see. Required.
- u - username for authentication. Required.
- hash - SHA1 hash constructed using user_id and API_Secret_Key ( More described in Constructing hash). Required.
Request
We have user_id = 123, API Secret Key = 456789
We send:
HTML POST: http://<SERVER_IP>/billing/api/phonebooks?u=username&user_id=123&hash=f7c3bc1d808e04732adf679965ccc34ca7ae3441
NOTE that username and password are not included in hash
Returns
Success
<?xml version="1.0" encoding="UTF-8"?> <page> <phonebooks> <phonebook> <name>record name</name> <number>number</number> <speeddial>speeddial number</speeddial> </phonebook> <phonebook> <name>second record name</name> <number>second number</number> <speeddial>second speeddial number</speeddial> </phonebook> </phonebooks> </page>
Errors
- <error>No Phonebooks</error> - User does not have phonebooks.
- <error>User was not found</error> - User was not found using user_id. Use correct user id.
- <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.