MOR API quickstats get

From Kolmisoft Wiki

Jump to: navigation, search


[edit] Description

Retrieves today's Quick Stats and Active Calls count

Data can be retrieved for Admin, Reseller, Simple User

[edit] Usage

  • Call: /api/quickstats_get (from MOR X7)
  • Methods: POST, GET (if allowed, not recomended)

[edit] Parameters

Parameters which are included into hash:

  • u - username for authentication. Required.

Note that u is included in to the HASH only if u is not an Admin

[edit] Request

If API Secret Key = secret

You send:

HTML POST: http://<SERVER_IP>/billing/api/quickstats_get?u=admin&hash=e5e9fa1ba31ecd1ae84f75caaa474f3a663f05f4

[edit] Returns

Success: Everything is ok. You get the list of calls if there are any:

<?xml version="1.0" encoding="UTF-8"?>
     <calls> Calls count </calls>
     <duration> Billsec in seconds </duration>
     <revenue> Revenue today</revenue>
     <self_cost> Expenditure today</self_cost>
     <profit> Difference of revenue and expences</profit>
     <margin> profit's part in the sell price</margin>
     <total> Active Calls count </total>
     <answered_calls> Answered Calls count </answered_calls>


  • <error>API Requests are disabled</error> – Allow API globally setting is unchecked
  • <error>GET Requests are disabled</error> – Allow GET API setting is unchecked
  • <error>Access Denied</error> – User with such a username cannot use this method or such a 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 of parameters while concatenating the hash_string
  • <error>Cannot connect to Elasticsearch</error> – data is not reachable


   <error>API Requests are disabled</error>

[edit] See also

Personal tools


Try M2