MOR API Quickforwards get

Description

Retrieves owner's list of Quickforward DIDs.

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

Usage

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

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).

Request

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

Example:

If you want find username = admin Quickforward DIDs list

You send:

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

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>

NOTE that calldate is in system(server) Time Zone.

Errors:

• <error>API Requests are disabled</error> – Allow API globally setting is unchecked.
• <error>Access Denied</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.

Example:

 <status>
   <error>API Requests are disabled</error>
 </status>

See also

• MOR API