MOR API Quickforwards get

From Kolmisoft Wiki

Jump to: navigation, search

Contents

[edit] Description

Retrieves owner's list of Quickforward DIDs.

Simple User - can get his list of Quickforward DIDs which he is able to use.

[edit] Usage

  • From MOR X4 call: /api/quickforwards_dids_get
  • Methods: POST, GET(if allowed, not recomended)



[edit] Parameters

  • u - username for authentication. Required.
  • hash - SHA1 hash constructed using params and API_Secret_Key ( More described in Constructing hash). Required (if setting Disable hash checking is not checked).



[edit] Request

HTML POST: http://<SERVER_IP>/billing/api/quickforwards_dids_get?u=USERNAME&hash=HASH

Example:

If you want find Quickforward DIDs list of username = test_user

You send:

http://127.0.0.1/billing/api/quickforwards_dids_get?u=test_user&hash=47fc73b6d374bd0a85e3984c1e1623451681569c



[edit] Returns

Success: Everything is ok. You get the list of Quickforward DIDs if there is any:

(for example)

<?xml version="1.0" encoding="UTF-8"?>
<page>
 <quick_forward_did>
   <did>37161112345</did>
   <forward_to></forward_to>
   <description></description>
 </quick_forward_did>
 <quick_forward_did>
   <did>37161112347</did>
   <forward_to></forward_to>
   <description></description>
 </quick_forward_did>
 <quick_forward_did>
   <did>37161112349</did>
   <forward_to></forward_to>
   <description></description>
 </quick_forward_did>
</page>

Errors:

  • <error>Quickforwards list is empty</error> – Quickforwards list is empty.
  • <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 user_id. Use correct user_id.

[edit] See also

Personal tools

Try MOR

Try M2