MOR API user details get

From Kolmisoft Wiki

Jump to: navigation, search

Contents

[edit] Description

MOR API user details

Admin – can get any user details
Reseller – can get his and his users details.
User – can get his own details.


[edit] Usage

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



[edit] Parametres

Parameters which are included into hash:

  • user_id - Users ID in MOR database. Required if username is not used. Type: INTEGER
  • username - Users Username in MOR database. Required if user_id is not used.

You are able to use these parameter one by one or both at a time. If you use them both at a time 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 parameters which are listed above. You are able to use these parameter one by one or both at a time. If you use them both at a time 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 ( More described in Constructing hash). Required.
  • u - username for authentication. Required.

[edit] Request

We have user_id = 123, API Secret Key = 456789

We send:

HTML POST: http://<server_ip>/billing/api/user_details_get?u=username&user_id=123&hash=f7c3bc1d808e04732adf679965ccc34ca7ae3441


We have username = username, API Secret Key = 456789

We send:

HTML POST: http://<server_ip>/billing/api/user_details_get?u=username&username=username&hash=f7c3bc1d808e04732adf679965ccc34ca7ae3441


We have user_id = 123, username = username, API Secret Key = 456789

We send:

HTML POST: http://<server_ip>/billing/api/user_details_get?u=username&user_id=123&username=username&hash=f7c3bc1d808e04732adf679965ccc34ca7ae3441


* Note that username and password are not included in hash

[edit] Returns

Success

<page>
 <pagename>Personal_details</pagename>
 <language>en</language>
 <userid> user id </userid>
 <details>
   <main_detail>
     <account>Postpaid/Prepaid</account>
     <balance> balance and currency </balance>
     <balance_number> balance </balance_number> 
     <balance_currency> currency </balance_currency>
     <credit> credit </credit>
     <pbx_pool_id> id </pbx_pool_id>
     <hide_non_answered_calls> 0 - off/1 - on </hide_non_answered_calls>
   </main_detail>
   <other_details>
     <username> username </username>
     <first_name> first name </first_name>
     <surname> last name </surname>
     <personalid></personalid>
     <agreement_number> </agreement_number>
     <agreement_date> </agreement_date>
     <taxation_country> </taxation_country>
     <vat_reg_number> </vat_reg_number>
     <vat_percent> </vat_percent>
     <call_limit> </call_limit>
   </other_details>
   <registration>
     <reg_address></reg_address>
     <reg_postcode></reg_postcode>
     <reg_city></reg_city>
     <reg_country></reg_country>
     <reg_state></reg_state>
     <reg_direction></reg_direction>
     <reg_phone></reg_phone>
     <reg_mobile></reg_mobile>
     <reg_fax></reg_fax>
     <reg_email></reg_email>
   </registration>
   <invoices>
     <generate_invoices>1</generate_invoices>
     <invoice_xlsx>0</invoice_xlsx>
     <simplified_pdf>1</simplified_pdf>
     <simplified_csv>0</simplified_csv>
     <detailed_pdf>0</detailed_pdf>
     <detailed_csv>0</detailed_csv>
     <by_callerid_pdf>0</by_callerid_pdf>
     <by_callerid_csv>1</by_callerid_csv>
     <by_destinations>0</by_destinations>
     <calls>0</calls>
     <show_zero_calls>1</show_zero_calls>
   </invoices>
   <warning_balance>
     <active>1</active>
     <send_email_when_balance_drops_lower_than>
       <user>0.0</user>
       <admin>0.0</admin>
       <responsible_accountant>5.0</responsible_accountant>
     </send_email_when_balance_drops_lower_than>
     <warning_email_hour>0</warning_email_hour>
   </warning_balance>
 </details>
</page>




Errors

  • <error>User was not found</error> - User was not found using user_id and/or username. Use correct user_id and/or username.
  • <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.



[edit] See also

Personal tools

Try MOR

Try M2