Difference between revisions of "Balance in phone"

From Kolmisoft Wiki
Jump to navigationJump to search
 
(13 intermediate revisions by 4 users not shown)
Line 1: Line 1:
=Description=
Some phones and softphones support displaying your account balance on their screens.
Some phones and softphones support displaying your account balance on their screens.


For example, we will use [http://iaxtalk.com/index.php?main_page=product_info&cPath=6&products_id=7  iaxLite]. [http://www.kolmisoft.com/packets/iaxlite_setup.zip Download link]
For example, we will use [http://iaxtalk.com/index.php?main_page=product_info&cPath=6&products_id=7  iaxLite]. [http://www.kolmisoft.com/packets/iaxlite_setup.zip Download link]


<br><br>


In '''SETTINGS –> Setup –> Settings –> API –> Allow devices to check balance over HTTP''', check to allow this functionality:
=Configuration=


1. Go to '''SETTINGS –> Setup –> Settings'''
<br><br>
[[File:settings_path.png]]
<br><br>
<!---This functionality is available from MOR 12--->
2. In API tab check the marked option:
<br><br>
[[File:Settings_various_balance_over_http.png]]
<br><br>


'''NOTE:''' do not forget to enable the '''API''' on your system before you will use Balance in the Phone. If API will be not enabled you will see ''Balance:<?xml...'' instead of the real Balance.
<br><br>
=Usage=


Log in as the user you want to check your balance:
Log in as the user you want to check your balance:
<br><br>
[[Image:bif2.png]]
<br><br>
... and in Details you will see the link:
<br><br>
[[Image:bif3.png]]
<br><br>
Copy and paste this link into the phone:
<br><br>
[[Image:bif4.png]]
<br><br>
... and you will see your balance:
<br><br>
[[Image:bif5.png]]
<br><br>
=Advanced options=
Optionaly you can send api request and specify currency, valid values are USER, in that case balance is returned in user's currency. And currency code(EUR, USD etc.)
<br><br>
===API usage===
* Call: '''/api/user_simple_balance_get'''
* For Backwards-compatibility old name 'simple_balance' is also usable. Call: '''/api/simple_balance'''
<br><br>
===Parametres===
* id – uniquehash of user whose balance you want to get. '''Required'''.
* currency – currency code. '''Optional'''. Without this parameter API request will return Balance in Default System Currency.
<br><br>


[[Image:bif2.png]]
===Request===


HTML POST: http://<SERVER_IP>/billing/api/user_simple_balance_get?id=UNIQUEHASH&currency={USER|CURRENCY_CODE}
<br><br>
===Returns===


... and in Details you will see the link:
'''Success'''


[[Image:bif3.png]]
<html>
    <head></head>
    <body>60.0000</body>
</html>
<br><br>
----
'''Errors'''


* Incorrect hash


Copy and paste this link into the phone:
<?xml version="1.0" encoding="UTF-8"?>
<status>
  <error>Incorrect hash</error>
</status>


[[Image:bif4.png]]
* '''Allow devices to check balance over HTTP''' is not set


<html>
    <head></head>
    <body>Feature disabled</body>
</html>


... and you will see your balance:
* Your API is disabled.


[[Image:bif5.png]]
<?xml version="1.0" encoding="UTF-8"?>
<status>
  <error>API Requests are disabled</error>
</status>


Optionaly you can send api request and specify currency, valid values are USER, in that case balance is returned in user's currency. And currency code(EUR, USD etc.)
Enable API in the MOR's SETTINGS under API section.
<br><br>
=See also=


HTML POST: http://<SERVER_IP>/billing/api/simple_balance?id=UNIQUEHASH&currency={USER|CURRENCY_CODE}
* [[MOR API]]
* [[MOR API user balance get]]

Latest revision as of 08:25, 29 January 2017

Description

Some phones and softphones support displaying your account balance on their screens.

For example, we will use iaxLite. Download link



Configuration

1. Go to SETTINGS –> Setup –> Settings

Settings path.png

2. In API tab check the marked option:

Settings various balance over http.png

NOTE: do not forget to enable the API on your system before you will use Balance in the Phone. If API will be not enabled you will see Balance:<?xml... instead of the real Balance.

Usage

Log in as the user you want to check your balance:

Bif2.png

... and in Details you will see the link:

Bif3.png

Copy and paste this link into the phone:

Bif4.png

... and you will see your balance:

Bif5.png

Advanced options

Optionaly you can send api request and specify currency, valid values are USER, in that case balance is returned in user's currency. And currency code(EUR, USD etc.)

API usage

  • Call: /api/user_simple_balance_get
  • For Backwards-compatibility old name 'simple_balance' is also usable. Call: /api/simple_balance



Parametres

  • id – uniquehash of user whose balance you want to get. Required.
  • currency – currency code. Optional. Without this parameter API request will return Balance in Default System Currency.



Request

HTML POST: http://<SERVER_IP>/billing/api/user_simple_balance_get?id=UNIQUEHASH&currency={USER|CURRENCY_CODE}



Returns

Success 

    
    60.0000



Errors

  • Incorrect hash
<?xml version="1.0" encoding="UTF-8"?>
<status>
 <error>Incorrect hash</error>
</status>
  • Allow devices to check balance over HTTP is not set
    
    Feature disabled
  • Your API is disabled.
<?xml version="1.0" encoding="UTF-8"?>
<status>
  <error>API Requests are disabled</error>
</status>

Enable API in the MOR's SETTINGS under API section.

See also

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