Difference between revisions of "MOR API Quickforwards update"
From Kolmisoft Wiki
Jump to navigationJump to search
| (7 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
= NOTE: Available from MOR X5 = | |||
=Description= | =Description= | ||
[[MOR API]] Quickforward DID edit.<br><br> | [[MOR API]] Quickforward DID edit.<br><br> | ||
| Line 6: | Line 10: | ||
=Usage= | =Usage= | ||
* From '''MOR | * From '''MOR X5''' call: '''api/quickforwards_did_update''' | ||
* Methods: POST, GET(if allowed, not recomended) | * Methods: POST, GET(if allowed, not recomended) | ||
<br><br> | <br><br> | ||
| Line 19: | Line 23: | ||
===Request=== | ===Request=== | ||
HTML POST: http:// | HTML POST: http://192.168.0.40/billing/api/quickforwards_did_update?u=USERNAME&did=DID&forward_to=NUMBER&description=DESCRIPTION&hash=HASH | ||
Example: | Example: | ||
We have ''username = admin'', ''did=37060503666'', ''forward_to=37066603777'', ''description=abyss'' and ''API Secret Key = | We have ''username = admin'', ''did=37060503666'', ''forward_to=37066603777'', ''description=abyss'' and ''API Secret Key = 123456'' | ||
You send: | You send: | ||
http://127.0.0.1/billing/api/ | http://127.0.0.1/billing/api/quickforwards_did_update?u=admin&did=37060503666&forward_to=37066603777&description=abyss&hash=b12dbb15d59356af0fd75dc413ebd07a5b852d15 | ||
'''NOTE that username and password are not included in hash''' | '''NOTE that username and password are not included in hash''' | ||
| Line 38: | Line 42: | ||
''(example)'' | ''(example)'' | ||
<?xml version="1.0" encoding="UTF-8"?> | <?xml version="1.0" encoding="UTF-8"?> | ||
<page> | <page> | ||
<new_quickforward_did> | <new_quickforward_did> | ||
<did>37060503666</did> | <did>37060503666</did> | ||
| Line 45: | Line 49: | ||
<description>abyss</description> | <description>abyss</description> | ||
</new_quickforward_did> | </new_quickforward_did> | ||
</page> | </page> | ||
| Line 53: | Line 57: | ||
* <error>You are not authorized to use Quickforwards</error> – Such username does not exist in the database or it was not specified. | * <error>You are not authorized to use Quickforwards</error> – Such username does not exist in the database or it was not specified. | ||
* <error>Incorrect hash</error> – Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string. | * <error>Incorrect hash</error> – Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string. | ||
* <error>User was not found</error> – User was not found using | * <error>User was not found</error> – User was not found using username. Use correct username. | ||
=See also= | =See also= | ||
* [[MOR API]] | * [[MOR API]] | ||
Latest revision as of 07:36, 22 December 2014
NOTE: Available from MOR X5
Description
MOR API Quickforward DID edit.
User - can edit his Quickforward DID which he is able to use.
Usage
- From MOR X5 call: api/quickforwards_did_update
- Methods: POST, GET(if allowed, not recomended)
Parameters
- u - username for authentication. Required.
- did - DID number which will be edited. Required.
- forward_to - did, admin assigned you, will be forwarded to forward_to number.
- description - new description.
- hash - SHA1 hash constructed using params and API_Secret_Key ( More described in Constructing hash). Required (if setting Disable hash checking is not checked).
Request
HTML POST: http://192.168.0.40/billing/api/quickforwards_did_update?u=USERNAME&did=DID&forward_to=NUMBER&description=DESCRIPTION&hash=HASH
Example:
We have username = admin, did=37060503666, forward_to=37066603777, description=abyss and API Secret Key = 123456
You send:
http://127.0.0.1/billing/api/quickforwards_did_update?u=admin&did=37060503666&forward_to=37066603777&description=abyss&hash=b12dbb15d59356af0fd75dc413ebd07a5b852d15
NOTE that username and password are not included in hash
Returns
Success:
(example)
<?xml version="1.0" encoding="UTF-8"?> <page> <new_quickforward_did> <did>37060503666</did> <forward_to>37066603777</forward_to> <description>abyss</description> </new_quickforward_did> </page>
Errors:
- <error>DID was not found</error> – Specified DID was not found.
- <error>You are not authorized to use Quickforwards</error> – Such username does not exist in the database or it was not specified.
- <error>Incorrect hash</error> – Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
- <error>User was not found</error> – User was not found using username. Use correct username.
