Difference between revisions of "M4 API"
From Kolmisoft Wiki
Jump to navigationJump to search
| (9 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
[[File:api.png|right|alt="api"|link=]] | [[File:api.png|right|alt="api"|link=]] | ||
<mkmeta>Application Program Interface for | <mkmeta>Application Program Interface for M2 Class 4 Softswitch</mkmeta> | ||
<br><br> | <br><br> | ||
=About= | =About= | ||
M2 API lets other software interact with M2 without knowing the internal structure of the database (DB) and other logic. | |||
M2 accepts requests by HTML POST and returns results in XML. | |||
<br><br> | <br><br> | ||
= | =M2 users that are allowed to use M2 API= | ||
* Admin | * Admin | ||
* Manager - only by using Admin Hash and Secret key | * Manager - only by using Admin Hash and Secret key | ||
| Line 20: | Line 20: | ||
== API Related == | == API Related == | ||
* [[M2 API Configuration]] – configuration options for API. | * [[M2 API Configuration]] – configuration options for API. | ||
* [[ | * [[M2 API hash construction|Hash construction]] – how to construct hash to authenticate data over API. | ||
<br> | <br> | ||
| Line 26: | Line 26: | ||
* [[M2 API user balance update | user_balance_update]] (change_user_balance) – changes User's Balance | * [[M2 API user balance update | user_balance_update]] (change_user_balance) – changes User's Balance | ||
Various methods to retrieve User balance | Various methods to retrieve User balance | ||
* [[M2 API user_balance_get|user_balance_get]] (balance) – retrieves | * [[M2 API user_balance_get|user_balance_get]] (balance) – retrieves User's Balance. | ||
* [[M2 Balance in phone | user_simple_balance_get]] (simple_balance) – | * [[M2 Balance in phone | user_simple_balance_get]] (simple_balance) – retrieves User's Balance in plain text (without any tags). | ||
<br> | <br> | ||
==Calls== | ==Calls== | ||
* [[M2 user calls get|user_calls_get]] (user_calls) – retrieves a list of calls in a selected time period for a user/device. | * [[M2 user calls get|user_calls_get]] (user_calls) – retrieves a list of calls in a selected time period for a user/device. | ||
<br> | <br> | ||
==Currencies== | |||
* [[M2_API_Exchange_rate_update|exchange_rate_update]] - Currency Exchange rate update. | |||
<br> | |||
==Device== | ==Device== | ||
* [[M2 API devices get | devices_get]] (device_list) – users device list | * [[M2 API devices get | devices_get]] (device_list) – users device list | ||
* [[M2 API device details get | device_details_get]] – shows all information about specified device. | |||
<br> | |||
==Login== | ==Login== | ||
* [[M2 API user_login|user_login]] (login) – logs user in to MOR. | * [[M2 API user_login|user_login]] (login) – logs user in to MOR. | ||
* [[M2 API user_logout|user_logout]] (logout) – logs user out from MOR. | * [[M2 API user_logout|user_logout]] (logout) – logs user out from MOR. | ||
==Payments== | |||
* [[M2 API payment_create| payment_create]] (create_payment) – create payment. | |||
* [[M2 API payments_get| payments_get]] (payments_list) – payments list. | |||
<br> | <br> | ||
| Line 48: | Line 60: | ||
<br> | <br> | ||
==Statistics== | |||
* [[M2 API quickstats_get | quickstats_get]] – gets today's [[Quick Stats]] and [[Active Calls]] count | |||
* [[M2_API_aggregate_get | aggregates_get]] - get aggregated statistics | |||
<br> | |||
==User== | ==User== | ||
* [[M2 API user_details_get | user_details_get]] (user_details) – gets user details. | * [[M2 API user_details_get | user_details_get]] (user_details) – gets user details. | ||
<br> | <br> | ||
=HTML POST= | =HTML POST= | ||
All requests are in a similar format: | All requests are in a similar format: | ||
Revision as of 11:35, 6 November 2017
About
M2 API lets other software interact with M2 without knowing the internal structure of the database (DB) and other logic.
M2 accepts requests by HTML POST and returns results in XML.
M2 users that are allowed to use M2 API
- Admin
- Manager - only by using Admin Hash and Secret key
- Simple User
Functions
API Related
- M2 API Configuration – configuration options for API.
- Hash construction – how to construct hash to authenticate data over API.
Balance
- user_balance_update (change_user_balance) – changes User's Balance
Various methods to retrieve User balance
- user_balance_get (balance) – retrieves User's Balance.
- user_simple_balance_get (simple_balance) – retrieves User's Balance in plain text (without any tags).
Calls
- user_calls_get (user_calls) – retrieves a list of calls in a selected time period for a user/device.
Currencies
- exchange_rate_update - Currency Exchange rate update.
Device
- devices_get (device_list) – users device list
- device_details_get – shows all information about specified device.
Login
- user_login (login) – logs user in to MOR.
- user_logout (logout) – logs user out from MOR.
Payments
- payment_create (create_payment) – create payment.
- payments_get (payments_list) – payments list.
Rates
- tariff_rates_get (get_tariff) – get all tariff's rates
- tariff_wholesale_update (wholesale_tariff) – update or create wholesale tariff
Statistics
- quickstats_get – gets today's Quick Stats and Active Calls count
- aggregates_get - get aggregated statistics
User
- user_details_get (user_details) – gets user details.
HTML POST
All requests are in a similar format:
HTML POST: http://<SERVER_IP>/billing/api/<function>?u=username
- username - the user name and password of the user who is asking for the data.
If the user has 'admin' rights, he will get more results and can perform more actions compared to a user who does not have such rights.
Useful to know
- All API methods returns data straight from database. It means that MOR GUI settings does not affect data, it will be returned as it is saved in database. For example:
- Value of money will be returned in Default System Currency.
- Date will not be affected of Default date format setting.
- Value of money will not be affected of Number digits setting.
