MOR API user details update

From Kolmisoft Wiki
Jump to navigationJump to search

Description

MOR API Update user from params.
If Admin has checked "Allow Resellers to use Admin Tariffs" in API Configuration, then, using this API, the Reseller can set Wholesale or Retail Tariffs for his Users that belong to Admin.

Please note that it is not necessary to send ALL user parameters - you can send only those you need to update.

Usage

  • From MOR X4 call: /api/user_details_update
  • For Backwards-compatibility old name 'user_update_api' is also usable. Call: /api/user_update_api
  • Methods: POST, GET(if allowed, not recomended)



Parameters

Parameters which are included into the hash (if it is used):

  • user_id - User's ID in the MOR database, whose details we want to change. REQUIRED.
  • u0 - vat number
  • u1 - lcr id
  • u2 - warning email hour
  • u3 - hide destination end
  • u4 - currency id
  • u5 - tariff id
  • u6 - warning email balance
  • u7 - spy device id
  • u8 - language
  • u9 - username
  • u10 - warning balance call [0-off, 1-on]
  • u11 - acc group id
  • u12 - generate invoice
  • u13 - usertype
  • u14 - taxation country (Direction id)
  • u15 - blocked
  • u16 - quickforwards rule id
  • u17 - last name
  • u18 - call limit
  • u19 - clientid (Company/Personal ID)
  • u20 - recording hdd quota
  • u21 - cyberplat active
  • u22 - recordings email
  • u23 - first name
  • u24 - warning balance sound file id
  • u25 - postpaid
  • u26 - accounting number
  • u27 - agreement number
  • u28 - hidden
  • ay - agr_date year
  • am - agr_date month
  • ad - agr_date day
  • by - block at date year2011
  • bm - block at date month
  • bd - block at date day
  • pswd - password
  • user_warning_email_hour
  • pgui - privacy gui [0-off, 1-on]
  • pcsv - privacy csv [0-off, 1-on]
  • ppdf - privacy pdf [0-off, 1-on]
  • recording_forced_enabled - [0-off, 1-on]
  • i4 - invoice detailed csv [0-off, 16-on]
  • tax4_enabled - [0-off, 1-on]
  • tax2_enabled - [0-off, 1-on]
  • accountant_type_invalid
  • block_at_conditional - 15
  • tax3_enabled - [0-off, 1-on]
  • accountant_type
  • tax1_value - float
  • show_zero_calls - [0-off, 1-on]
  • warning_email_active - [0-off, 1-on]
  • compound_tax - [0-off, 1-on]
  • tax4_name -
  • allow_loss_calls - [0-off, 1-on]
  • tax3_name -
  • tax2_name -
  • credit - float
  • tax1_name -
  • total_tax_name -
  • tax2_value - float
  • tax4_value - float
  • i1 - invoice pdf [0-off, 2-on]
  • tax3_value - float
  • cyberplat_active - [0-off, 1-on]
  • i2 - invoice csv [0-off, 4-on]
  • i3 - invoice detailed pdf [0-off, 8-on]
  • recording_enabled - [0-off, 1-on]
  • email_warning_sent_test - [0-off, 1-on]
  • own_providers - [0-off, 1-on]
  • a0 - address
  • a1 - city
  • a2 - postcode
  • a3 - county
  • a4 - mob_phone
  • a5 - fax
  • a6 - Country, direction id (Direction id)
  • a7 - phone
  • a8 - email
  • a9 - state
  • company_name

Note that parameters are shown in the same order as they have to be when generating the hash. Last parameter in a row is API_Secret_Key

Parameters which are not included into hash:

  • hash - SHA1 hash constructed using params and API_Secret_Key ( More described in Constructing hash). REQUIRED.
  • u - username of the user who can modify details (admin, reseller, or accountant). REQUIRED.
  • u29 - pbx pool id
  • u30 - hide non-answered calls
  • u31 - responsible accountant ID (use -1 in order to unassign the responsible accountant).
  • u32 - daily balance limit; 0 or less means unlimited.
  • u33 - comment
  • ignore_global_monitorings - [0-off, 1-on]
  • time_zone - time zone (all available references are listed on the Time Zone list in the time zone name column. See more: http://wiki.kolmisoft.com/index.php/Time_Zone_list)
  • allow_change_callerid - [0-off, 1-on]
  • enable_static_source_list - Blacklist / Whitelist options, Enable Static Source ["no" - No, "blacklist" - Blacklist, "whitelist" - Whitelist]
  • static_source_list_id - Blacklist / Whitelist options, Enable Static Source - Number Pool [Number Pool ID]
  • enable_static_list - Blacklist / Whitelist options, Enable Static Destination ["no" - No, "blacklist" - Blacklist, "whitelist" - Whitelist]
  • static_list_id - Blacklist / Whitelist options, Enable Static Destination - Number Pool [Number Pool ID]
  • credit_unlimited - if set to 1, the user's credit will be set to unlimited
  • two_fa_enabled - enables the 2FA option to the user (1 - enables, 0 - disables). Only works if 2FA is enabled in system settings. The user must have an email entered in their settings.
  • max_devices - <Optional. Integer ≥ 0. Sets the Maximum devices cap on a Reseller user. 0 = unlimited. Only administrators and accountants may change this field; a Reseller calling the API for their own account receives an access error.



Additional feature

If the API setting Allow Resellers to use Admin Quick Forward Rules is enabled: < br> Resellers are able to set Quick Forward Rules inherited from Admin. u16 should be used as a parameter for Quick Forward Rules.
If the API setting Allow Resellers to use Admin Tariffs is enabled:
Reseller is able to set a tariff inherited from Admin. u5 should be used as a parameter for Tariff.

Reguest

We have user_id = 123, API Secret Key = 456789, u15=1 (we want to block user)

We send: 

HTML POST: http://<server_ip>/billing/api/user_details_update?u=username&user_id=123&u15=1&hash=0ab3ede4e93a55c38855a2cc9b9e169d35442c48

* Note that username and password are not included in the hash

Other examples: 

HTML POST: http://<server_ip>/billing/api/user_update_api?u15=1&user_id=789&u=admin&u15=1&hash=0in2w8n01rwnodv4t0y5zzfp1h5hdp1fyk7z

This request blocks (u15=1) user with ID 789 (user_id=789). User belongs to admin (u=admin). 


HTML POST: http://<server_ip>/billing/api/user_update_api?u16=3&user_id=789&u=admin&u15=1&hash=0in2w8n01rwnodv4t0y5zzfp1h5hdp1fyk7z

This request changes the user quickforwards rule to rule with ID 3 (u16=3) for the user with ID 789 (user_id=789). User belongs to admin (u=admin).

Returns

Success 

<page>
  <status>User was updated</status>
 </page>



Errors

  • <error>User was not found</error> - User was not found using user_id. Use the correct user 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> - Check params and permissions.
  • <error>You have no editing permission</error> - Accountant dont have permission.
  • <error>Tariff not found</error> - Tariff was not found using param u5.
  • <error>User was not updated</error>
  • <error>Responsible accountant is not valid</error> Responsible accountant id was not correct using param u31.
  • <message>problem message</message>





See also

Retrieved from "https://wiki.kolmisoft.com/index.php?title=MOR_API_user_details_update&oldid=31601"