M2 Balance in phone

From Kolmisoft Wiki

Jump to: navigation, search


[edit] Description

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

For example, we will use iaxLite. Download link

[edit] Configuration

1. Go to MAINTENANCE –> Settings

2. Under API SETTINGS check the marked option:
File:M2 balance api option.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.

[edit] Usage

Log in as the user you want to check your balance and go to Personal Details:


Copy and paste this link into the phone:


... and you will see your balance:


[edit] 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.)

[edit] API usage

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

[edit] Parameters

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

[edit] Request

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

[edit] Returns




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

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

[edit] See also

Personal tools


Try M2