Difference between revisions of "MOR API phonebook edit"
From Kolmisoft Wiki
Jump to navigationJump to search
| Line 1: | Line 1: | ||
=Description= | |||
<!---This functionality is available from MOR 11---> | <!---This functionality is available from MOR 11---> | ||
[[MOR API]] Phonebook edit | [[MOR API]] Phonebook edit | ||
<br><br> | <br><br> | ||
=Usage= | |||
* Call: /api/phonebook_edit | * Call: /api/phonebook_edit | ||
* Methods: POST, GET(if allowed, not recomended) | * Methods: POST, GET(if allowed, not recomended) | ||
<br><br> | |||
===Parametres=== | |||
* phonebook_id - Phonebook ID in MOR database. '''Required'''. | |||
* u - username for authentication. '''Required'''. | |||
* [[MOR API hash construction | hash]] - SHA1 hash constructed using '''params''' and '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''. | |||
** name | * number | ||
* name | |||
* speeddial | |||
<br><br> | |||
===Request=== | |||
We have phonebook_id = 123, name=phonebook, number=920355666, speeddial=666 and API Secret Key = 456789 | |||
We send: | |||
HTML POST: http://<SERVER_IP>/billing/api/phonebook_edit?u=username&phonebook_id=123&name=phonebook&number=920355666&speeddial=666&hash=fe2532c8b6b0a04fa8610bb666614a821f269b85 | |||
'''NOTE that username and password are not included in hash''' | |||
<br><br> | |||
===Returns=== | |||
'''Success''' | |||
<?xml version="1.0" encoding="UTF-8"?> | |||
<page> | |||
<status>Phonebook saved</status> | |||
</page> | |||
<br><br> | <br><br> | ||
---- | ---- | ||
* | '''Errors''' | ||
** | |||
* | * <error>Phonebook was not saved</error> | ||
* | ** <message>problem message</message> | ||
* <error>Phonebook was not found</error> - Phonebook was not found using phonebook_id. Use correct phonebook id. | |||
* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string. | |||
* <error>Access Denied</error> - User with UNIQUEHASH not found or params id not send. Enter correct id. | |||
<br><br> | |||
=See also= | |||
* [[MOR API]] | |||
Revision as of 10:44, 25 May 2013
Description
MOR API Phonebook edit
Usage
- Call: /api/phonebook_edit
- Methods: POST, GET(if allowed, not recomended)
Parametres
- phonebook_id - Phonebook ID in MOR database. Required.
- u - username for authentication. Required.
- hash - SHA1 hash constructed using params and API_Secret_Key ( More described in Constructing hash). Required.
- number
- name
- speeddial
Request
We have phonebook_id = 123, name=phonebook, number=920355666, speeddial=666 and API Secret Key = 456789
We send:
HTML POST: http://<SERVER_IP>/billing/api/phonebook_edit?u=username&phonebook_id=123&name=phonebook&number=920355666&speeddial=666&hash=fe2532c8b6b0a04fa8610bb666614a821f269b85
NOTE that username and password are not included in hash
Returns
Success
<?xml version="1.0" encoding="UTF-8"?> <page> <status>Phonebook saved</status> </page>
Errors
- <error>Phonebook was not saved</error>
- <message>problem message</message>
- <error>Phonebook was not found</error> - Phonebook was not found using phonebook_id. Use correct phonebook id.
- <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
- <error>Access Denied</error> - User with UNIQUEHASH not found or params id not send. Enter correct id.
