Difference between revisions of "M4 API"

From Kolmisoft Wiki
Jump to navigationJump to search
Line 1: Line 1:
[[File:api.png|right|alt="api"|link=]]
[[File:api.png|right|alt="api"|link=]]
<mkmeta>Application Program Interface for M2 Class 4 Softswitch</mkmeta>
<mkmeta>Application Program Interface for M4 Class 4 Softswitch</mkmeta>


<br><br>
<br><br>
=About=
=About=
M4 API lets other software interact with M2 without knowing the internal structure of the database (DB) and other logic.
M4 API lets other software interact with M4 without knowing the internal structure of the database (DB) and other logic.


M4 accepts requests by HTML POST and returns results in XML.
M4 accepts requests by HTML POST and returns results in XML.
Line 26: Line 26:


==Balance==
==Balance==
* [[M2 API user balance update | user_balance_update]] (change_user_balance) – changes User's Balance
* [[M4 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 User's Balance.
* [[M4 API user_balance_get|user_balance_get]] (balance) – retrieves the User's Balance.
* [[M2 Balance in phone | user_simple_balance_get]] (simple_balance) – retrieves User's Balance in plain text (without any tags).
* [[M4 Balance in phone | user_simple_balance_get]] (simple_balance) – retrieves the 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.
* [[M4 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==
==Currencies==
* [[M2_API_Exchange_rate_update|exchange_rate_update]] - Currency Exchange rate update.
* [[M4_API_Exchange_rate_update|exchange_rate_update]] - Currency Exchange rate update.


<br>
<br>


==Device / Connection Point ==
==Device / Connection Point ==
* [[M2 API devices get | devices_get]] (device_list) – users device list
* [[M4 API devices get | devices_get]] (device_list) – users device list
* [[M2 API device details get | device_details_get]] – shows all information about specified device.
* [[M4 API device details get | device_details_get]] – shows all information about specified device.
* [[M4_API_cp_create | cp_create]] - creates a connection point
* [[M4_API_cp_create | cp_create]] - creates a connection point
* [[M4_API_cp_update | cp_update]] - updates a connection point
* [[M4_API_cp_update | cp_update]] - updates a connection point
Line 53: Line 53:


==Number Pools==
==Number Pools==
* [[M2 API number_pools_get| number_pools_get]] – get Number Pools list
* [[M4 API number_pools_get| number_pools_get]] – get Number Pools list
* [[M2 API number_pool_create| number_pool_create]] – create Number Pools
* [[M4 API number_pool_create| number_pool_create]] – create Number Pools
* [[M2 API number pool update| number_pool_update]] – update Number Pool
* [[M4 API number pool update| number_pool_update]] – update Number Pool
* [[M2 API number pool delete| number_pool_delete]] – delete Number Pool
* [[M4 API number pool delete| number_pool_delete]] – delete Number Pool
* [[M2 API number pool numbers create| number_pool_numbers_create]] – create numbers for Number Pool
* [[M4 API number pool numbers create| number_pool_numbers_create]] – create numbers for Number Pool
* [[M2 API number pool numbers delete| number_pool_numbers_delete]] – delete numbers from Number Pool
* [[M4 API number pool numbers delete| number_pool_numbers_delete]] – delete numbers from Number Pool


<br>
<br>


==Login==
==Login==
* [[M2 API user_login|user_login]] (login) – logs user in to M4.
* [[M4 API user_login|user_login]] (login) – logs user in to M4.
* [[M2 API user_logout|user_logout]] (logout) – logs user out from M4.
* [[M4 API user_logout|user_logout]] (logout) – logs user out from M4.


<br>
<br>


==Payments==
==Payments==
* [[M2 API payment_create| payment_create]] (create_payment) – create payment.
* [[M4 API payment_create| payment_create]] (create_payment) – create payment.
* [[M2 API payments_get| payments_get]] (payments_list) – payments list.
* [[M4 API payments_get| payments_get]] (payments_list) – payments list.


<br>
<br>


==Rates==
==Rates==
* [[M2 API tariff rates get| tariff_rates_get]] (get_tariff) – get all tariff's rates
* [[M4 API tariff rates get| tariff_rates_get]] (get_tariff) – get all tariff's rates
* [[M2 API tariff_wholesale_update | tariff_wholesale_update ]] (wholesale_tariff) – update or create wholesale tariff
* [[M4 API tariff_wholesale_update | tariff_wholesale_update ]] (wholesale_tariff) – update or create wholesale tariff


<br>
<br>
==Statistics==
==Statistics==
* [[M2 API quickstats_get | quickstats_get]] – gets today's [[Quick Stats]] and [[Active Calls]] count
* [[M4 API quickstats_get | quickstats_get]] – gets today's [[Quick Stats]] and [[Active Calls]] count
* [[M2_API_aggregate_get | aggregates_get]] - get aggregated statistics
* [[M4_API_aggregate_get | aggregates_get]] - get aggregated statistics


<br>
<br>


==User==
==User==
* [[M2 API user_details_get | user_details_get]] (user_details) – gets user details.
* [[M4 API user_details_get | user_details_get]] (user_details) – gets user details.


<br>
<br>

Revision as of 11:33, 28 November 2022

"api"



About

M4 API lets other software interact with M4 without knowing the internal structure of the database (DB) and other logic.

M4 accepts requests by HTML POST and returns results in XML.



M4 users that are allowed to use M4 API

  • Admin
  • Manager - only by using Admin Hash and Secret key
  • Simple User



Functions

API Related


Balance

Various methods to retrieve User balance


Calls

  • user_calls_get (user_calls) – retrieves a list of calls in a selected time period for a user/device.


Currencies


Device / Connection Point


Number Pools


Login


Payments


Rates


Statistics


User


HTML POST

All requests are in a similar format:

HTML POST: http://<SERVER_IP>/billing/api/<function>?u=username
  • username - the username 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 return data straight from the database. It means that M4 GUI settings do not affect data, it will be returned as it is saved in the database. For example:



See also