https://wiki.kolmisoft.com/api.php?action=feedcontributions&feedformat=atom&user=EdvinasKolmisoft Wiki - User contributions [en]2026-04-16T21:25:36ZUser contributionsMediaWiki 1.37.1https://wiki.kolmisoft.com/index.php?title=MOR_API_Card_Group_create&diff=20318MOR API Card Group create2015-11-11T14:45:37Z<p>Edvinas: </p>
<hr />
<div>=Description=<br />
[[MOR API]] Card Group create<br />
<br><br><br />
=Usage=<br />
<br />
* From '''MOR X7''' Calling Card: '''/api/cc_group_create'''<br />
* Methods: POST, GET(if allowed, not recomended)<br />
<br><br><br />
===Parameters===<br />
<br />
Parameters which are '''included''' into hash:<br />
<br />
* name - name of a Card Group '''Required'''.<br />
<br />
<br><br><br />
Parameters which are '''not included''' into hash:<br />
<br />
* '''[[MOR API hash construction | hash]]''' - SHA1 hash constructed using the '''parameters''' which are listed above. Note that the parameters are shown in the same order as they need to be when generating the hash. The last parameter in a row is '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.<br><br />
* '''u''' - username for authentication. '''Required'''.<br />
* '''description''' - description for Card Group.<br />
* '''price_with_vat''' - price with TAX for Card Group.<br />
* '''setup_fee''' - setup fee for Card Group.<br />
* '''ghost_min_perc''' - ghost min percent for Card Group.<br />
* '''daily_charge''' - daily charge for Card Group.<br />
* '''tariff_id''' - Card Group Tariff ID.<br />
* '''lcr_id''' - Card Group LCR id.<br />
* '''date_from''' - Card Group valid from date.<br />
* '''date_till''' - Card Group valid till date.<br />
* '''number_length''' - Card Group number length.<br />
* '''pin_length''' - Card Group pin length.<br />
* '''location_id''' - Card Group Location ID.<br />
* '''tax_id''' - Card Group TAX ID.<br />
* '''valid_after_first_use''' - number of days, after which Card Group gets valid.<br />
* '''ghost_balance_perc''' - Card Group ghost balance percent.<br />
* '''use_external_function''' - enable or disable use of external script.<br />
* '''allow_loss_calls''' - Allow Loss Calls for Card Group.<br />
* '''tell_cents''' - tell cents for Card Group.<br />
* '''tell_balance_in_currency''' - Card Group Balance/Rate Currency.<br />
* '''solo_pinless''' - enable or disable solo pinless.<br />
* '''disable_voucher''' - enable or disable voucher.<br />
* '''callerid_leave''' - enable or disable Caller ID leave.<br />
<br><br><br />
<br />
===Request===<br />
<br />
We have u = admin, API Secret Key = secret<br />
We send:<br />
<br />
HTML POST: http://<SERVER_IP>/billing/api/cc_group_create?u=admin&name=card_group_test&hash=7e112ededcfee097cce21b6201c6d2a00dda1f4c<br />
<br />
* Now we can find 1 newly created Card Group.'''<br><br />
'''* Note that if not passing optional parameters, default values will be used.'''<br><br />
'''* Note that a Username and a Password are not included into hash'''<br />
<br><br><br />
===Returns===<br />
<br />
'''Success'''<br />
<br />
<?xml version="1.0" encoding="UTF-8"?><br />
<page><br />
<status><br />
<success>Card Group was successfully created</success><br />
</status><br />
</page><br />
<br><br><br />
----<br />
<br />
'''Errors'''<br />
<br />
* <error>Access Denied</error> - User is not authorized or is a Simple User. Only Admin, Reseller or Accounant can use this API method. <br />
* <error>Incorrect hash</error> - hash is not correct. Check API_Secret_Key and order or parameters while concatenating a hash_string.<br />
* <error>You are not authorized to use this functionality</error> - User has no permissions to manage Calling Cards. <br />
* <error>Card Group must have name</error> - Card Group name is not given. Name is required parameter.<br />
* <error>Use external function is incorrect format</error> - use external script parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Allow loss calls is incorrect format</error> - allow loss calls parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Tell cents is incorrect format</error> - tell cents parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Solo pinless is incorrect format</error> - solo pinless parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Disable voucher is incorrect format</error> - voucher parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Callerid leave is incorrect format</error> - Caller ID leave parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Invalid date from</error> - UNIX time stamp date not correct.<br />
* <error>Invalid date till</error> - UNIX time stamp date not correct.<br />
* <error>Date from is greater than date till</error> - valid from is greater than valid till.<br />
* <error>Tariff was not found</error> - Tariff id is not correct. There is no such Tariff.<br />
* <error>LCR was not found</error> - LCR ID is not correct. There is no such LCR.<br />
* <error>Location was not found</error> - Location ID is not correct. There is no such Location.<br />
* <error>Currency was not found</error> - Currency ID is not correct. There is no such Currency.<br />
* <error>Invalid Price with TAX</error> - price is not correct, can not be negative.<br />
<br />
Example:<br />
<br />
<?xml version="1.0" encoding="UTF-8"?><br />
<page><br />
<status><br />
<error>Invalid solo pinless parameter, should be: 0 or 1</error><br />
</status><br />
</page><br />
<br><br><br />
<br />
=See also=<br />
<br />
* [[MOR API]]</div>Edvinashttps://wiki.kolmisoft.com/index.php?title=MOR_API&diff=20315MOR API2015-11-11T09:00:17Z<p>Edvinas: </p>
<hr />
<div>[[File:warning.png|100px|alt="warning"|link=]]<big><big><big>IMPORTANT!!! API methods described here are for MOR X6. For previous versions please check appropriate [http://wiki.kolmisoft.com/index.php/MOR_Manual#Old_Manuals manual].</big></big></big><br />
[[File:api.png|right|alt="api"|link=]]<br />
<mkmeta>Application Program Interface for MOR Class 5 Softswitch</mkmeta><br />
<br />
<br><br><br />
=About=<br />
MOR API lets other software interact with MOR without knowing the internal structure of the database (DB) and other logic.<br />
<br />
MOR accepts requests by HTML POST and returns results in XML.<br />
<br />
<br><br><br />
=MOR users that are allowed to use MOR API=<br />
* Admin<br />
* Reseller<br />
* Accountant - only by using Admin Hash and Secret key<br />
* Simple User<br />
<br />
<br><br><br />
<br />
=Functions=<br />
<br />
== API Related ==<br />
* [[API Configuration]] – configuration options for API.<br />
* [[MOR API hash construction|Hash construction]] – how to construct hash to authenticate data over API.<br />
<br />
<br><br />
==Balance==<br />
* [[MOR API user balance update | user_balance_update]] (change_user_balance) – changes User's Balance<br />
Various methods to retrieve User balance<br />
* [[MOR API user_balance_get|user_balance_get]] (balance) – retrieves a User Balance.<br />
* [[Balance in phone | user_simple_balance_get]] (simple_balance) – gets User's Balance<br />
* [[MOR API user balance get by psw | user_balance_get_by_psw]] – gets User's Balance by his owned Device's Password<br />
* [[MOR API User Balance get by Username | user_balance_get_by_username]] – gets User's Balance by his owned Device's Username<br />
<br />
<br><br />
<br />
==Callback==<br />
* [[MOR API callback init|callback_init]] (callback) – initiates callback.<br />
<br />
<br><br />
==Calling Cards==<br />
* [[MOR API card_by_cli_update| card_by_cli_update]] (cc_by_cli) – creates and updates calling cards, including adding and transferring funds, by being identified according the Caller_ID.<br />
* [[MOR API card_from_group_sell| card_from_group_sell]] (buy_card_from_callingroup) – sells cards from calling card group.<br />
* [[MOR API card_group_get| card_group_get]] (show_calling_card_group) – show calling group info.<br />
* [[MOR API card_balance_get| card_balance_get]] (card_balance_get) – show card's balance.<br />
* [[MOR API card_payment_add| card_payment_add]] – add payment to the calling card.<br />
* [[MOR_API_Calling_Cards_create| calling_cards_create]] – create Calling Cards.<br />
* [[MOR_API_Calling_Card_update| calling_card_update]] – update Calling Card.<br />
* [[MOR_API_Calling_Cards_get| calling_cards_get]] - get Calling Cards.<br />
* [[MOR_API_Card_Group_create| cc_group_create]] – create Card Group.<br />
* [[MOR_API_Card_Group_update| cc_group_update]] – update Card Group.<br />
* [[MOR_API_cc_groups_get| cc_groups_get]] – show Calling Cards Group info.<br />
<br><br />
<br />
==Calls==<br />
* [[MOR API user calls get|user_calls_get]] (user_calls) – retrieves a list of calls in a selected time period for a user/device.<br />
<br />
<br><br />
<br />
==Conflines==<br />
* [[MOR API conflines update|conflines_update]] – changes settings for API, Default User or Default Device.<br />
<br />
<br><br />
==Credit notes==<br />
* [[MOR API credit_notes_get| credit_notes_get]] (credit_notes) – credit notes list.<br />
* [[MOR API credit_note_update| credit_note_update]] – credit note update.<br />
* [[MOR API credit_notes_create| credit_note_create]] – credit note create.<br />
* [[MOR API credit_notes_delete| credit_note_delete]] – credit note delete.<br />
<br />
<br><br />
==Device==<br />
* [[MOR API device create| device_create]] – create device<br />
* [[MOR API device delete| device_delete]] (delete_device) – delete device<br />
* [[MOR API devices get | devices_get]] (device_list) – users device list<br />
* [[MOR API device callflow get| device_callflow_get]] - returns information about specified device callflow state.<br />
* [[MOR API device callflow update | device_callflow_update]] – updates information of specified device callflow state. <br />
* [[MOR API CLI info get | cli_info_get]] (cli_get_info) – shows id of device where CLI belongs.<br />
* [[MOR API CLI delete | cli_delete]] – deletes specified CLI. <br />
* [[MOR API CLI add | cli_add]] – creates CLI and assigns it to the specified device.<br />
* [[MOR API device clis get | device_clis_get]] – CLIs list by User and/or Device<br />
* [[MOR API device details get | device_details_get]] – shows all information about specified device.<br />
* [[MOR_API_device_update | device_update]] – updates location_id of selected Device.<br />
<br />
<br><br />
<br />
==DID==<br />
<br />
* [[MOR API dids get| dids_get]] – get list of particular DIDs<br />
* [[MOR API did_create| did_create]] – DID create<br />
* [[MOR_API_did_device_assign| did_device_assign]] (did_assign_device) – Assign Device to DID<br />
* [[MOR_API_did_device_unassign| did_device_unassign]] (did_unassign_device) – Unassign Device from DID<br />
* [[MOR_API_did_details_update| did_details_update]] (did_details_update) – Update DID details <br />
* [[MOR API did subscription stop|did_subscription_stop]] – STOP DID subscription<br />
<br />
<br><br />
<br />
==Email==<br />
* [[MOR API email send| email_send]] (send_email) – send Email.<br />
<br />
<br><br />
==Financial statements==<br />
* [[MOR API financial_statements_get| financial_statements_get]] (financial_statements) – financial statements list.<br />
<br />
<br><br />
==Invoices==<br />
* [[MOR API invoices_get|invoices_get]] (invoices) – retrieves a list of invoices in a selected time period.<br />
<br />
<br><br />
==Login==<br />
* [[MOR API user_login|user_login]] (login) – logs user in to MOR.<br />
* [[MOR API user_logout|user_logout]] (logout) – logs user out from MOR.<br />
<br />
<br><br />
==Monitorings==<br />
* [[MOR API ma_activate_api| ma_activate]] – turn on monitorings addon<br />
<br />
<br><br />
==Payments==<br />
* [[MOR API payment_create| payment_create]] (create_payment) – create payment.<br />
* [[MOR API payments_get| payments_get]] (payments_list) – payments list.<br />
<br />
<br><br />
==Phonebooks==<br />
* [[MOR API phonebooks_get| phonebooks_get]] (phonebooks_api ) – phonebooks list.<br />
* [[MOR API phonebook_edit| phonebook_edit]] (phonebook_edit_api) – edit phonebook.<br />
* [[MOR API phonebook_record_create| phonebook_record_create]] – create phonebook.<br />
<br />
<br><br />
==Quickforwards==<br />
* [[MOR API Quickforwards get| quickforwards_dids_get]] (quickforwards_dids_get) – get Quickforwards.<br />
* [[MOR API Quickforwards update| quickforwards_did_update]] (quickforwards_did_update) – update Quickforwards.<br />
* [[MOR API Quickforwards delete| quickforwards_did_delete]] (quickforwards_did_delete) – delete Quickforwards.<br />
<br />
<br><br />
==Rates==<br />
* [[MOR API rate get|rate_get]] (rate) – check user rate by prefix<br />
* [[MOR API tariff rates get| tariff_rates_get]] (get_tariff) – get all tariff's rates<br />
* [[MOR API tariff_retail_import | tariff_retail_import ]] (import_relail_tariff) – import xml retail tariff<br />
* [[MOR API tariff_wholesale_update | tariff_wholesale_update ]] (wholesale_tariff) – update or create wholesale tariff<br />
<br />
<br><br />
==Services==<br />
* [[MOR API Service create| service_create]] – create Service.<br />
* [[MOR API Service delete| service_delete]] – delete Service.<br />
* [[MOR API Services get| services_get]] – get Services.<br />
* [[MOR API Service update| service_update]] – update Service.<br />
<br />
<br><br />
<br />
==SMS==<br />
* [[MOR API sms send| sms_send]] (send_sms) – send SMS.<br />
* [[MOR_API_user_sms_service_subscribe | user_sms_service_subscribe ]] – User subscription to SMS Service.<br />
<br />
<br><br />
==Subscriptions==<br />
* [[MOR API subscription delete|subscription_delete]] - Subscription delete.<br />
* [[MOR API Subscriptions get|subscriptions_get]] - Subscriptions get.<br />
* [[MOR API subscription create|subscription_create]] - Subscription create.<br />
* [[MOR API subscription update|subscription_update]] - Subscription delete.<br />
<br><br />
<br />
==User==<br />
<br />
* [[MOR API user_register| user_register]] – create new user from params.<br />
* [[MOR API user_details_get | user_details_get]] (user_details) – gets user details.<br />
* [[MOR_API_user_details_update| user_details_update]] (user_update_api) – update user from params.<br />
<br><br />
<br />
== Resellers ==<br />
* [[MOR API reseller group create]] - create new Reseller Group<br />
<br />
<br><br />
==Version==<br />
* [[MOR API system version get| system_version_get]] (get_version) – get MOR version number.<br />
<br />
<br><br />
= Examples =<br />
* [[MOR API PHP Examples]]<br />
<br />
<br><br><br />
=HTML POST=<br />
All requests are in a similar format:<br />
<br />
HTML POST: http://<SERVER_IP>/billing/api/<function>?u=username<br />
<br />
* username - the user name and password of the user who is asking for the data. <br />
<br />
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.<br />
<br><br><br />
=Useful to know=<br />
<br />
* 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:<br />
** Value of money will be returned in Default System [[Currencies|Currency]].<br />
** Date will not be affected of [[Configuration_from_GUI#Visual| Default date format]] setting.<br />
** Value of money will not be affected of [[Configuration_from_GUI#Visual|Number digits]] setting.<br />
<br />
<br><br><br />
=See also =<br />
* [[API Configuration]]<br />
* [[MOR integration]]<br />
* [[How to block access to some API functions]]<br />
* [[API specification to be implemented in the future]]</div>Edvinashttps://wiki.kolmisoft.com/index.php?title=MOR_API_Card_Group_create&diff=20314MOR API Card Group create2015-11-11T08:57:24Z<p>Edvinas: </p>
<hr />
<div>=Description=<br />
[[MOR API]] Card Group create<br />
<br><br><br />
=Usage=<br />
<br />
* From '''MOR X7''' Calling Card: '''/api/cc_group_create'''<br />
* Methods: POST, GET(if allowed, not recomended)<br />
<br><br><br />
===Parameters===<br />
<br />
Parameters which are '''included''' into hash:<br />
<br />
* name - name of a Card Group '''Required'''.<br />
<br />
<br><br><br />
Parameters which are '''not included''' into hash:<br />
<br />
* '''[[MOR API hash construction | hash]]''' - SHA1 hash constructed using the '''parameters''' which are listed above. Note that the parameters are shown in the same order as they need to be when generating the hash. The last parameter in a row is '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.<br><br />
* '''u''' - username for authentication. '''Required'''.<br />
* '''description''' - description for Card Group.<br />
* '''price_with_vat''' - price with TAX for Card Group.<br />
* '''setup_fee''' - setup fee for Card Group.<br />
* '''ghost_min_perc''' - ghost min percent for Card Group.<br />
* '''daily_charge''' - daily charge for Card Group.<br />
* '''tariff_id''' - Card Group Tariff ID.<br />
* '''lcr_id''' - Card Group LCR id.<br />
* '''date_from''' - Card Group valid from date.<br />
* '''date_till''' - Card Group valid till date.<br />
* '''number_length''' - Card Group number length.<br />
* '''pin_length''' - Card Group pin length.<br />
* '''dialplan_id''' - Card Group Dialplan ID.<br />
* '''location_id''' - Card Group Location ID.<br />
* '''tax_id''' - Card Group TAX ID.<br />
* '''valid_after_first_use''' - number of days, after which Card Group gets valid.<br />
* '''ghost_balance_perc''' - Card Group ghost balance percent.<br />
* '''use_external_function''' - enable or disable use of external script.<br />
* '''allow_loss_calls''' - Allow Loss Calls for Card Group.<br />
* '''tell_cents''' - tell cents for Card Group.<br />
* '''tell_balance_in_currency''' - Card Group Balance/Rate Currency.<br />
* '''solo_pinless''' - enable or disable solo pinless.<br />
* '''disable_voucher''' - enable or disable voucher.<br />
* '''hidden''' - enable or disable hidden status.<br />
* '''callerid_leave''' - enable or disable Caller ID leave.<br />
<br><br><br />
<br />
===Request===<br />
<br />
We have u = admin, API Secret Key = secret<br />
We send:<br />
<br />
HTML POST: http://<SERVER_IP>/billing/api/cc_group_create?u=admin&name=card_group_test&hash=7e112ededcfee097cce21b6201c6d2a00dda1f4c<br />
<br />
* Now we can find 1 newly created Card Group.'''<br><br />
'''* Note that if not passing optional parameters, default values will be used.'''<br><br />
'''* Note that a Username and a Password are not included into hash'''<br />
<br><br><br />
===Returns===<br />
<br />
'''Success'''<br />
<br />
<?xml version="1.0" encoding="UTF-8"?><br />
<page><br />
<status><br />
<success>Card Group was successfully created</success><br />
</status><br />
</page><br />
<br><br><br />
----<br />
<br />
'''Errors'''<br />
<br />
* <error>Access Denied</error> - User is not authorized or is a Simple User. Only Admin, Reseller or Accounant can use this API method. <br />
* <error>Incorrect hash</error> - hash is not correct. Check API_Secret_Key and order or parameters while concatenating a hash_string.<br />
* <error>You are not authorized to use this functionality</error> - User has no permissions to manage Calling Cards. <br />
* <error>Card Group must have name</error> - Card Group name is not given. Name is required parameter.<br />
* <error>Use external function is incorrect format</error> - use external script parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Allow loss calls is incorrect format</error> - allow loss calls parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Tell cents is incorrect format</error> - tell cents parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Solo pinless is incorrect format</error> - solo pinless parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Disable voucher is incorrect format</error> - voucher parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Hidden is incorrect format</error> - hidden parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Callerid leave is incorrect format</error> - Caller ID leave parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Invalid date from</error> - UNIX time stamp date not correct.<br />
* <error>Invalid date till</error> - UNIX time stamp date not correct.<br />
* <error>Date from is greater than date till</error> - valid from is greater than valid till.<br />
* <error>Tariff was not found</error> - Tariff id is not correct. There is no such Tariff.<br />
* <error>LCR was not found</error> - LCR ID is not correct. There is no such LCR.<br />
* <error>Dialplan was not found</error> - Dialplan ID is not correct. There is no such Dialplan.<br />
* <error>Location was not found</error> - Location ID is not correct. There is no such Location.<br />
* <error>Currency was not found</error> - Currency ID is not correct. There is no such Currency.<br />
* <error>Invalid Price with TAX</error> - price is not correct, can not be negative.<br />
<br />
Example:<br />
<br />
<?xml version="1.0" encoding="UTF-8"?><br />
<page><br />
<status><br />
<error>Invalid solo pinless parameter, should be: 0 or 1</error><br />
</status><br />
</page><br />
<br><br><br />
<br />
=See also=<br />
<br />
* [[MOR API]]</div>Edvinashttps://wiki.kolmisoft.com/index.php?title=MOR_API_Card_Group_create&diff=20312MOR API Card Group create2015-11-11T08:37:37Z<p>Edvinas: </p>
<hr />
<div>=Description=<br />
[[MOR API]] Card Group create<br />
<br><br><br />
=Usage=<br />
<br />
* From '''MOR X7''' Calling Card: '''/api/cc_group_create'''<br />
* Methods: POST, GET(if allowed, not recomended)<br />
<br><br><br />
===Parameters===<br />
<br />
Parameters which are '''included''' into hash:<br />
<br />
* name - name of a Card Group '''Required'''.<br />
<br />
<br><br><br />
Parameters which are '''not included''' into hash:<br />
<br />
* '''[[MOR API hash construction | hash]]''' - SHA1 hash constructed using the '''parameters''' which are listed above. Note that the parameters are shown in the same order as they need to be when generating the hash. The last parameter in a row is '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.<br><br />
* '''u''' - username for authentication. '''Required'''.<br />
* '''description''' - description for Card Group.<br />
* '''price_with_vat''' - price with TAX for Card Group.<br />
* '''setup_fee''' - setup fee for Card Group.<br />
* '''ghost_min_perc''' - ghost min percent for Card Group.<br />
* '''daily_charge''' - daily charge for Card Group.<br />
* '''tariff_id''' - Card Group tariff id.<br />
* '''lcr_id''' - Card Group lcr id.<br />
* '''date_from''' - Card Group valid from date.<br />
* '''date_till''' - Card Group valid till date.<br />
* '''number_length''' - Card Group number length.<br />
* '''pin_length''' - Card Group pin length.<br />
* '''dialplan_id''' - Card Group dial plan id.<br />
* '''location_id''' - Card Group location id.<br />
* '''tax_id''' - Card Group tax id.<br />
* '''valid_after_first_use''' - number of days, after which Card Group gets valid.<br />
* '''ghost_balance_perc''' - Card Group ghost balance percent.<br />
* '''use_external_function''' - enable or disable use of external script;<br />
* '''allow_loss_calls''' - Allow Loss Calls for Card Group.<br />
* '''tell_cents''' - tell cents for Card Group.<br />
* '''tell_balance_in_currency''' - Card Group Balance/Rate Currency.<br />
* '''solo_pinless''' - enable or disable solo pinless.<br />
* '''disable_voucher''' - enable or disable voucher.<br />
* '''hidden''' - enable or disable hidden status.<br />
* '''callerid_leave''' - enable or disable caller id leave.<br />
<br><br><br />
<br />
===Request===<br />
<br />
We have u = admin, API Secret Key = secret<br />
We send:<br />
<br />
HTML POST: http://<SERVER_IP>/billing/api/cc_group_create?u=admin&name=card_group_test&hash=7e112ededcfee097cce21b6201c6d2a00dda1f4c<br />
<br />
* Now we can find 1 newly created Card Group.'''<br><br />
'''* Note that if not passing optional parameters, default values will be used.'''<br><br />
'''* Note that a Username and a Password are not included into hash'''<br />
<br><br><br />
===Returns===<br />
<br />
'''Success'''<br />
<br />
<?xml version="1.0" encoding="UTF-8"?><br />
<page><br />
<status><br />
<success>Card Group was successfully created</success><br />
</status><br />
</page><br />
<br><br><br />
----<br />
<br />
'''Errors'''<br />
<br />
* <error>Access Denied</error> - User is not authorized or is a Simple User. Only Admin, Reseller or Accounant can use this API method. <br />
* <error>Incorrect hash</error> - hash is not correct. Check API_Secret_Key and order or parameters while concatenating a hash_string.<br />
* <error>You are not authorized to use this functionality</error> - User has no permissions to manage Calling Cards. <br />
* <error>Bad login</error> - User is not authorized (possibly wrong Username). <br />
* <error>Card Group must have name</error> - Card Group name is not given. Name is requered parameter.<br />
* <error>Invalid use external function parameter, should be: 0 or 1</error> - use external script parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Invalid allow loss calls parameter, should be: 0 or 1</error> - allow loss calls parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Invalid tell cents parameter, should be: 0 or 1</error> - tell cents parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Invalid solo pinless parameter, should be: 0 or 1</error> - solo pinless parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Invalid disable voucher parameter, should be: 0 or 1</error> - voucher parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Invalid hidden parameter, should be: 0 or 1</error> - hidden parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Invalid callerid leave parameter, should be: 0 or 1</error> - caller id leave parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Invalid date from</error> - unix time stamp date not correct.<br />
* <error>Invalid date till</error> - unix time stamp date not correct.<br />
* <error>Date from is greater than date till</error> - valid from is greater than valid till.<br />
* <error>Invalid Tariff id</error> - Tariff id is not correct. There is no such Tariff.<br />
* <error>Invalid Lcr id</error> - Lcr id is not correct. There is no such Lcr.<br />
* <error>Invalid Dialplan id</error> - Dialplan id is not correct. There is no such Dialplan.<br />
* <error>Invalid Location id</error> - Location id is not correct. There is no such Location.<br />
* <error>Invalid Currency</error> - Currency id is not correct. There is no such Currency.<br />
* <error>Invalid Price with TAX</error> - price is not correct, can not be negative.<br />
<br />
Example:<br />
<br />
<?xml version="1.0" encoding="UTF-8"?><br />
<page><br />
<status><br />
<error>Invalid solo pinless parameter, should be: 0 or 1</error><br />
</status><br />
</page><br />
<br><br><br />
<br />
=See also=<br />
<br />
* [[MOR API]]</div>Edvinashttps://wiki.kolmisoft.com/index.php?title=MOR_API&diff=20309MOR API2015-11-06T10:32:22Z<p>Edvinas: /* Calling Cards */</p>
<hr />
<div>[[File:warning.png|100px|alt="warning"|link=]]<big><big><big>IMPORTANT!!! API methods described here are for MOR X6. For previous versions please check appropriate [http://wiki.kolmisoft.com/index.php/MOR_Manual#Old_Manuals manual].</big></big></big><br />
[[File:api.png|right|alt="api"|link=]]<br />
<mkmeta>Application Program Interface for MOR Class 5 Softswitch</mkmeta><br />
<br />
<br><br><br />
=About=<br />
MOR API lets other software interact with MOR without knowing the internal structure of the database (DB) and other logic.<br />
<br />
MOR accepts requests by HTML POST and returns results in XML.<br />
<br />
<br><br><br />
=MOR users that are allowed to use MOR API=<br />
* Admin<br />
* Reseller<br />
* Accountant - only by using Admin Hash and Secret key<br />
* Simple User<br />
<br />
<br><br><br />
<br />
=Functions=<br />
<br />
== API Related ==<br />
* [[API Configuration]] – configuration options for API.<br />
* [[MOR API hash construction|Hash construction]] – how to construct hash to authenticate data over API.<br />
<br />
<br><br />
==Balance==<br />
* [[MOR API user balance update | user_balance_update]] (change_user_balance) – changes User's Balance<br />
Various methods to retrieve User balance<br />
* [[MOR API user_balance_get|user_balance_get]] (balance) – retrieves a User Balance.<br />
* [[Balance in phone | user_simple_balance_get]] (simple_balance) – gets User's Balance<br />
* [[MOR API user balance get by psw | user_balance_get_by_psw]] – gets User's Balance by his owned Device's Password<br />
* [[MOR API User Balance get by Username | user_balance_get_by_username]] – gets User's Balance by his owned Device's Username<br />
<br />
<br><br />
<br />
==Callback==<br />
* [[MOR API callback init|callback_init]] (callback) – initiates callback.<br />
<br />
<br><br />
==Calling Cards==<br />
* [[MOR API card_by_cli_update| card_by_cli_update]] (cc_by_cli) – creates and updates calling cards, including adding and transferring funds, by being identified according the Caller_ID.<br />
* [[MOR API card_from_group_sell| card_from_group_sell]] (buy_card_from_callingroup) – sells cards from calling card group.<br />
* [[MOR API card_group_get| card_group_get]] (show_calling_card_group) – show calling group info.<br />
* [[MOR API card_balance_get| card_balance_get]] (card_balance_get) – show card's balance.<br />
* [[MOR API card_payment_add| card_payment_add]] – add payment to the calling card.<br />
* [[MOR_API_Calling_Cards_create| calling_cards_create]] – create Calling Cards.<br />
* [[MOR_API_cc_groups_get| cc_groups_get]] – show Calling Cards Group info.<br />
* [[MOR_API_Calling_Card_update| calling_card_update]] – update Calling Card.<br />
* [[MOR_API_Card_Group_create| cc_group_create]] – create Card Group.<br />
* [[MOR_API_Calling_Cards_get| calling_cards_get]] - get Calling Cards.<br />
* [[MOR_API_Card_Group_update| cc_group_update]] – update Card Group.<br />
<br><br />
<br />
==Calls==<br />
* [[MOR API user calls get|user_calls_get]] (user_calls) – retrieves a list of calls in a selected time period for a user/device.<br />
<br />
<br><br />
<br />
==Conflines==<br />
* [[MOR API conflines update|conflines_update]] – changes settings for API, Default User or Default Device.<br />
<br />
<br><br />
==Credit notes==<br />
* [[MOR API credit_notes_get| credit_notes_get]] (credit_notes) – credit notes list.<br />
* [[MOR API credit_note_update| credit_note_update]] – credit note update.<br />
* [[MOR API credit_notes_create| credit_note_create]] – credit note create.<br />
* [[MOR API credit_notes_delete| credit_note_delete]] – credit note delete.<br />
<br />
<br><br />
==Device==<br />
* [[MOR API device create| device_create]] – create device<br />
* [[MOR API device delete| device_delete]] (delete_device) – delete device<br />
* [[MOR API devices get | devices_get]] (device_list) – users device list<br />
* [[MOR API device callflow get| device_callflow_get]] - returns information about specified device callflow state.<br />
* [[MOR API device callflow update | device_callflow_update]] – updates information of specified device callflow state. <br />
* [[MOR API CLI info get | cli_info_get]] (cli_get_info) – shows id of device where CLI belongs.<br />
* [[MOR API CLI delete | cli_delete]] – deletes specified CLI. <br />
* [[MOR API CLI add | cli_add]] – creates CLI and assigns it to the specified device.<br />
* [[MOR API device clis get | device_clis_get]] – CLIs list by User and/or Device<br />
* [[MOR API device details get | device_details_get]] – shows all information about specified device.<br />
* [[MOR_API_device_update | device_update]] – updates location_id of selected Device.<br />
<br />
<br><br />
<br />
==DID==<br />
<br />
* [[MOR API dids get| dids_get]] – get list of particular DIDs<br />
* [[MOR API did_create| did_create]] – DID create<br />
* [[MOR_API_did_device_assign| did_device_assign]] (did_assign_device) – Assign Device to DID<br />
* [[MOR_API_did_device_unassign| did_device_unassign]] (did_unassign_device) – Unassign Device from DID<br />
* [[MOR_API_did_details_update| did_details_update]] (did_details_update) – Update DID details <br />
* [[MOR API did subscription stop|did_subscription_stop]] – STOP DID subscription<br />
<br />
<br><br />
<br />
==Email==<br />
* [[MOR API email send| email_send]] (send_email) – send Email.<br />
<br />
<br><br />
==Financial statements==<br />
* [[MOR API financial_statements_get| financial_statements_get]] (financial_statements) – financial statements list.<br />
<br />
<br><br />
==Invoices==<br />
* [[MOR API invoices_get|invoices_get]] (invoices) – retrieves a list of invoices in a selected time period.<br />
<br />
<br><br />
==Login==<br />
* [[MOR API user_login|user_login]] (login) – logs user in to MOR.<br />
* [[MOR API user_logout|user_logout]] (logout) – logs user out from MOR.<br />
<br />
<br><br />
==Monitorings==<br />
* [[MOR API ma_activate_api| ma_activate]] – turn on monitorings addon<br />
<br />
<br><br />
==Payments==<br />
* [[MOR API payment_create| payment_create]] (create_payment) – create payment.<br />
* [[MOR API payments_get| payments_get]] (payments_list) – payments list.<br />
<br />
<br><br />
==Phonebooks==<br />
* [[MOR API phonebooks_get| phonebooks_get]] (phonebooks_api ) – phonebooks list.<br />
* [[MOR API phonebook_edit| phonebook_edit]] (phonebook_edit_api) – edit phonebook.<br />
* [[MOR API phonebook_record_create| phonebook_record_create]] – create phonebook.<br />
<br />
<br><br />
==Quickforwards==<br />
* [[MOR API Quickforwards get| quickforwards_dids_get]] (quickforwards_dids_get) – get Quickforwards.<br />
* [[MOR API Quickforwards update| quickforwards_did_update]] (quickforwards_did_update) – update Quickforwards.<br />
* [[MOR API Quickforwards delete| quickforwards_did_delete]] (quickforwards_did_delete) – delete Quickforwards.<br />
<br />
<br><br />
==Rates==<br />
* [[MOR API rate get|rate_get]] (rate) – check user rate by prefix<br />
* [[MOR API tariff rates get| tariff_rates_get]] (get_tariff) – get all tariff's rates<br />
* [[MOR API tariff_retail_import | tariff_retail_import ]] (import_relail_tariff) – import xml retail tariff<br />
* [[MOR API tariff_wholesale_update | tariff_wholesale_update ]] (wholesale_tariff) – update or create wholesale tariff<br />
<br />
<br><br />
==Services==<br />
* [[MOR API Service create| service_create]] – create Service.<br />
* [[MOR API Service delete| service_delete]] – delete Service.<br />
* [[MOR API Services get| services_get]] – get Services.<br />
* [[MOR API Service update| service_update]] – update Service.<br />
<br />
<br><br />
<br />
==SMS==<br />
* [[MOR API sms send| sms_send]] (send_sms) – send SMS.<br />
* [[MOR_API_user_sms_service_subscribe | user_sms_service_subscribe ]] – User subscription to SMS Service.<br />
<br />
<br><br />
==Subscriptions==<br />
* [[MOR API subscription delete|subscription_delete]] - Subscription delete.<br />
* [[MOR API Subscriptions get|subscriptions_get]] - Subscriptions get.<br />
* [[MOR API subscription create|subscription_create]] - Subscription create.<br />
* [[MOR API subscription update|subscription_update]] - Subscription delete.<br />
<br><br />
<br />
==User==<br />
<br />
* [[MOR API user_register| user_register]] – create new user from params.<br />
* [[MOR API user_details_get | user_details_get]] (user_details) – gets user details.<br />
* [[MOR_API_user_details_update| user_details_update]] (user_update_api) – update user from params.<br />
<br><br />
<br />
== Resellers ==<br />
* [[MOR API reseller group create]] - create new Reseller Group<br />
<br />
<br><br />
==Version==<br />
* [[MOR API system version get| system_version_get]] (get_version) – get MOR version number.<br />
<br />
<br><br />
= Examples =<br />
* [[MOR API PHP Examples]]<br />
<br />
<br><br><br />
=HTML POST=<br />
All requests are in a similar format:<br />
<br />
HTML POST: http://<SERVER_IP>/billing/api/<function>?u=username<br />
<br />
* username - the user name and password of the user who is asking for the data. <br />
<br />
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.<br />
<br><br><br />
=Useful to know=<br />
<br />
* 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:<br />
** Value of money will be returned in Default System [[Currencies|Currency]].<br />
** Date will not be affected of [[Configuration_from_GUI#Visual| Default date format]] setting.<br />
** Value of money will not be affected of [[Configuration_from_GUI#Visual|Number digits]] setting.<br />
<br />
<br><br><br />
=See also =<br />
* [[API Configuration]]<br />
* [[MOR integration]]<br />
* [[How to block access to some API functions]]<br />
* [[API specification to be implemented in the future]]</div>Edvinashttps://wiki.kolmisoft.com/index.php?title=MOR_API_Card_Group_update&diff=20308MOR API Card Group update2015-11-06T10:31:19Z<p>Edvinas: Created page with '=Description= MOR API Card Group update <br><br> =Usage= * From '''MOR X7''' Calling Card: '''/api/cc_group_update''' * Methods: POST, GET(if allowed, not recomended) <br><b…'</p>
<hr />
<div>=Description=<br />
[[MOR API]] Card Group update<br />
<br><br><br />
=Usage=<br />
<br />
* From '''MOR X7''' Calling Card: '''/api/cc_group_update'''<br />
* Methods: POST, GET(if allowed, not recomended)<br />
<br><br><br />
===Parameters===<br />
<br />
Parameters which are '''included''' into hash:<br />
<br />
* cc_Group_id - id of a Card Group '''Required'''.<br />
<br />
<br><br><br />
Parameters which are '''not included''' into hash:<br />
<br />
* '''[[MOR API hash construction | hash]]''' - SHA1 hash constructed using the '''parameters''' which are listed above. Note that the parameters are shown in the same order as they need to be when generating the hash. The last parameter in a row is '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.<br><br />
* '''u''' - username for authentication. '''Required'''.<br />
* '''description''' - description for Card Group.<br />
* '''price_with_vat''' - price with TAX for Card Group.<br />
* '''setup_fee''' - setup fee for Card Group.<br />
* '''ghost_min_perc''' - ghost min percent for Card Group.<br />
* '''daily_charge''' - daily charge for Card Group.<br />
* '''tariff_id''' - Card Group tariff id.<br />
* '''lcr_id''' - Card Group lcr id.<br />
* '''date_from''' - Card Group valid from date.<br />
* '''date_till''' - Card Group valid till date.<br />
* '''dialplan_id''' - Card Group dial plan id.<br />
* '''location_id''' - Card Group location id.<br />
* '''tax_id''' - Card Group tax id.<br />
* '''valid_after_first_use''' - number of days, after which Card Group gets valid.<br />
* '''ghost_balance_perc''' - Card Group ghost balance percent.<br />
* '''use_external_function''' - enable or disable use of external script;<br />
* '''allow_loss_calls''' - Allow Loss Calls for Card Group.<br />
* '''tell_cents''' - tell cents for Card Group.<br />
* '''tell_balance_in_currency''' - Card Group Balance/Rate Currency.<br />
* '''solo_pinless''' - enable or disable solo pinless.<br />
* '''disable_voucher''' - enable or disable voucher.<br />
* '''hidden''' - enable or disable hidden status.<br />
* '''callerid_leave''' - enable or disable caller id leave.<br />
* '''name''' - name of Card Group.<br />
<br><br><br />
<br />
===Request===<br />
<br />
We have u = admin, API Secret Key = secret<br />
We send:<br />
<br />
HTML POST: http://<SERVER_IP>/billing/api/cc_group_update?u=admin&cc_Group_id=1&hash=7e112ededcfee097cce21b6201c6d2a00dda1f4c<br />
<br />
* Now we can find 1 updated Card Group.'''<br><br />
'''* Note that a Username and a Password are not included into hash'''<br />
<br><br><br />
===Returns===<br />
<br />
'''Success'''<br />
<br />
<?xml version="1.0" encoding="UTF-8"?><br />
<page><br />
<status><br />
<success>Card Group was successfully updated</success><br />
</status><br />
</page><br />
<br><br><br />
----<br />
<br />
'''Errors'''<br />
<br />
* <error>Access Denied</error> - User is not authorized or is a Simple User. Only Admin, Reseller or Accounant can use this API method. <br />
* <error>Incorrect hash</error> - hash is not correct. Check API_Secret_Key and order or parameters while concatenating a hash_string.<br />
* <error>You are not authorized to use this functionality</error> - User has no permissions to manage Calling Cards. <br />
* <error>Bad login</error> - User is not authorized (possibly wrong Username). <br />
* <error>Wrong Card Group ID</error> - cc_Group_id is not a number.<br />
* <error>Card Group not found</error> - there is no such Card Group, wrong cc_Group_id.<br />
* <error>Tax not found</error> - there is no such Tax, wrong tax_id.<br />
* <error>Invalid Price with TAX</error> - wrong price with TAX for Card Group.<br />
* <error>Invalid Currency</error> - Currency id is not correct. There is no such Currency.<br />
* <error>Invalid Tariff id</error> - Tariff id is not correct. There is no such Tariff.<br />
* <error>Invalid Lcr id</error> - Lcr id is not correct. There is no such Lcr.<br />
* <error>Invalid Dialplan id</error> - Dialplan id is not correct. There is no such Dialplan.<br />
* <error>Invalid Location id</error> - Location id is not correct. There is no such Location.<br />
* <error>Invalid date from</error> - unix time stamp date not correct.<br />
* <error>Invalid date till</error> - unix time stamp date not correct.<br />
* <error>Date from is greater than date till</error> - valid from is greater than valid till.<br />
* <error>Invalid use external function parameter, should be: 0 or 1</error> - use external script parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Invalid allow loss calls parameter, should be: 0 or 1</error> - allow loss calls parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Invalid tell cents parameter, should be: 0 or 1</error> - tell cents parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Invalid solo pinless parameter, should be: 0 or 1</error> - solo pinless parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Invalid disable voucher parameter, should be: 0 or 1</error> - voucher parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Invalid hidden parameter, should be: 0 or 1</error> - hidden parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Invalid callerid leave parameter, should be: 0 or 1</error> - caller id leave parameter can only be: 1 - enabled, 0 - disabled.<br />
<br />
Example:<br />
<br />
<?xml version="1.0" encoding="UTF-8"?><br />
<page><br />
<status><br />
<error>Invalid Price with TAX</error><br />
</status><br />
</page><br />
<br><br><br />
<br />
=See also=<br />
<br />
* [[MOR API]]</div>Edvinashttps://wiki.kolmisoft.com/index.php?title=MOR_API_Calling_Cards_create&diff=20307MOR API Calling Cards create2015-11-05T14:38:15Z<p>Edvinas: </p>
<hr />
<div>=Description=<br />
[[MOR API]] Calling Cards create<br />
<br><br><br />
=Usage=<br />
<br />
* Call: /api/calling_cards_create '''(from MOR X7)'''<br />
* Methods: POST, GET(if allowed, not recomended)<br />
<br><br><br />
===Parameters===<br />
<br />
<br />
Parameters which are '''included''' into hash:<br />
<br />
* card_group_id - id of a Card Group '''Required'''.<br />
* cards_from - Cards' (to be created) number range beginning '''Required'''.<br />
* cards_till - Cards' (to be created) number range ending '''Required'''.<br />
<br />
'''* Note that cards_from <= cards_till. Both of the previous parameters are 10-digit-long integers.'''<br><br />
'''* Note that the parameters are shown in the same order as they need to be when generating the hash. The last parameter in a row is an API_Secret_Key.'''<br />
<br />
<br><br><br />
Parameters which are '''not included''' into hash:<br />
<br />
* '''[[MOR API hash construction | hash]]''' - SHA1 hash constructed using the '''parameters''' which are listed above. Note that the parameters are shown in the same order as they need to be when generating the hash. The last parameter in a row is '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.<br><br />
* '''u''' - username for authentication. '''Required'''.<br />
* batch_number - batch number for the Calling Cards.<br />
* min_balance - minimum balance for the Calling Cards.<br />
* distributor_id - Calling Cards' distributor's (User's) id.<br />
* language - Language for the Calling Cards.<br />
<br><br><br />
<br />
===Request===<br />
<br />
We have u = admin, API Secret Key = secret<br />
<br />
We send:<br />
<br />
HTML POST: http://<SERVER_IP>/billing/api/calling_cards_create?u=admin&card_group_id=1&cards_from=1000000025&cards_till=1000000035&batch_number=50&<br />
min_balance=15&language=en&distributor_id=2&hash=7e112ededcfee097cce21b6201c6d2a00dda1f4c<br />
<br />
* Now we can find 11 newly created Calling Cards (number range: 1000000025-1000000035) in the Card Group's (id = 1) Cards' list.'''<br><br />
'''* Note that some Calling Cards may fail on creation if a given range overlaps with already existing Cards in a Card Group.'''<br><br />
'''* Note that passing invalid optional parameters will not be notified. Default values will be used instead.'''<br><br />
'''* Note that a Username and a Password are not included into hash'''<br />
<br><br><br />
<br />
===Returns===<br />
<br />
'''Success'''<br />
<br />
<?xml version="1.0" encoding="UTF-8"?><br />
<page><br />
<status><br />
<success>Cards created: 11/11</success><br />
</status><br />
</page><br />
<br><br><br />
----<br />
<br />
'''Errors'''<br />
<br />
* <error>Access Denied</error> - User is not authorized or is a Simple User. Only Admin, Reseller or Accounant can use this API method. <br />
* <error>Incorrect hash</error> - hash is not correct. Check API_Secret_Key and order or parameters while concatenating a hash_string.<br />
* <error>You are not authorized to use this functionality</error> - User has no permissions to manage Calling Cards.<br />
* <error>Card Group was not found</error> - Card Group under a given id does not exist or a card_group_id parameter is missing from the API parameters' list.<br />
* <error>Cards from was not found</error> - required cards_from parameter is missing.<br />
* <error>Cards till was not found</error> - required cards_till parameter is missing. <br />
* <error>Cards from is in incorrect format</error> - cards_from parameter's value is not numeric or is not 10-digit-long. <br />
* <error>Cards till is in incorrect format</error> - cards_till parameter's value is not numeric or is not 10-digit-long. <br />
* <error>Cards from must not be greater than Cards till</error> - cards_from parameter's value must not be grater than cards_till parameter's value. No proper Cards' number range is possible.<br />
* <error>PIN is too short for this interval</error> - Card Group does not provide enough PIN codes for a given Cards' number range. <br />
<br />
Example:<br />
<br />
<?xml version="1.0" encoding="UTF-8"?><br />
<page><br />
<status><br />
<error>Cards from must not be greater than Cards till</error><br />
</status><br />
</page><br />
<br><br><br />
<br />
=See also=<br />
<br />
* [[MOR API]]</div>Edvinashttps://wiki.kolmisoft.com/index.php?title=MOR_API_Calling_Cards_get&diff=20306MOR API Calling Cards get2015-11-05T14:37:54Z<p>Edvinas: </p>
<hr />
<div>=Description=<br />
[[MOR API]] Returns the list of Calling Cards with respect to provided search parameters. <br />
<br><br><br />
=Usage=<br />
<br />
* Call: /api/calling_cards_get '''(from MOR X7)'''<br />
* Methods: POST, GET(if allowed, not recomended)<br />
<br><br><br />
===Parameters===<br />
<br />
* '''[[MOR API hash construction | hash]]''' - SHA1 hash constructed using the required '''parameters''' (in this case none of the parameters is required). The hash will contain only an '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.<br><br />
* '''u''' - username for authentication. '''Required'''.<br />
* number - Calling Card's number.<br />
* name - Calling Card's name<br />
* pin - Calling Card's PIN code.<br />
* batch_number - Calling Card's batch number.<br />
* min_balance - lower boundary of the Calling Card's balance range.<br />
* max_balance - upper boundary of the Calling Card's balance range.<br />
* callerid - Calling Card's CallerID for "pinless" dialing.<br />
* language - Calling Card's language.<br />
* sold - determines whether a Calling Card is sold or not (yes|no 1|0).<br />
* distributor - Calling Card's distributor's (User's) id.<br />
<br />
<br><br><br />
<br />
===Request===<br />
<br />
We have u = admin, API Secret Key = secret<br />
<br />
We send:<br />
<br />
HTML POST: http://<SERVER_IP>/billing/api/calling_cards_get?u=admin&number=1111111119&name=test_card&pin=2668&min_balance=10&max_balance=50&language=en&callerid=3&sold=0&distributor=2&hash=e5e9fa1ba31ecd1ae84f75caaa474f3a663f05f4<br />
<br />
* Now we get a search result containing the Calling Cards with the specified attributes data.<br><br />
'''* Note that a Username and a Password are not included into hash'''<br />
<br><br><br />
<br />
===Returns===<br />
<br />
'''Success'''<br />
<br />
<?xml version="1.0" encoding="UTF-8"?><br />
<page><br />
<cards><br />
<card><br />
<card_id>26</card_id><br />
<card_number>1111111119</card_number><br />
<card_name>test_card</card_name><br />
<card_pin>2668</card_pin><br />
<card_batch_number>5</card_batch_number><br />
<card_callerid>3</card_callerid><br />
<card_balance>10.0840336134454</card_balance><br />
<card_minimal_balance>20.0</card_minimal_balance><br />
<card_first_use/><br />
<card_daily_charge_paid_till>2015-11-05 02:00:00 +0200</card_daily_charge_paid_till><br />
<card_sold>0</card_sold><br />
<card_language>en</card_language><br />
<card_distributor>Test User #1</card_distributor><br />
</card><br />
</cards><br />
</page><br />
<br><br><br />
----<br />
<br />
'''Errors'''<br />
<br />
* <error>Access Denied</error> - User is not authorized or is a Simple User. Only Admin, Reseller or Accounant can use this API method. <br />
* <error>Incorrect hash</error> - hash is not correct. Check API_Secret_Key and order or parameters while concatenating a hash_string.<br />
* <error>You are not authorized to use this functionality</error> - User has no permissions to manage Calling Cards.<br />
* <error>Cards were not found</error> - no Cards were found with provided search parameters.<br />
<br />
Example:<br />
<br />
<?xml version="1.0" encoding="UTF-8"?><br />
<page><br />
<status><br />
<error>Cards were not found</error><br />
</status><br />
</page><br />
<br><br><br />
<br />
=See also=<br />
<br />
* [[MOR API]]</div>Edvinashttps://wiki.kolmisoft.com/index.php?title=MOR_API_Calling_Cards_get&diff=20305MOR API Calling Cards get2015-11-05T14:36:17Z<p>Edvinas: </p>
<hr />
<div>=Description=<br />
[[MOR API]] Returns the list of Calling Cards with respect to provided search parameters. <br />
<br><br><br />
=Usage=<br />
<br />
* Call: /api/calling_cards_get<br />
* Methods: POST, GET(if allowed, not recomended)<br />
<br><br><br />
===Parameters===<br />
<br />
* '''[[MOR API hash construction | hash]]''' - SHA1 hash constructed using the required '''parameters''' (in this case none of the parameters is required). The hash will contain only an '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.<br><br />
* '''u''' - username for authentication. '''Required'''.<br />
* number - Calling Card's number.<br />
* name - Calling Card's name<br />
* pin - Calling Card's PIN code.<br />
* batch_number - Calling Card's batch number.<br />
* min_balance - lower boundary of the Calling Card's balance range.<br />
* max_balance - upper boundary of the Calling Card's balance range.<br />
* callerid - Calling Card's CallerID for "pinless" dialing.<br />
* language - Calling Card's language.<br />
* sold - determines whether a Calling Card is sold or not (yes|no 1|0).<br />
* distributor - Calling Card's distributor's (User's) id.<br />
<br />
<br><br><br />
<br />
===Request===<br />
<br />
We have u = admin, API Secret Key = secret<br />
<br />
We send:<br />
<br />
HTML POST: http://<SERVER_IP>/billing/api/calling_cards_get?u=admin&number=1111111119&name=test_card&pin=2668&min_balance=10&max_balance=50&language=en&callerid=3&sold=0&distributor=2&hash=e5e9fa1ba31ecd1ae84f75caaa474f3a663f05f4<br />
<br />
* Now we get a search result containing the Calling Cards with the specified attributes data.<br><br />
'''* Note that a Username and a Password are not included into hash'''<br />
<br><br><br />
<br />
===Returns===<br />
<br />
'''Success'''<br />
<br />
<?xml version="1.0" encoding="UTF-8"?><br />
<page><br />
<cards><br />
<card><br />
<card_id>26</card_id><br />
<card_number>1111111119</card_number><br />
<card_name>test_card</card_name><br />
<card_pin>2668</card_pin><br />
<card_batch_number>5</card_batch_number><br />
<card_callerid>3</card_callerid><br />
<card_balance>10.0840336134454</card_balance><br />
<card_minimal_balance>20.0</card_minimal_balance><br />
<card_first_use/><br />
<card_daily_charge_paid_till>2015-11-05 02:00:00 +0200</card_daily_charge_paid_till><br />
<card_sold>0</card_sold><br />
<card_language>en</card_language><br />
<card_distributor>Test User #1</card_distributor><br />
</card><br />
</cards><br />
</page><br />
<br><br><br />
----<br />
<br />
'''Errors'''<br />
<br />
* <error>Access Denied</error> - User is not authorized or is a Simple User. Only Admin, Reseller or Accounant can use this API method. <br />
* <error>Incorrect hash</error> - hash is not correct. Check API_Secret_Key and order or parameters while concatenating a hash_string.<br />
* <error>You are not authorized to use this functionality</error> - User has no permissions to manage Calling Cards.<br />
* <error>Cards were not found</error> - no Cards were found with provided search parameters.<br />
<br />
Example:<br />
<br />
<?xml version="1.0" encoding="UTF-8"?><br />
<page><br />
<status><br />
<error>Cards were not found</error><br />
</status><br />
</page><br />
<br><br><br />
<br />
=See also=<br />
<br />
* [[MOR API]]</div>Edvinashttps://wiki.kolmisoft.com/index.php?title=MOR_API&diff=20304MOR API2015-11-05T14:33:01Z<p>Edvinas: /* Calling Cards */</p>
<hr />
<div>[[File:warning.png|100px|alt="warning"|link=]]<big><big><big>IMPORTANT!!! API methods described here are for MOR X6. For previous versions please check appropriate [http://wiki.kolmisoft.com/index.php/MOR_Manual#Old_Manuals manual].</big></big></big><br />
[[File:api.png|right|alt="api"|link=]]<br />
<mkmeta>Application Program Interface for MOR Class 5 Softswitch</mkmeta><br />
<br />
<br><br><br />
=About=<br />
MOR API lets other software interact with MOR without knowing the internal structure of the database (DB) and other logic.<br />
<br />
MOR accepts requests by HTML POST and returns results in XML.<br />
<br />
<br><br><br />
=MOR users that are allowed to use MOR API=<br />
* Admin<br />
* Reseller<br />
* Accountant - only by using Admin Hash and Secret key<br />
* Simple User<br />
<br />
<br><br><br />
<br />
=Functions=<br />
<br />
== API Related ==<br />
* [[API Configuration]] – configuration options for API.<br />
* [[MOR API hash construction|Hash construction]] – how to construct hash to authenticate data over API.<br />
<br />
<br><br />
==Balance==<br />
* [[MOR API user balance update | user_balance_update]] (change_user_balance) – changes User's Balance<br />
Various methods to retrieve User balance<br />
* [[MOR API user_balance_get|user_balance_get]] (balance) – retrieves a User Balance.<br />
* [[Balance in phone | user_simple_balance_get]] (simple_balance) – gets User's Balance<br />
* [[MOR API user balance get by psw | user_balance_get_by_psw]] – gets User's Balance by his owned Device's Password<br />
* [[MOR API User Balance get by Username | user_balance_get_by_username]] – gets User's Balance by his owned Device's Username<br />
<br />
<br><br />
<br />
==Callback==<br />
* [[MOR API callback init|callback_init]] (callback) – initiates callback.<br />
<br />
<br><br />
==Calling Cards==<br />
* [[MOR API card_by_cli_update| card_by_cli_update]] (cc_by_cli) – creates and updates calling cards, including adding and transferring funds, by being identified according the Caller_ID.<br />
* [[MOR API card_from_group_sell| card_from_group_sell]] (buy_card_from_callingroup) – sells cards from calling card group.<br />
* [[MOR API card_group_get| card_group_get]] (show_calling_card_group) – show calling group info.<br />
* [[MOR API card_balance_get| card_balance_get]] (card_balance_get) – show card's balance.<br />
* [[MOR API card_payment_add| card_payment_add]] – add payment to the calling card.<br />
* [[MOR_API_Calling_Cards_create| calling_cards_create]] – create Calling Cards.<br />
* [[MOR_API_cc_groups_get| cc_groups_get]] – show Calling Cards Group info.<br />
* [[MOR_API_Calling_Card_update| calling_card_update]] – update Calling Card.<br />
* [[MOR_API_Card_Group_create| cc_group_create]] – create Card Group.<br />
* [[MOR_API_Calling_Cards_get| calling_cards_get]] - get Calling Cards.<br />
<br><br />
<br />
==Calls==<br />
* [[MOR API user calls get|user_calls_get]] (user_calls) – retrieves a list of calls in a selected time period for a user/device.<br />
<br />
<br><br />
<br />
==Conflines==<br />
* [[MOR API conflines update|conflines_update]] – changes settings for API, Default User or Default Device.<br />
<br />
<br><br />
==Credit notes==<br />
* [[MOR API credit_notes_get| credit_notes_get]] (credit_notes) – credit notes list.<br />
* [[MOR API credit_note_update| credit_note_update]] – credit note update.<br />
* [[MOR API credit_notes_create| credit_note_create]] – credit note create.<br />
* [[MOR API credit_notes_delete| credit_note_delete]] – credit note delete.<br />
<br />
<br><br />
==Device==<br />
* [[MOR API device create| device_create]] – create device<br />
* [[MOR API device delete| device_delete]] (delete_device) – delete device<br />
* [[MOR API devices get | devices_get]] (device_list) – users device list<br />
* [[MOR API device callflow get| device_callflow_get]] - returns information about specified device callflow state.<br />
* [[MOR API device callflow update | device_callflow_update]] – updates information of specified device callflow state. <br />
* [[MOR API CLI info get | cli_info_get]] (cli_get_info) – shows id of device where CLI belongs.<br />
* [[MOR API CLI delete | cli_delete]] – deletes specified CLI. <br />
* [[MOR API CLI add | cli_add]] – creates CLI and assigns it to the specified device.<br />
* [[MOR API device clis get | device_clis_get]] – CLIs list by User and/or Device<br />
* [[MOR API device details get | device_details_get]] – shows all information about specified device.<br />
* [[MOR_API_device_update | device_update]] – updates location_id of selected Device.<br />
<br />
<br><br />
<br />
==DID==<br />
<br />
* [[MOR API dids get| dids_get]] – get list of particular DIDs<br />
* [[MOR API did_create| did_create]] – DID create<br />
* [[MOR_API_did_device_assign| did_device_assign]] (did_assign_device) – Assign Device to DID<br />
* [[MOR_API_did_device_unassign| did_device_unassign]] (did_unassign_device) – Unassign Device from DID<br />
* [[MOR_API_did_details_update| did_details_update]] (did_details_update) – Update DID details <br />
* [[MOR API did subscription stop|did_subscription_stop]] – STOP DID subscription<br />
<br />
<br><br />
<br />
==Email==<br />
* [[MOR API email send| email_send]] (send_email) – send Email.<br />
<br />
<br><br />
==Financial statements==<br />
* [[MOR API financial_statements_get| financial_statements_get]] (financial_statements) – financial statements list.<br />
<br />
<br><br />
==Invoices==<br />
* [[MOR API invoices_get|invoices_get]] (invoices) – retrieves a list of invoices in a selected time period.<br />
<br />
<br><br />
==Login==<br />
* [[MOR API user_login|user_login]] (login) – logs user in to MOR.<br />
* [[MOR API user_logout|user_logout]] (logout) – logs user out from MOR.<br />
<br />
<br><br />
==Monitorings==<br />
* [[MOR API ma_activate_api| ma_activate]] – turn on monitorings addon<br />
<br />
<br><br />
==Payments==<br />
* [[MOR API payment_create| payment_create]] (create_payment) – create payment.<br />
* [[MOR API payments_get| payments_get]] (payments_list) – payments list.<br />
<br />
<br><br />
==Phonebooks==<br />
* [[MOR API phonebooks_get| phonebooks_get]] (phonebooks_api ) – phonebooks list.<br />
* [[MOR API phonebook_edit| phonebook_edit]] (phonebook_edit_api) – edit phonebook.<br />
* [[MOR API phonebook_record_create| phonebook_record_create]] – create phonebook.<br />
<br />
<br><br />
==Quickforwards==<br />
* [[MOR API Quickforwards get| quickforwards_dids_get]] (quickforwards_dids_get) – get Quickforwards.<br />
* [[MOR API Quickforwards update| quickforwards_did_update]] (quickforwards_did_update) – update Quickforwards.<br />
* [[MOR API Quickforwards delete| quickforwards_did_delete]] (quickforwards_did_delete) – delete Quickforwards.<br />
<br />
<br><br />
==Rates==<br />
* [[MOR API rate get|rate_get]] (rate) – check user rate by prefix<br />
* [[MOR API tariff rates get| tariff_rates_get]] (get_tariff) – get all tariff's rates<br />
* [[MOR API tariff_retail_import | tariff_retail_import ]] (import_relail_tariff) – import xml retail tariff<br />
* [[MOR API tariff_wholesale_update | tariff_wholesale_update ]] (wholesale_tariff) – update or create wholesale tariff<br />
<br />
<br><br />
==Services==<br />
* [[MOR API Service create| service_create]] – create Service.<br />
* [[MOR API Service delete| service_delete]] – delete Service.<br />
* [[MOR API Services get| services_get]] – get Services.<br />
* [[MOR API Service update| service_update]] – update Service.<br />
<br />
<br><br />
<br />
==SMS==<br />
* [[MOR API sms send| sms_send]] (send_sms) – send SMS.<br />
* [[MOR_API_user_sms_service_subscribe | user_sms_service_subscribe ]] – User subscription to SMS Service.<br />
<br />
<br><br />
==Subscriptions==<br />
* [[MOR API subscription delete|subscription_delete]] - Subscription delete.<br />
* [[MOR API Subscriptions get|subscriptions_get]] - Subscriptions get.<br />
* [[MOR API subscription create|subscription_create]] - Subscription create.<br />
* [[MOR API subscription update|subscription_update]] - Subscription delete.<br />
<br><br />
<br />
==User==<br />
<br />
* [[MOR API user_register| user_register]] – create new user from params.<br />
* [[MOR API user_details_get | user_details_get]] (user_details) – gets user details.<br />
* [[MOR_API_user_details_update| user_details_update]] (user_update_api) – update user from params.<br />
<br><br />
<br />
== Resellers ==<br />
* [[MOR API reseller group create]] - create new Reseller Group<br />
<br />
<br><br />
==Version==<br />
* [[MOR API system version get| system_version_get]] (get_version) – get MOR version number.<br />
<br />
<br><br />
= Examples =<br />
* [[MOR API PHP Examples]]<br />
<br />
<br><br><br />
=HTML POST=<br />
All requests are in a similar format:<br />
<br />
HTML POST: http://<SERVER_IP>/billing/api/<function>?u=username<br />
<br />
* username - the user name and password of the user who is asking for the data. <br />
<br />
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.<br />
<br><br><br />
=Useful to know=<br />
<br />
* 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:<br />
** Value of money will be returned in Default System [[Currencies|Currency]].<br />
** Date will not be affected of [[Configuration_from_GUI#Visual| Default date format]] setting.<br />
** Value of money will not be affected of [[Configuration_from_GUI#Visual|Number digits]] setting.<br />
<br />
<br><br><br />
=See also =<br />
* [[API Configuration]]<br />
* [[MOR integration]]<br />
* [[How to block access to some API functions]]<br />
* [[API specification to be implemented in the future]]</div>Edvinashttps://wiki.kolmisoft.com/index.php?title=MOR_API_Calling_Cards_get&diff=20303MOR API Calling Cards get2015-11-05T14:30:11Z<p>Edvinas: </p>
<hr />
<div>=Description=<br />
[[MOR API]] Returns the list of Calling Cards with respect to provided search parameters. <br />
<br><br><br />
=Usage=<br />
<br />
* Call: /api/calling_cards_get<br />
* Methods: POST, GET(if allowed, not recomended)<br />
<br><br><br />
===Parameters===<br />
<br />
* '''[[MOR API hash construction | hash]]''' - SHA1 hash constructed using the required '''parameters''' (in this case none of the parameters is required). The hash will contain only an '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.<br><br />
* '''u''' - username for authentication. '''Required'''.<br />
* number - Calling Card's number.<br />
* name - Calling Card's name<br />
* pin - Calling Card's PIN code.<br />
* batch_number - Calling Card's batch number.<br />
* min_balance - lower boundary of the Calling Card's balance range.<br />
* max_balance - upper boundary of the Calling Card's balance range.<br />
* callerid - Calling Card's CallerID for "pinless" dialing.<br />
* language - Calling Card's language.<br />
* sold - determines whether a Calling Card is sold or not (yes|no 1|0).<br />
* distributor - Calling Card's distributor's (User's) id.<br />
<br />
<br><br><br />
<br />
===Request===<br />
<br />
We have u = admin, API Secret Key = secret<br />
<br />
We send:<br />
<br />
HTML POST: http://<SERVER_IP>/billing/api/calling_cards_get?u=admin&number=1111111119&name=test_card&pin=2668&min_balance=10&max_balance=50&language=en&callerid=3&sold=0&distributor=2&hash=e5e9fa1ba31ecd1ae84f75caaa474f3a663f05f4<br />
<br />
* Now we get a search result containing the Calling Card's with the specified attributes data.<br><br />
'''* Note that a Username and a Password are not included into hash'''<br />
<br><br><br />
<br />
===Returns===<br />
<br />
'''Success'''<br />
<br />
<?xml version="1.0" encoding="UTF-8"?><br />
<page><br />
<cards><br />
<card><br />
<card_id>26</card_id><br />
<card_number>1111111119</card_number><br />
<card_name>test_card</card_name><br />
<card_pin>2668</card_pin><br />
<card_batch_number>5</card_batch_number><br />
<card_callerid>3</card_callerid><br />
<card_balance>10.0840336134454</card_balance><br />
<card_minimal_balance>20.0</card_minimal_balance><br />
<card_first_use/><br />
<card_daily_charge_paid_till>2015-11-05 02:00:00 +0200</card_daily_charge_paid_till><br />
<card_sold>0</card_sold><br />
<card_language>en</card_language><br />
<card_distributor>Test User #1</card_distributor><br />
</card><br />
</cards><br />
</page><br />
<br><br><br />
----<br />
<br />
'''Errors'''<br />
<br />
* <error>Access Denied</error> - User is not authorized or is a Simple User. Only Admin, Reseller or Accounant can use this API method. <br />
* <error>Incorrect hash</error> - hash is not correct. Check API_Secret_Key and order or parameters while concatenating a hash_string.<br />
* <error>You are not authorized to use this functionality</error> - User has no permissions to manage Calling Cards.<br />
* <error>Cards were not found</error> - no Cards were found with provided search parameters.<br />
<br />
Example:<br />
<br />
<?xml version="1.0" encoding="UTF-8"?><br />
<page><br />
<status><br />
<error>Cards were not found</error><br />
</status><br />
</page><br />
<br><br><br />
<br />
=See also=<br />
<br />
* [[MOR API]]</div>Edvinashttps://wiki.kolmisoft.com/index.php?title=MOR_API_Calling_Cards_get&diff=20302MOR API Calling Cards get2015-11-05T14:06:31Z<p>Edvinas: Created page with '=Description= MOR API Returns the list of Calling Cards with respect to provided search parameters. <br><br> =Usage= * Call: /api/calling_cards_get * Methods: POST, GET(if …'</p>
<hr />
<div>=Description=<br />
[[MOR API]] Returns the list of Calling Cards with respect to provided search parameters. <br />
<br><br><br />
=Usage=<br />
<br />
* Call: /api/calling_cards_get<br />
* Methods: POST, GET(if allowed, not recomended)<br />
<br><br><br />
===Parameters===<br />
<br />
* '''[[MOR API hash construction | hash]]''' - SHA1 hash constructed using the '''parameters''' which are listed above. Note that the parameters are shown in the same order as they need to be when generating the hash. The last parameter in a row is '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.<br><br />
* '''u''' - username for authentication. '''Required'''.<br />
* number - Calling Card's number.<br />
* name - Calling Card's name<br />
* pin - Calling Card's PIN code.<br />
* batch_number - Calling Card's batch number.<br />
* min_balance - lower boundary of the Calling Card's balance range.<br />
* max_balance - upper boundary of the Calling Card's balance range.<br />
* callerid - Calling Card's CallerID for "pinless" dialing.<br />
* language - Calling Card's language.<br />
* sold - Determines whether a Calling Card is sold or not (yes|no 1|0).<br />
* distributor - Calling Cards' distributor's (User's) id.<br />
<br />
<br><br><br />
<br />
===Request===<br />
<br />
We have u = admin, API Secret Key = secret<br />
<br />
We send:<br />
<br />
HTML POST: http://<SERVER_IP>/billing/api/calling_cards_get?u=admin&number=1111111119&name=test_card&pin=2668&min_balance=10&max_balance=50&language=en&callerid=3&sold=0&distributor=2&hash=e5e9fa1ba31ecd1ae84f75caaa474f3a663f05f4<br />
<br />
* Now we get a search result containing the Calling Card's with the specified attributes data.<br><br />
'''* Note that a Username and a Password are not included into hash'''<br />
<br><br><br />
<br />
===Returns===<br />
<br />
'''Success'''<br />
<br />
<?xml version="1.0" encoding="UTF-8"?><br />
<page><br />
<cards><br />
<card><br />
<card_id>26</card_id><br />
<card_number>1111111119</card_number><br />
<card_name>test_card</card_name><br />
<card_pin>2668</card_pin><br />
<card_batch_number>5</card_batch_number><br />
<card_callerid>3</card_callerid><br />
<card_balance>10.0840336134454</card_balance><br />
<card_minimal_balance>20.0</card_minimal_balance><br />
<card_first_use/><br />
<card_daily_charge_paid_till>2015-11-05 02:00:00 +0200</card_daily_charge_paid_till><br />
<card_sold>0</card_sold><br />
<card_language>en</card_language><br />
<card_distributor>Test User #1</card_distributor><br />
</card><br />
</cards><br />
</page><br />
<br><br><br />
----<br />
<br />
'''Errors'''<br />
<br />
* <error>Access Denied</error> - User is not authorized or is a Simple User. Only Admin, Reseller or Accounant can use this API method. <br />
* <error>Incorrect hash</error> - hash is not correct. Check API_Secret_Key and order or parameters while concatenating a hash_string.<br />
* <error>You are not authorized to use this functionality</error> - User has no permissions to manage Calling Cards.<br />
* <error>Card Group was not found</error> - Card Group under a given id does not exist or a card_group_id parameter is missing from the API parameters' list.<br />
* <error>Cards from was not found</error> - required cards_from parameter is missing.<br />
* <error>Cards till was not found</error> - required cards_till parameter is missing. <br />
* <error>Cards from is in incorrect format</error> - cards_from parameter's value is not numeric or is not 10-digit-long. <br />
* <error>Cards till is in incorrect format</error> - cards_till parameter's value is not numeric or is not 10-digit-long. <br />
* <error>Cards from must not be greater than Cards till</error> - cards_from parameter's value must not be grater than cards_till parameter's value. No proper Cards' number range is possible.<br />
* <error>PIN is too short for this interval</error> - Card Group does not provide enough PIN codes for a given Cards' number range. <br />
<br />
Example:<br />
<br />
<?xml version="1.0" encoding="UTF-8"?><br />
<page><br />
<status><br />
<error>Cards from must not be greater than Cards till</error><br />
</status><br />
</page><br />
<br><br><br />
<br />
=See also=<br />
<br />
* [[MOR API]]</div>Edvinashttps://wiki.kolmisoft.com/index.php?title=MOR_API_Card_Groups_get&diff=20301MOR API Card Groups get2015-11-05T13:55:13Z<p>Edvinas: /* Request */</p>
<hr />
<div>= NOTE: Available from MOR X7 =<br />
<br />
=Description=<br />
[[MOR API]] Calling Cards Groups get<br />
<br><br><br />
=Usage=<br />
<br />
* From '''MOR X7''' Calling Cards Groups: '''/api/cc_groups_get'''<br />
* Methods: POST, GET(if allowed, not recomended)<br />
<br><br><br />
===Parametres===<br />
<br />
* u - username for authentication.<br />
* cc_group_id - Calling Cards Group ID.<br />
* [[MOR API hash construction | hash]] - SHA1 hash constructed using '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.<br />
<br><br><br />
<br />
===Request===<br />
<br />
We have: API Secret Key = secret<br />
<br />
We send:<br />
HTML POST: http://<SERVER_IP>/billing/api/cc_groups_get?u=admin&cc_group_id=1&hash=e5e9fa1ba31ecd1ae84f75caaa474f3a663f05f4<br />
'''NOTE that username is not included in hash'''<br />
<br><br><br />
<br />
'''Success'''<br />
<br />
<page><br />
<cc_groups><br />
<cc_group><br />
<group_id>1</group_id><br />
<group_image>example.jpg</group_image><br />
<group_name>Test_cardgroup</group_name><br />
<group_description>Test_cardgroup description</group_description><br />
<group_number_pin_length>10/4</group_number_pin_length><br />
<group_tarrif>Test Tariff for Users</group_tarrif><br />
<group_lcr>Primary</group_lcr><br />
<group_price>10.0840</group_price><br />
<group_price_without_tax>10.0840</group_price_without_tax><br />
<group_cards_count>21</group_cards_count><br />
</cc_group><br />
</cc_groups><br />
</page><br />
<br><br><br />
----<br />
<br />
'''Errors'''<br />
* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string. <br />
* <error>You are not authorized to use this functionality</error> - User does not have rights to manage Calling Cards.<br />
* <error>Access Denied</error> - User does not have access to Calling Cards.<br />
* <error>Wrong calling cards group ID</error> - User supplied wrong Calling Cards group ID.<br />
* <error>Calling cards groups were not found</error> - Calling cards groups were not found.<br />
<br><br><br />
<br />
=See also=<br />
<br />
* [[MOR API]]</div>Edvinashttps://wiki.kolmisoft.com/index.php?title=MOR_API_Calling_Card_update&diff=20300MOR API Calling Card update2015-11-05T13:53:52Z<p>Edvinas: /* Request */</p>
<hr />
<div>= NOTE: Available from MOR X7 =<br />
<br />
=Description=<br />
[[MOR API]] Calling Card update<br />
<br><br><br />
=Usage=<br />
<br />
* From '''MOR X7''' Calling Card: '''/api/calling_card_update'''<br />
* Methods: POST, GET(if allowed, not recomended)<br />
<br><br><br />
===Parametres===<br />
<br />
* u - username for authentication.<br />
* card_id - Calling Card ID. '''Required'''.<br />
* number - Number for the Calling Card.<br />
* name - Card name for the Calling Card.<br />
* pin - PIN code for the Calling Card.<br />
* batch_number - Batch number for the Calling Card.<br />
* callerid - Caller ID for the Calling Card.<br />
* min_balance - Minimum balance for the Calling Card.<br />
* daily_charge_paid_till - Timestamp of daily charge paid.<br />
* language - Language for the Calling Card. <br />
* distributor - Calling Card distributor (User) id.<br />
<br />
* [[MOR API hash construction | hash]] - SHA1 hash constructed using '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.<br />
<br><br><br />
<br />
===Request===<br />
<br />
We have: API Secret Key = secret, card_id = 1, number = 4673451679, name = card, pin = 7468, batch_number = 5456484, callerid = 2, min_balance = 5, daily_charge_paid_till = 1446721871, language = en, distributor = 2<br />
<br />
We send:<br />
HTML POST: http://<SERVER_IP>/billing/api/calling_card_update?u=admin&card_id=1&number=4673451679&name=card&pin=7468&batch_number=5456484&callerid=2&min_balance=5&daily_charge_paid_till=1446721871&language=en&distributor=2&hash=bc2f114099d16656d37e45fd9e8744cb9386d462<br />
'''NOTE that username is not included in hash'''<br />
<br><br><br />
<br />
'''Success'''<br />
<br />
<page><br />
<success>Calling Card successfully updated</success><br />
</page><br />
<br><br><br />
----<br />
<br />
'''Errors'''<br />
* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string. <br />
* <error>You are not authorized to use this functionality</error> - User does not have rights to manage Calling Cards.<br />
* <error>Access Denied</error> - User does not have access to Calling Cards.<br />
* <error>Wrong Calling Card ID</error> - User supplied wrong Calling Card ID.<br />
* <error>Calling Card not found</error> - Calling card was not found.<br />
<br><br><br />
<br />
=See also=<br />
<br />
* [[MOR API]]</div>Edvinashttps://wiki.kolmisoft.com/index.php?title=MOR_API_Calling_Card_update&diff=20299MOR API Calling Card update2015-11-05T13:51:30Z<p>Edvinas: /* Request */</p>
<hr />
<div>= NOTE: Available from MOR X7 =<br />
<br />
=Description=<br />
[[MOR API]] Calling Card update<br />
<br><br><br />
=Usage=<br />
<br />
* From '''MOR X7''' Calling Card: '''/api/calling_card_update'''<br />
* Methods: POST, GET(if allowed, not recomended)<br />
<br><br><br />
===Parametres===<br />
<br />
* u - username for authentication.<br />
* card_id - Calling Card ID. '''Required'''.<br />
* number - Number for the Calling Card.<br />
* name - Card name for the Calling Card.<br />
* pin - PIN code for the Calling Card.<br />
* batch_number - Batch number for the Calling Card.<br />
* callerid - Caller ID for the Calling Card.<br />
* min_balance - Minimum balance for the Calling Card.<br />
* daily_charge_paid_till - Timestamp of daily charge paid.<br />
* language - Language for the Calling Card. <br />
* distributor - Calling Card distributor (User) id.<br />
<br />
* [[MOR API hash construction | hash]] - SHA1 hash constructed using '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.<br />
<br><br><br />
<br />
===Request===<br />
<br />
We have: API Secret Key = secret, card_id = 1, number = 4673451679, name = card, pin = 7468, batch_number = 5456484, callerid = 2, min_balance = 5, daily_charge_paid_till = 1446721871, language = en, distributor = 2<br />
<br />
We send:<br />
HTML POST: http://<SERVER_IP>/billing/api/calling_card_update?u=admin&card_id=1&number=4673451679&name=card&pin=7468&batch_number=5456484&callerid=2&min_balance=5&daily_charge_paid_till=1446721871&language=en&distributor=2&hash=bc2f114099d16656d37e45fd9e8744cb9386d462<br />
'''NOTE that username is not included in hash'''<br />
<br><br><br />
<br />
'''Success'''<br />
<br />
<page><br />
<success>Calling Card successfully updated</success><br />
</page><br />
<br><br><br />
----<br />
<br />
'''Errors'''<br />
* <error>Bad login</error> - User supplied bad login.<br />
* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string. <br />
* <error>You are not authorized to use this functionality</error> - User does not have rights to manage Calling Cards.<br />
* <error>Access Denied</error> - User does not have access to Calling Cards.<br />
* <error>Wrong Calling Card ID</error> - User supplied wrong Calling Card ID.<br />
* <error>Calling Card not found</error> - Calling card was not found.<br />
<br><br><br />
<br />
=See also=<br />
<br />
* [[MOR API]]</div>Edvinashttps://wiki.kolmisoft.com/index.php?title=MOR_API_Calling_Cards_create&diff=20298MOR API Calling Cards create2015-11-05T12:00:01Z<p>Edvinas: </p>
<hr />
<div>=Description=<br />
[[MOR API]] Calling Cards create<br />
<br><br><br />
=Usage=<br />
<br />
* Call: /api/calling_cards_create<br />
* Methods: POST, GET(if allowed, not recomended)<br />
<br><br><br />
===Parameters===<br />
<br />
<br />
Parameters which are '''included''' into hash:<br />
<br />
* card_group_id - id of a Card Group '''Required'''.<br />
* cards_from - Cards' (to be created) number range beginning '''Required'''.<br />
* cards_till - Cards' (to be created) number range ending '''Required'''.<br />
<br />
'''* Note that cards_from <= cards_till. Both of the previous parameters are 10-digit-long integers.'''<br><br />
'''* Note that the parameters are shown in the same order as they need to be when generating the hash. The last parameter in a row is an API_Secret_Key.'''<br />
<br />
<br><br><br />
Parameters which are '''not included''' into hash:<br />
<br />
* '''[[MOR API hash construction | hash]]''' - SHA1 hash constructed using the '''parameters''' which are listed above. Note that the parameters are shown in the same order as they need to be when generating the hash. The last parameter in a row is '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.<br><br />
* '''u''' - username for authentication. '''Required'''.<br />
* batch_number - batch number for the Calling Cards.<br />
* min_balance - minimum balance for the Calling Cards.<br />
* distributor_id - Calling Cards' distributor's (User's) id.<br />
* language - Language for the Calling Cards.<br />
<br><br><br />
<br />
===Request===<br />
<br />
We have u = admin, API Secret Key = secret<br />
<br />
We send:<br />
<br />
HTML POST: http://<SERVER_IP>/billing/api/calling_cards_create?u=admin&card_group_id=1&cards_from=1000000025&cards_till=1000000035&batch_number=50&<br />
min_balance=15&language=en&distributor_id=2&hash=7e112ededcfee097cce21b6201c6d2a00dda1f4c<br />
<br />
* Now we can find 11 newly created Calling Cards (number range: 1000000025-1000000035) in the Card Group's (id = 1) Cards' list.'''<br><br />
'''* Note that some Calling Cards may fail on creation if a given range overlaps with already existing Cards in a Card Group.'''<br><br />
'''* Note that passing invalid optional parameters will not be notified. Default values will be used instead.'''<br><br />
'''* Note that a Username and a Password are not included into hash'''<br />
<br><br><br />
<br />
===Returns===<br />
<br />
'''Success'''<br />
<br />
<?xml version="1.0" encoding="UTF-8"?><br />
<page><br />
<status><br />
<success>Cards created: 11/11</success><br />
</status><br />
</page><br />
<br><br><br />
----<br />
<br />
'''Errors'''<br />
<br />
* <error>Access Denied</error> - User is not authorized or is a Simple User. Only Admin, Reseller or Accounant can use this API method. <br />
* <error>Incorrect hash</error> - hash is not correct. Check API_Secret_Key and order or parameters while concatenating a hash_string.<br />
* <error>You are not authorized to use this functionality</error> - User has no permissions to manage Calling Cards.<br />
* <error>Card Group was not found</error> - Card Group under a given id does not exist or a card_group_id parameter is missing from the API parameters' list.<br />
* <error>Cards from was not found</error> - required cards_from parameter is missing.<br />
* <error>Cards till was not found</error> - required cards_till parameter is missing. <br />
* <error>Cards from is in incorrect format</error> - cards_from parameter's value is not numeric or is not 10-digit-long. <br />
* <error>Cards till is in incorrect format</error> - cards_till parameter's value is not numeric or is not 10-digit-long. <br />
* <error>Cards from must not be greater than Cards till</error> - cards_from parameter's value must not be grater than cards_till parameter's value. No proper Cards' number range is possible.<br />
* <error>PIN is too short for this interval</error> - Card Group does not provide enough PIN codes for a given Cards' number range. <br />
<br />
Example:<br />
<br />
<?xml version="1.0" encoding="UTF-8"?><br />
<page><br />
<status><br />
<error>Cards from must not be greater than Cards till</error><br />
</status><br />
</page><br />
<br><br><br />
<br />
=See also=<br />
<br />
* [[MOR API]]</div>Edvinashttps://wiki.kolmisoft.com/index.php?title=MOR_API_Card_Group_create&diff=20297MOR API Card Group create2015-11-05T11:46:55Z<p>Edvinas: </p>
<hr />
<div>=Description=<br />
[[MOR API]] Card Group create<br />
<br><br><br />
=Usage=<br />
<br />
* From '''MOR X7''' Calling Card: '''/api/cc_group_create'''<br />
* Methods: POST, GET(if allowed, not recomended)<br />
<br><br><br />
===Parameters===<br />
<br />
Parameters which are '''included''' into hash:<br />
<br />
* name - name of a Card Group '''Required'''.<br />
<br />
<br><br><br />
Parameters which are '''not included''' into hash:<br />
<br />
* '''[[MOR API hash construction | hash]]''' - SHA1 hash constructed using the '''parameters''' which are listed above. Note that the parameters are shown in the same order as they need to be when generating the hash. The last parameter in a row is '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.<br><br />
* '''u''' - username for authentication. '''Required'''.<br />
* '''description''' - description for Card Group.<br />
* '''price_with_vat''' - price with TAX for Card Group.<br />
* '''setup_fee''' - setup fee for Card Group.<br />
* '''ghost_min_perc''' - ghost min percent for Card Group.<br />
* '''daily_charge''' - daily charge for Card Group.<br />
* '''tariff_id''' - Card Group tariff id.<br />
* '''lcr_id''' - Card Group lcr id.<br />
* '''date_from''' - Card Group valid from date.<br />
* '''date_till''' - Card Group valid till date.<br />
* '''number_length''' - Card Group number length.<br />
* '''pin_length''' - Card Group pin length.<br />
* '''dialplan_id''' - Card Group dial plan id.<br />
* '''location_id''' - Card Group location id.<br />
* '''tax_id''' - Card Group tax id.<br />
* '''valid_after_first_use''' - number of days, after which Card Group gets valid.<br />
* '''ghost_balance_perc''' - Card Group ghost balance percent.<br />
* '''use_external_function''' - enable or disable use of external script;<br />
* '''allow_loss_calls''' - Allow Loss Calls for Card Group.<br />
* '''tell_cents''' - tell cents for Card Group.<br />
* '''tell_balance_in_currency''' - Card Group Balance/Rate Currency.<br />
* '''solo_pinless''' - enable or disable solo pinless.<br />
* '''disable_voucher''' - enable or disable voucher.<br />
* '''hidden''' - enable or disable hidden status.<br />
* '''callerid_leave''' - enable or disable caller id leave.<br />
<br><br><br />
<br />
===Request===<br />
<br />
We have u = admin, API Secret Key = secret<br />
We send:<br />
<br />
HTML POST: http://<SERVER_IP>/billing/api/cc_group_create?u=admin&name=card_group_test&hash=7e112ededcfee097cce21b6201c6d2a00dda1f4c<br />
<br />
* Now we can find 1 newly created Card Group.'''<br><br />
'''* Note that if not passing optional parameters, default values will be used.'''<br />
'''* Note that a Username and a Password are not included into hash'''<br />
<br><br><br />
===Returns===<br />
<br />
'''Success'''<br />
<br />
<?xml version="1.0" encoding="UTF-8"?><br />
<page><br />
<status><br />
<success>Card Group was successfully created</success><br />
</status><br />
</page><br />
<br><br><br />
----<br />
<br />
'''Errors'''<br />
<br />
* <error>Access Denied</error> - User is not authorized or is a Simple User. Only Admin, Reseller or Accounant can use this API method. <br />
* <error>Incorrect hash</error> - hash is not correct. Check API_Secret_Key and order or parameters while concatenating a hash_string.<br />
* <error>You are not authorized to use this functionality</error> - User has no permissions to manage Calling Cards. <br />
* <error>Bad login</error> - User is not authorized (possibly wrong Username). <br />
* <error>Card Group must have name</error> - Card Group name is not given. Name is requered parameter.<br />
* <error>Invalid use external function parameter, should be: 0 or 1</error> - use external script parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Invalid allow loss calls parameter, should be: 0 or 1</error> - allow loss calls parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Invalid tell cents parameter, should be: 0 or 1</error> - tell cents parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Invalid solo pinless parameter, should be: 0 or 1</error> - solo pinless parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Invalid disable voucher parameter, should be: 0 or 1</error> - voucher parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Invalid hidden parameter, should be: 0 or 1</error> - hidden parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Invalid callerid leave parameter, should be: 0 or 1</error> - caller id leave parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Invalid date from</error> - unix time stamp date not correct.<br />
* <error>Invalid date till</error> - unix time stamp date not correct.<br />
* <error>Date from is greater than date till</error> - valid from is greater than valid till.<br />
* <error>Invalid Tariff id</error> - Tariff id is not correct. There is no such Tariff.<br />
* <error>Invalid Lcr id</error> - Lcr id is not correct. There is no such Lcr.<br />
* <error>Invalid Dialplan id</error> - Dialplan id is not correct. There is no such Dialplan.<br />
* <error>Invalid Location id</error> - Location id is not correct. There is no such Location.<br />
* <error>Invalid Currency</error> - Currency id is not correct. There is no such Currency.<br />
* <error>Invalid Price with TAX</error> - price is not correct, can not be negative.<br />
<br />
Example:<br />
<br />
<?xml version="1.0" encoding="UTF-8"?><br />
<page><br />
<status><br />
<error>Invalid solo pinless parameter, should be: 0 or 1</error><br />
</status><br />
</page><br />
<br><br><br />
<br />
=See also=<br />
<br />
* [[MOR API]]</div>Edvinashttps://wiki.kolmisoft.com/index.php?title=MOR_API_Card_Group_create&diff=20296MOR API Card Group create2015-11-05T11:46:23Z<p>Edvinas: </p>
<hr />
<div>=Description=<br />
[[MOR API]] Card Group create<br />
<br><br><br />
=Usage=<br />
<br />
* From MOR X7 Calling Card: /api/cc_group_create<br />
* Methods: POST, GET(if allowed, not recomended)<br />
<br><br><br />
===Parameters===<br />
<br />
Parameters which are '''included''' into hash:<br />
<br />
* name - name of a Card Group '''Required'''.<br />
<br />
<br><br><br />
Parameters which are '''not included''' into hash:<br />
<br />
* '''[[MOR API hash construction | hash]]''' - SHA1 hash constructed using the '''parameters''' which are listed above. Note that the parameters are shown in the same order as they need to be when generating the hash. The last parameter in a row is '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.<br><br />
* '''u''' - username for authentication. '''Required'''.<br />
* '''description''' - description for Card Group.<br />
* '''price_with_vat''' - price with TAX for Card Group.<br />
* '''setup_fee''' - setup fee for Card Group.<br />
* '''ghost_min_perc''' - ghost min percent for Card Group.<br />
* '''daily_charge''' - daily charge for Card Group.<br />
* '''tariff_id''' - Card Group tariff id.<br />
* '''lcr_id''' - Card Group lcr id.<br />
* '''date_from''' - Card Group valid from date.<br />
* '''date_till''' - Card Group valid till date.<br />
* '''number_length''' - Card Group number length.<br />
* '''pin_length''' - Card Group pin length.<br />
* '''dialplan_id''' - Card Group dial plan id.<br />
* '''location_id''' - Card Group location id.<br />
* '''tax_id''' - Card Group tax id.<br />
* '''valid_after_first_use''' - number of days, after which Card Group gets valid.<br />
* '''ghost_balance_perc''' - Card Group ghost balance percent.<br />
* '''use_external_function''' - enable or disable use of external script;<br />
* '''allow_loss_calls''' - Allow Loss Calls for Card Group.<br />
* '''tell_cents''' - tell cents for Card Group.<br />
* '''tell_balance_in_currency''' - Card Group Balance/Rate Currency.<br />
* '''solo_pinless''' - enable or disable solo pinless.<br />
* '''disable_voucher''' - enable or disable voucher.<br />
* '''hidden''' - enable or disable hidden status.<br />
* '''callerid_leave''' - enable or disable caller id leave.<br />
<br><br><br />
<br />
===Request===<br />
<br />
We have u = admin, API Secret Key = secret<br />
We send:<br />
<br />
HTML POST: http://<SERVER_IP>/billing/api/cc_group_create?u=admin&name=card_group_test&hash=7e112ededcfee097cce21b6201c6d2a00dda1f4c<br />
<br />
* Now we can find 1 newly created Card Group.'''<br><br />
'''* Note that if not passing optional parameters, default values will be used.'''<br />
'''* Note that a Username and a Password are not included into hash'''<br />
<br><br><br />
===Returns===<br />
<br />
'''Success'''<br />
<br />
<?xml version="1.0" encoding="UTF-8"?><br />
<page><br />
<status><br />
<success>Card Group was successfully created</success><br />
</status><br />
</page><br />
<br><br><br />
----<br />
<br />
'''Errors'''<br />
<br />
* <error>Access Denied</error> - User is not authorized or is a Simple User. Only Admin, Reseller or Accounant can use this API method. <br />
* <error>Incorrect hash</error> - hash is not correct. Check API_Secret_Key and order or parameters while concatenating a hash_string.<br />
* <error>You are not authorized to use this functionality</error> - User has no permissions to manage Calling Cards. <br />
* <error>Bad login</error> - User is not authorized (possibly wrong Username). <br />
* <error>Card Group must have name</error> - Card Group name is not given. Name is requered parameter.<br />
* <error>Invalid use external function parameter, should be: 0 or 1</error> - use external script parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Invalid allow loss calls parameter, should be: 0 or 1</error> - allow loss calls parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Invalid tell cents parameter, should be: 0 or 1</error> - tell cents parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Invalid solo pinless parameter, should be: 0 or 1</error> - solo pinless parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Invalid disable voucher parameter, should be: 0 or 1</error> - voucher parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Invalid hidden parameter, should be: 0 or 1</error> - hidden parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Invalid callerid leave parameter, should be: 0 or 1</error> - caller id leave parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Invalid date from</error> - unix time stamp date not correct.<br />
* <error>Invalid date till</error> - unix time stamp date not correct.<br />
* <error>Date from is greater than date till</error> - valid from is greater than valid till.<br />
* <error>Invalid Tariff id</error> - Tariff id is not correct. There is no such Tariff.<br />
* <error>Invalid Lcr id</error> - Lcr id is not correct. There is no such Lcr.<br />
* <error>Invalid Dialplan id</error> - Dialplan id is not correct. There is no such Dialplan.<br />
* <error>Invalid Location id</error> - Location id is not correct. There is no such Location.<br />
* <error>Invalid Currency</error> - Currency id is not correct. There is no such Currency.<br />
* <error>Invalid Price with TAX</error> - price is not correct, can not be negative.<br />
<br />
Example:<br />
<br />
<?xml version="1.0" encoding="UTF-8"?><br />
<page><br />
<status><br />
<error>Invalid solo pinless parameter, should be: 0 or 1</error><br />
</status><br />
</page><br />
<br><br><br />
<br />
=See also=<br />
<br />
* [[MOR API]]</div>Edvinashttps://wiki.kolmisoft.com/index.php?title=MOR_API&diff=20295MOR API2015-11-05T11:43:50Z<p>Edvinas: /* Calling Cards */</p>
<hr />
<div>[[File:warning.png|100px|alt="warning"|link=]]<big><big><big>IMPORTANT!!! API methods described here are for MOR X6. For previous versions please check appropriate [http://wiki.kolmisoft.com/index.php/MOR_Manual#Old_Manuals manual].</big></big></big><br />
[[File:api.png|right|alt="api"|link=]]<br />
<mkmeta>Application Program Interface for MOR Class 5 Softswitch</mkmeta><br />
<br />
<br><br><br />
=About=<br />
MOR API lets other software interact with MOR without knowing the internal structure of the database (DB) and other logic.<br />
<br />
MOR accepts requests by HTML POST and returns results in XML.<br />
<br />
<br><br><br />
=MOR users that are allowed to use MOR API=<br />
* Admin<br />
* Reseller<br />
* Accountant - only by using Admin Hash and Secret key<br />
* Simple User<br />
<br />
<br><br><br />
<br />
=Functions=<br />
<br />
== API Related ==<br />
* [[API Configuration]] – configuration options for API.<br />
* [[MOR API hash construction|Hash construction]] – how to construct hash to authenticate data over API.<br />
<br />
<br><br />
==Balance==<br />
* [[MOR API user balance update | user_balance_update]] (change_user_balance) – changes User's Balance<br />
Various methods to retrieve User balance<br />
* [[MOR API user_balance_get|user_balance_get]] (balance) – retrieves a User Balance.<br />
* [[Balance in phone | user_simple_balance_get]] (simple_balance) – gets User's Balance<br />
* [[MOR API user balance get by psw | user_balance_get_by_psw]] – gets User's Balance by his owned Device's Password<br />
* [[MOR API User Balance get by Username | user_balance_get_by_username]] – gets User's Balance by his owned Device's Username<br />
<br />
<br><br />
<br />
==Callback==<br />
* [[MOR API callback init|callback_init]] (callback) – initiates callback.<br />
<br />
<br><br />
==Calling Cards==<br />
* [[MOR API card_by_cli_update| card_by_cli_update]] (cc_by_cli) – creates and updates calling cards, including adding and transferring funds, by being identified according the Caller_ID.<br />
* [[MOR API card_from_group_sell| card_from_group_sell]] (buy_card_from_callingroup) – sells cards from calling card group.<br />
* [[MOR API card_group_get| card_group_get]] (show_calling_card_group) – show calling group info.<br />
* [[MOR API card_balance_get| card_balance_get]] (card_balance_get) – show card's balance.<br />
* [[MOR API card_payment_add| card_payment_add]] – add payment to the calling card.<br />
* [[MOR_API_Calling_Cards_create| calling_cards_create]] – create Calling Cards.<br />
* [[MOR_API_cc_groups_get| cc_groups_get]] – show Calling Cards Group info.<br />
* [[MOR_API_Calling_Card_update| calling_card_update]] – update Calling Card.<br />
* [[MOR_API_Card_Group_create| cc_group_create]] – create Card Group.<br />
<br><br />
<br />
==Calls==<br />
* [[MOR API user calls get|user_calls_get]] (user_calls) – retrieves a list of calls in a selected time period for a user/device.<br />
<br />
<br><br />
<br />
==Conflines==<br />
* [[MOR API conflines update|conflines_update]] – changes settings for API, Default User or Default Device.<br />
<br />
<br><br />
==Credit notes==<br />
* [[MOR API credit_notes_get| credit_notes_get]] (credit_notes) – credit notes list.<br />
* [[MOR API credit_note_update| credit_note_update]] – credit note update.<br />
* [[MOR API credit_notes_create| credit_note_create]] – credit note create.<br />
* [[MOR API credit_notes_delete| credit_note_delete]] – credit note delete.<br />
<br />
<br><br />
==Device==<br />
* [[MOR API device create| device_create]] – create device<br />
* [[MOR API device delete| device_delete]] (delete_device) – delete device<br />
* [[MOR API devices get | devices_get]] (device_list) – users device list<br />
* [[MOR API device callflow get| device_callflow_get]] - returns information about specified device callflow state.<br />
* [[MOR API device callflow update | device_callflow_update]] – updates information of specified device callflow state. <br />
* [[MOR API CLI info get | cli_info_get]] (cli_get_info) – shows id of device where CLI belongs.<br />
* [[MOR API CLI delete | cli_delete]] – deletes specified CLI. <br />
* [[MOR API CLI add | cli_add]] – creates CLI and assigns it to the specified device.<br />
* [[MOR API device clis get | device_clis_get]] – CLIs list by User and/or Device<br />
* [[MOR API device details get | device_details_get]] – shows all information about specified device.<br />
* [[MOR_API_device_update | device_update]] – updates location_id of selected Device.<br />
<br />
<br><br />
<br />
==DID==<br />
<br />
* [[MOR API dids get| dids_get]] – get list of particular DIDs<br />
* [[MOR API did_create| did_create]] – DID create<br />
* [[MOR_API_did_device_assign| did_device_assign]] (did_assign_device) – Assign Device to DID<br />
* [[MOR_API_did_device_unassign| did_device_unassign]] (did_unassign_device) – Unassign Device from DID<br />
* [[MOR_API_did_details_update| did_details_update]] (did_details_update) – Update DID details <br />
* [[MOR API did subscription stop|did_subscription_stop]] – STOP DID subscription<br />
<br />
<br><br />
<br />
==Email==<br />
* [[MOR API email send| email_send]] (send_email) – send Email.<br />
<br />
<br><br />
==Financial statements==<br />
* [[MOR API financial_statements_get| financial_statements_get]] (financial_statements) – financial statements list.<br />
<br />
<br><br />
==Invoices==<br />
* [[MOR API invoices_get|invoices_get]] (invoices) – retrieves a list of invoices in a selected time period.<br />
<br />
<br><br />
==Login==<br />
* [[MOR API user_login|user_login]] (login) – logs user in to MOR.<br />
* [[MOR API user_logout|user_logout]] (logout) – logs user out from MOR.<br />
<br />
<br><br />
==Monitorings==<br />
* [[MOR API ma_activate_api| ma_activate]] – turn on monitorings addon<br />
<br />
<br><br />
==Payments==<br />
* [[MOR API payment_create| payment_create]] (create_payment) – create payment.<br />
* [[MOR API payments_get| payments_get]] (payments_list) – payments list.<br />
<br />
<br><br />
==Phonebooks==<br />
* [[MOR API phonebooks_get| phonebooks_get]] (phonebooks_api ) – phonebooks list.<br />
* [[MOR API phonebook_edit| phonebook_edit]] (phonebook_edit_api) – edit phonebook.<br />
* [[MOR API phonebook_record_create| phonebook_record_create]] – create phonebook.<br />
<br />
<br><br />
==Quickforwards==<br />
* [[MOR API Quickforwards get| quickforwards_dids_get]] (quickforwards_dids_get) – get Quickforwards.<br />
* [[MOR API Quickforwards update| quickforwards_did_update]] (quickforwards_did_update) – update Quickforwards.<br />
* [[MOR API Quickforwards delete| quickforwards_did_delete]] (quickforwards_did_delete) – delete Quickforwards.<br />
<br />
<br><br />
==Rates==<br />
* [[MOR API rate get|rate_get]] (rate) – check user rate by prefix<br />
* [[MOR API tariff rates get| tariff_rates_get]] (get_tariff) – get all tariff's rates<br />
* [[MOR API tariff_retail_import | tariff_retail_import ]] (import_relail_tariff) – import xml retail tariff<br />
* [[MOR API tariff_wholesale_update | tariff_wholesale_update ]] (wholesale_tariff) – update or create wholesale tariff<br />
<br />
<br><br />
==Services==<br />
* [[MOR API Service create| service_create]] – create Service.<br />
* [[MOR API Service delete| service_delete]] – delete Service.<br />
* [[MOR API Services get| services_get]] – get Services.<br />
* [[MOR API Service update| service_update]] – update Service.<br />
<br />
<br><br />
<br />
==SMS==<br />
* [[MOR API sms send| sms_send]] (send_sms) – send SMS.<br />
* [[MOR_API_user_sms_service_subscribe | user_sms_service_subscribe ]] – User subscription to SMS Service.<br />
<br />
<br><br />
==Subscriptions==<br />
* [[MOR API subscription delete|subscription_delete]] - Subscription delete.<br />
* [[MOR API Subscriptions get|subscriptions_get]] - Subscriptions get.<br />
* [[MOR API subscription create|subscription_create]] - Subscription create.<br />
* [[MOR API subscription update|subscription_update]] - Subscription delete.<br />
<br><br />
<br />
==User==<br />
<br />
* [[MOR API user_register| user_register]] – create new user from params.<br />
* [[MOR API user_details_get | user_details_get]] (user_details) – gets user details.<br />
* [[MOR_API_user_details_update| user_details_update]] (user_update_api) – update user from params.<br />
<br><br />
<br />
== Resellers ==<br />
* [[MOR API reseller group create]] - create new Reseller Group<br />
<br />
<br><br />
==Version==<br />
* [[MOR API system version get| system_version_get]] (get_version) – get MOR version number.<br />
<br />
<br><br />
= Examples =<br />
* [[MOR API PHP Examples]]<br />
<br />
<br><br><br />
=HTML POST=<br />
All requests are in a similar format:<br />
<br />
HTML POST: http://<SERVER_IP>/billing/api/<function>?u=username<br />
<br />
* username - the user name and password of the user who is asking for the data. <br />
<br />
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.<br />
<br><br><br />
=Useful to know=<br />
<br />
* 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:<br />
** Value of money will be returned in Default System [[Currencies|Currency]].<br />
** Date will not be affected of [[Configuration_from_GUI#Visual| Default date format]] setting.<br />
** Value of money will not be affected of [[Configuration_from_GUI#Visual|Number digits]] setting.<br />
<br />
<br><br><br />
=See also =<br />
* [[API Configuration]]<br />
* [[MOR integration]]<br />
* [[How to block access to some API functions]]<br />
* [[API specification to be implemented in the future]]</div>Edvinashttps://wiki.kolmisoft.com/index.php?title=MOR_API_Card_Group_create&diff=20294MOR API Card Group create2015-11-05T11:00:36Z<p>Edvinas: </p>
<hr />
<div>=Description=<br />
[[MOR API]] Card Group create<br />
<br><br><br />
=Usage=<br />
<br />
* Call: /api/cc_group_create<br />
* Methods: POST, GET(if allowed, not recomended)<br />
<br><br><br />
===Parameters===<br />
<br />
Parameters which are '''included''' into hash:<br />
<br />
* name - name of a Card Group '''Required'''.<br />
<br />
<br><br><br />
Parameters which are '''not included''' into hash:<br />
<br />
* '''[[MOR API hash construction | hash]]''' - SHA1 hash constructed using the '''parameters''' which are listed above. Note that the parameters are shown in the same order as they need to be when generating the hash. The last parameter in a row is '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.<br><br />
* '''u''' - username for authentication. '''Required'''.<br />
* '''description''' - description for Card Group.<br />
* '''price_with_vat''' - price with TAX for Card Group.<br />
* '''setup_fee''' - setup fee for Card Group.<br />
* '''ghost_min_perc''' - ghost min percent for Card Group.<br />
* '''daily_charge''' - daily charge for Card Group.<br />
* '''tariff_id''' - Card Group tariff id.<br />
* '''lcr_id''' - Card Group lcr id.<br />
* '''date_from''' - Card Group valid from date.<br />
* '''date_till''' - Card Group valid till date.<br />
* '''number_length''' - Card Group number length.<br />
* '''pin_length''' - Card Group pin length.<br />
* '''dialplan_id''' - Card Group dial plan id.<br />
* '''location_id''' - Card Group location id.<br />
* '''tax_id''' - Card Group tax id.<br />
* '''valid_after_first_use''' - number of days, after which Card Group gets valid.<br />
* '''ghost_balance_perc''' - Card Group ghost balance percent.<br />
* '''use_external_function''' - enable or disable use of external script;<br />
* '''allow_loss_calls''' - Allow Loss Calls for Card Group.<br />
* '''tell_cents''' - tell cents for Card Group.<br />
* '''tell_balance_in_currency''' - Card Group Balance/Rate Currency.<br />
* '''solo_pinless''' - enable or disable solo pinless.<br />
* '''disable_voucher''' - enable or disable voucher.<br />
* '''hidden''' - enable or disable hidden status.<br />
* '''callerid_leave''' - enable or disable caller id leave.<br />
<br><br><br />
<br />
===Request===<br />
<br />
We have u = admin, API Secret Key = secret<br />
We send:<br />
<br />
HTML POST: http://<SERVER_IP>/billing/api/cc_group_create?u=admin&name=card_group_test&hash=7e112ededcfee097cce21b6201c6d2a00dda1f4c<br />
<br />
* Now we can find 1 newly created Card Group.'''<br><br />
'''* Note that if not passing optional parameters, default values will be used.'''<br />
'''* Note that a Username and a Password are not included into hash'''<br />
<br><br><br />
===Returns===<br />
<br />
'''Success'''<br />
<br />
<?xml version="1.0" encoding="UTF-8"?><br />
<page><br />
<status><br />
<success>Card Group was successfully created</success><br />
</status><br />
</page><br />
<br><br><br />
----<br />
<br />
'''Errors'''<br />
<br />
* <error>Access Denied</error> - User is not authorized or is a Simple User. Only Admin, Reseller or Accounant can use this API method. <br />
* <error>Incorrect hash</error> - hash is not correct. Check API_Secret_Key and order or parameters while concatenating a hash_string.<br />
* <error>You are not authorized to use this functionality</error> - User has no permissions to manage Calling Cards. <br />
* <error>Bad login</error> - User is not authorized (possibly wrong Username). <br />
* <error>Card Group must have name</error> - Card Group name is not given. Name is requered parameter.<br />
* <error>Invalid use external function parameter, should be: 0 or 1</error> - use external script parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Invalid allow loss calls parameter, should be: 0 or 1</error> - allow loss calls parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Invalid tell cents parameter, should be: 0 or 1</error> - tell cents parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Invalid solo pinless parameter, should be: 0 or 1</error> - solo pinless parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Invalid disable voucher parameter, should be: 0 or 1</error> - voucher parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Invalid hidden parameter, should be: 0 or 1</error> - hidden parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Invalid callerid leave parameter, should be: 0 or 1</error> - caller id leave parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Invalid date from</error> - unix time stamp date not correct.<br />
* <error>Invalid date till</error> - unix time stamp date not correct.<br />
* <error>Date from is greater than date till</error> - valid from is greater than valid till.<br />
* <error>Invalid Tariff id</error> - Tariff id is not correct. There is no such Tariff.<br />
* <error>Invalid Lcr id</error> - Lcr id is not correct. There is no such Lcr.<br />
* <error>Invalid Dialplan id</error> - Dialplan id is not correct. There is no such Dialplan.<br />
* <error>Invalid Location id</error> - Location id is not correct. There is no such Location.<br />
* <error>Invalid Currency</error> - Currency id is not correct. There is no such Currency.<br />
* <error>Invalid Price with TAX</error> - price is not correct, can not be negative.<br />
<br />
Example:<br />
<br />
<?xml version="1.0" encoding="UTF-8"?><br />
<page><br />
<status><br />
<error>Invalid solo pinless parameter, should be: 0 or 1</error><br />
</status><br />
</page><br />
<br><br><br />
<br />
=See also=<br />
<br />
* [[MOR API]]</div>Edvinashttps://wiki.kolmisoft.com/index.php?title=MOR_API_Card_Group_create&diff=20293MOR API Card Group create2015-11-05T10:55:46Z<p>Edvinas: Created page with '=Description= MOR API Card Group create <br><br> =Usage= * Call: /api/cc_group_create * Methods: POST, GET(if allowed, not recomended) <br><br> ===Parameters=== Parameters …'</p>
<hr />
<div>=Description=<br />
[[MOR API]] Card Group create<br />
<br><br><br />
=Usage=<br />
<br />
* Call: /api/cc_group_create<br />
* Methods: POST, GET(if allowed, not recomended)<br />
<br><br><br />
===Parameters===<br />
<br />
Parameters which are '''included''' into hash:<br />
<br />
* name - name of a Card Group '''Required'''.<br />
<br />
<br><br><br />
Parameters which are '''not included''' into hash:<br />
<br />
* '''[[MOR API hash construction | hash]]''' - SHA1 hash constructed using the '''parameters''' which are listed above. Note that the parameters are shown in the same order as they need to be when generating the hash. The last parameter in a row is '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.<br><br />
* '''u''' - username for authentication. '''Required'''.<br />
* '''description''' - description for Card Group.<br />
* '''price_with_vat''' - price with TAX for Card Group.<br />
* '''setup_fee''' - setup fee for Card Group.<br />
* '''ghost_min_perc''' - ghost min percent for Card Group.<br />
* '''daily_charge''' - daily charge for Card Group.<br />
* '''tariff_id''' - Card Group tariff id.<br />
* '''lcr_id''' - Card Group lcr id.<br />
* '''date_from''' - Card Group valid from date.<br />
* '''date_till''' - Card Group valid till date.<br />
* '''number_length''' - Card Group number length.<br />
* '''pin_length''' - Card Group pin length.<br />
* '''dialplan_id''' - Card Group dial plan id.<br />
* '''location_id''' - Card Group location id.<br />
* '''tax_id''' - Card Group tax id.<br />
* '''valid_after_first_use''' - number of days, after which Card Group gets valid.<br />
* '''ghost_balance_perc''' - Card Group ghost balance percent.<br />
* '''use_external_function''' - enable or disable use of external script;<br />
* '''allow_loss_calls''' - Allow Loss Calls for Card Group.<br />
* '''tell_cents''' - tell cents for Card Group.<br />
* '''tell_balance_in_currency''' - Card Group Balance/Rate Currency.<br />
* '''solo_pinless''' - enable or disable solo pinless.<br />
* '''disable_voucher''' - enable or disable voucher.<br />
* '''hidden''' - enable or disable hidden status.<br />
* '''callerid_leave''' - enable or disable caller id leave.<br />
<br><br><br />
<br />
===Request===<br />
<br />
We have u = admin, API Secret Key = secret<br />
We send:<br />
<br />
HTML POST: http://<SERVER_IP>/billing/api/cc_group_create?u=admin&name=card_group_test&hash=7e112ededcfee097cce21b6201c6d2a00dda1f4c<br />
<br />
* Now we can find 1 newly created Card Group.'''<br><br />
'''* Note that if not passing optional parameters, default values will be used.'''<br />
'''* Note that a Username and a Password are not included into hash'''<br />
<br><br><br />
===Returns===<br />
<br />
'''Success'''<br />
<br />
<?xml version="1.0" encoding="UTF-8"?><br />
<page><br />
<status><br />
<success>Cards created: 11/11</success><br />
</status><br />
</page><br />
<br><br><br />
----<br />
<br />
'''Errors'''<br />
<br />
* <error>Access Denied</error> - User is not authorized or is a Simple User. Only Admin, Reseller or Accounant can use this API method. <br />
* <error>Incorrect hash</error> - hash is not correct. Check API_Secret_Key and order or parameters while concatenating a hash_string.<br />
* <error>You are not authorized to use this functionality</error> - User has no permissions to manage Calling Cards. <br />
* <error>Bad login</error> - User is not authorized (possibly wrong Username). <br />
* <error>Card Group must have name</error> - Card Group name is not given. Name is requered parameter.<br />
* <error>Invalid use external function parameter, should be: 0 or 1</error> - use external script parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Invalid allow loss calls parameter, should be: 0 or 1</error> - allow loss calls parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Invalid tell cents parameter, should be: 0 or 1</error> - tell cents parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Invalid solo pinless parameter, should be: 0 or 1</error> - solo pinless parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Invalid disable voucher parameter, should be: 0 or 1</error> - voucher parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Invalid hidden parameter, should be: 0 or 1</error> - hidden parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Invalid callerid leave parameter, should be: 0 or 1</error> - caller id leave parameter can only be: 1 - enabled, 0 - disabled.<br />
* <error>Invalid date from</error> - unix time stamp date not correct.<br />
* <error>Invalid date till</error> - unix time stamp date not correct.<br />
* <error>Date from is greater than date till</error> - valid from is greater than valid till.<br />
* <error>Invalid Tariff id</error> - Tariff id is not correct. There is no such Tariff.<br />
* <error>Invalid Lcr id</error> - Lcr id is not correct. There is no such Lcr.<br />
* <error>Invalid Dialplan id</error> - Dialplan id is not correct. There is no such Dialplan.<br />
* <error>Invalid Location id</error> - Location id is not correct. There is no such Location.<br />
* <error>Invalid Currency</error> - Currency id is not correct. There is no such Currency.<br />
* <error>Invalid Price with TAX</error> - price is not correct, can not be negative.<br />
<br />
Example:<br />
<br />
<?xml version="1.0" encoding="UTF-8"?><br />
<page><br />
<status><br />
<error>Invalid solo pinless parameter, should be: 0 or 1</error><br />
</status><br />
</page><br />
<br><br><br />
<br />
=See also=<br />
<br />
* [[MOR API]]</div>Edvinashttps://wiki.kolmisoft.com/index.php?title=MOR_API&diff=20292MOR API2015-11-05T10:14:21Z<p>Edvinas: /* Calling Cards */</p>
<hr />
<div>[[File:warning.png|100px|alt="warning"|link=]]<big><big><big>IMPORTANT!!! API methods described here are for MOR X6. For previous versions please check appropriate [http://wiki.kolmisoft.com/index.php/MOR_Manual#Old_Manuals manual].</big></big></big><br />
[[File:api.png|right|alt="api"|link=]]<br />
<mkmeta>Application Program Interface for MOR Class 5 Softswitch</mkmeta><br />
<br />
<br><br><br />
=About=<br />
MOR API lets other software interact with MOR without knowing the internal structure of the database (DB) and other logic.<br />
<br />
MOR accepts requests by HTML POST and returns results in XML.<br />
<br />
<br><br><br />
=MOR users that are allowed to use MOR API=<br />
* Admin<br />
* Reseller<br />
* Accountant - only by using Admin Hash and Secret key<br />
* Simple User<br />
<br />
<br><br><br />
<br />
=Functions=<br />
<br />
== API Related ==<br />
* [[API Configuration]] – configuration options for API.<br />
* [[MOR API hash construction|Hash construction]] – how to construct hash to authenticate data over API.<br />
<br />
<br><br />
==Balance==<br />
* [[MOR API user balance update | user_balance_update]] (change_user_balance) – changes User's Balance<br />
Various methods to retrieve User balance<br />
* [[MOR API user_balance_get|user_balance_get]] (balance) – retrieves a User Balance.<br />
* [[Balance in phone | user_simple_balance_get]] (simple_balance) – gets User's Balance<br />
* [[MOR API user balance get by psw | user_balance_get_by_psw]] – gets User's Balance by his owned Device's Password<br />
* [[MOR API User Balance get by Username | user_balance_get_by_username]] – gets User's Balance by his owned Device's Username<br />
<br />
<br><br />
<br />
==Callback==<br />
* [[MOR API callback init|callback_init]] (callback) – initiates callback.<br />
<br />
<br><br />
==Calling Cards==<br />
* [[MOR API card_by_cli_update| card_by_cli_update]] (cc_by_cli) – creates and updates calling cards, including adding and transferring funds, by being identified according the Caller_ID.<br />
* [[MOR API card_from_group_sell| card_from_group_sell]] (buy_card_from_callingroup) – sells cards from calling card group.<br />
* [[MOR API card_group_get| card_group_get]] (show_calling_card_group) – show calling group info.<br />
* [[MOR API card_balance_get| card_balance_get]] (card_balance_get) – show card's balance.<br />
* [[MOR API card_payment_add| card_payment_add]] – add payment to the calling card.<br />
* [[MOR_API_Calling_Cards_create| calling_cards_create]] – create Calling Cards.<br />
* [[MOR_API_cc_groups_get| cc_groups_get]] – show Calling Cards Group info.<br />
* [[MOR_API_Calling_Card_update| calling_card_update]] – update Calling Card.<br />
<br><br />
<br />
==Calls==<br />
* [[MOR API user calls get|user_calls_get]] (user_calls) – retrieves a list of calls in a selected time period for a user/device.<br />
<br />
<br><br />
<br />
==Conflines==<br />
* [[MOR API conflines update|conflines_update]] – changes settings for API, Default User or Default Device.<br />
<br />
<br><br />
==Credit notes==<br />
* [[MOR API credit_notes_get| credit_notes_get]] (credit_notes) – credit notes list.<br />
* [[MOR API credit_note_update| credit_note_update]] – credit note update.<br />
* [[MOR API credit_notes_create| credit_note_create]] – credit note create.<br />
* [[MOR API credit_notes_delete| credit_note_delete]] – credit note delete.<br />
<br />
<br><br />
==Device==<br />
* [[MOR API device create| device_create]] – create device<br />
* [[MOR API device delete| device_delete]] (delete_device) – delete device<br />
* [[MOR API devices get | devices_get]] (device_list) – users device list<br />
* [[MOR API device callflow get| device_callflow_get]] - returns information about specified device callflow state.<br />
* [[MOR API device callflow update | device_callflow_update]] – updates information of specified device callflow state. <br />
* [[MOR API CLI info get | cli_info_get]] (cli_get_info) – shows id of device where CLI belongs.<br />
* [[MOR API CLI delete | cli_delete]] – deletes specified CLI. <br />
* [[MOR API CLI add | cli_add]] – creates CLI and assigns it to the specified device.<br />
* [[MOR API device clis get | device_clis_get]] – CLIs list by User and/or Device<br />
* [[MOR API device details get | device_details_get]] – shows all information about specified device.<br />
* [[MOR_API_device_update | device_update]] – updates location_id of selected Device.<br />
<br />
<br><br />
<br />
==DID==<br />
<br />
* [[MOR API dids get| dids_get]] – get list of particular DIDs<br />
* [[MOR API did_create| did_create]] – DID create<br />
* [[MOR_API_did_device_assign| did_device_assign]] (did_assign_device) – Assign Device to DID<br />
* [[MOR_API_did_device_unassign| did_device_unassign]] (did_unassign_device) – Unassign Device from DID<br />
* [[MOR_API_did_details_update| did_details_update]] (did_details_update) – Update DID details <br />
* [[MOR API did subscription stop|did_subscription_stop]] – STOP DID subscription<br />
<br />
<br><br />
<br />
==Email==<br />
* [[MOR API email send| email_send]] (send_email) – send Email.<br />
<br />
<br><br />
==Financial statements==<br />
* [[MOR API financial_statements_get| financial_statements_get]] (financial_statements) – financial statements list.<br />
<br />
<br><br />
==Invoices==<br />
* [[MOR API invoices_get|invoices_get]] (invoices) – retrieves a list of invoices in a selected time period.<br />
<br />
<br><br />
==Login==<br />
* [[MOR API user_login|user_login]] (login) – logs user in to MOR.<br />
* [[MOR API user_logout|user_logout]] (logout) – logs user out from MOR.<br />
<br />
<br><br />
==Monitorings==<br />
* [[MOR API ma_activate_api| ma_activate]] – turn on monitorings addon<br />
<br />
<br><br />
==Payments==<br />
* [[MOR API payment_create| payment_create]] (create_payment) – create payment.<br />
* [[MOR API payments_get| payments_get]] (payments_list) – payments list.<br />
<br />
<br><br />
==Phonebooks==<br />
* [[MOR API phonebooks_get| phonebooks_get]] (phonebooks_api ) – phonebooks list.<br />
* [[MOR API phonebook_edit| phonebook_edit]] (phonebook_edit_api) – edit phonebook.<br />
* [[MOR API phonebook_record_create| phonebook_record_create]] – create phonebook.<br />
<br />
<br><br />
==Quickforwards==<br />
* [[MOR API Quickforwards get| quickforwards_dids_get]] (quickforwards_dids_get) – get Quickforwards.<br />
* [[MOR API Quickforwards update| quickforwards_did_update]] (quickforwards_did_update) – update Quickforwards.<br />
* [[MOR API Quickforwards delete| quickforwards_did_delete]] (quickforwards_did_delete) – delete Quickforwards.<br />
<br />
<br><br />
==Rates==<br />
* [[MOR API rate get|rate_get]] (rate) – check user rate by prefix<br />
* [[MOR API tariff rates get| tariff_rates_get]] (get_tariff) – get all tariff's rates<br />
* [[MOR API tariff_retail_import | tariff_retail_import ]] (import_relail_tariff) – import xml retail tariff<br />
* [[MOR API tariff_wholesale_update | tariff_wholesale_update ]] (wholesale_tariff) – update or create wholesale tariff<br />
<br />
<br><br />
==Services==<br />
* [[MOR API Service create| service_create]] – create Service.<br />
* [[MOR API Service delete| service_delete]] – delete Service.<br />
* [[MOR API Services get| services_get]] – get Services.<br />
* [[MOR API Service update| service_update]] – update Service.<br />
<br />
<br><br />
<br />
==SMS==<br />
* [[MOR API sms send| sms_send]] (send_sms) – send SMS.<br />
* [[MOR_API_user_sms_service_subscribe | user_sms_service_subscribe ]] – User subscription to SMS Service.<br />
<br />
<br><br />
==Subscriptions==<br />
* [[MOR API subscription delete|subscription_delete]] - Subscription delete.<br />
* [[MOR API Subscriptions get|subscriptions_get]] - Subscriptions get.<br />
* [[MOR API subscription create|subscription_create]] - Subscription create.<br />
* [[MOR API subscription update|subscription_update]] - Subscription delete.<br />
<br><br />
<br />
==User==<br />
<br />
* [[MOR API user_register| user_register]] – create new user from params.<br />
* [[MOR API user_details_get | user_details_get]] (user_details) – gets user details.<br />
* [[MOR_API_user_details_update| user_details_update]] (user_update_api) – update user from params.<br />
<br><br />
<br />
== Resellers ==<br />
* [[MOR API reseller group create]] - create new Reseller Group<br />
<br />
<br><br />
==Version==<br />
* [[MOR API system version get| system_version_get]] (get_version) – get MOR version number.<br />
<br />
<br><br />
= Examples =<br />
* [[MOR API PHP Examples]]<br />
<br />
<br><br><br />
=HTML POST=<br />
All requests are in a similar format:<br />
<br />
HTML POST: http://<SERVER_IP>/billing/api/<function>?u=username<br />
<br />
* username - the user name and password of the user who is asking for the data. <br />
<br />
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.<br />
<br><br><br />
=Useful to know=<br />
<br />
* 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:<br />
** Value of money will be returned in Default System [[Currencies|Currency]].<br />
** Date will not be affected of [[Configuration_from_GUI#Visual| Default date format]] setting.<br />
** Value of money will not be affected of [[Configuration_from_GUI#Visual|Number digits]] setting.<br />
<br />
<br><br><br />
=See also =<br />
* [[API Configuration]]<br />
* [[MOR integration]]<br />
* [[How to block access to some API functions]]<br />
* [[API specification to be implemented in the future]]</div>Edvinashttps://wiki.kolmisoft.com/index.php?title=MOR_API_Calling_Card_update&diff=20291MOR API Calling Card update2015-11-05T10:11:33Z<p>Edvinas: Created page with '= NOTE: Available from MOR X7 = =Description= MOR API Calling Card update <br><br> =Usage= * From '''MOR X7''' Calling Card: '''/api/calling_card_update''' * Methods: POST,…'</p>
<hr />
<div>= NOTE: Available from MOR X7 =<br />
<br />
=Description=<br />
[[MOR API]] Calling Card update<br />
<br><br><br />
=Usage=<br />
<br />
* From '''MOR X7''' Calling Card: '''/api/calling_card_update'''<br />
* Methods: POST, GET(if allowed, not recomended)<br />
<br><br><br />
===Parametres===<br />
<br />
* u - username for authentication.<br />
* card_id - Calling Card ID. '''Required'''.<br />
* number - Number for the Calling Card.<br />
* name - Card name for the Calling Card.<br />
* pin - PIN code for the Calling Card.<br />
* batch_number - Batch number for the Calling Card.<br />
* callerid - Caller ID for the Calling Card.<br />
* min_balance - Minimum balance for the Calling Card.<br />
* daily_charge_paid_till - Timestamp of daily charge paid.<br />
* language - Language for the Calling Card. <br />
* distributor - Calling Card distributor (User) id.<br />
<br />
* [[MOR API hash construction | hash]] - SHA1 hash constructed using '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.<br />
<br><br><br />
<br />
===Request===<br />
<br />
We have: API Secret Key = secret, card_id = 1, number = 4673451679, name = card, pin = 7468, batch_number = 5456484, callerid = 2, min_balance = 5, daily_charge_paid_till = 1446721871, language = en, distributor = 2<br />
<br />
We send:<br />
HTML POST: http://<SERVER_IP>/billing/api/calling_card_update?u=admin&card_id=1&number=4673451679&name=card&pin=7468&batch_number=5456484&callerid=2&min_balance=5&daily_charge_paid_till=1446721871&language=en&distributor=2&hash=bc2f114099d16656d37e45fd9e8744cb9386d462<br />
'''NOTE that username is not included in hash'''<br />
<br><br><br />
<br />
'''Success'''<br />
<br />
<page><br />
<status><br />
<success>Calling card successfully updated</success><br />
</status><br />
</page><br />
<br><br><br />
----<br />
<br />
'''Errors'''<br />
* <error>Bad login</error> - User supplied bad login.<br />
* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string. <br />
* <error>You are not authorized to use this functionality</error> - User does not have rights to manage Calling Cards.<br />
* <error>Access Denied</error> - User does not have access to Calling Cards.<br />
* <error>Wrong Calling card ID</error> - User supplied wrong Calling Card ID.<br />
* <error>Calling card not found</error> - Calling card was not found.<br />
<br><br><br />
<br />
=See also=<br />
<br />
* [[MOR API]]</div>Edvinashttps://wiki.kolmisoft.com/index.php?title=MOR_API_Card_Groups_get&diff=20289MOR API Card Groups get2015-11-05T09:15:04Z<p>Edvinas: /* Parametres */</p>
<hr />
<div>= NOTE: Available from MOR X7 =<br />
<br />
=Description=<br />
[[MOR API]] Calling Cards Groups get<br />
<br><br><br />
=Usage=<br />
<br />
* From '''MOR X7''' Calling Cards Groups: '''/api/cc_groups_get'''<br />
* Methods: POST, GET(if allowed, not recomended)<br />
<br><br><br />
===Parametres===<br />
<br />
* u - username for authentication.<br />
* cc_group_id - Calling Cards Group ID.<br />
* [[MOR API hash construction | hash]] - SHA1 hash constructed using '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.<br />
<br><br><br />
<br />
===Request===<br />
<br />
We have: API Secret Key = secret<br />
<br />
We send:<br />
HTML POST: http://<SERVER_IP>/billing/api/cc_groups_get?u=admin&cc_group_id=1&hash=e5e9fa1ba31ecd1ae84f75caaa474f3a663f05f4<br />
'''NOTE that username is not included in hash'''<br />
<br><br><br />
<br />
'''Success'''<br />
<br />
<page><br />
<status><br />
<group_id>1</group_id><br />
<group_image>example.jpg</group_image><br />
<group_name>Test_cardgroup</group_name><br />
<group_description>Test_cardgroup description</group_description><br />
<group_number_pin_length>10/4</group_number_pin_length><br />
<group_tarrif>Test Tariff for Users</group_tarrif><br />
<group_lcr>Primary</group_lcr><br />
<group_price>10.0840</group_price><br />
<group_price_without_tax>10.0840</group_price_without_tax><br />
<group_cards_count>21</group_cards_count><br />
</status><br />
</page><br />
<br><br><br />
----<br />
<br />
'''Errors'''<br />
* <error>Bad login</error> - User supplied bad login.<br />
* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string. <br />
* <error>You are not authorized to use this functionality</error> - User does not have rights to manage Calling Cards.<br />
* <error>Access Denied</error> - User does not have access to Calling Cards.<br />
* <error>Wrong calling cards group ID</error> - User supplied wrong Calling Cards group ID.<br />
* <error>Calling cards groups were not found</error> - Calling cards groups were not found.<br />
<br><br><br />
<br />
=See also=<br />
<br />
* [[MOR API]]</div>Edvinashttps://wiki.kolmisoft.com/index.php?title=MOR_API&diff=20288MOR API2015-11-04T17:41:17Z<p>Edvinas: /* Calling Cards */</p>
<hr />
<div>[[File:warning.png|100px|alt="warning"|link=]]<big><big><big>IMPORTANT!!! API methods described here are for MOR X6. For previous versions please check appropriate [http://wiki.kolmisoft.com/index.php/MOR_Manual#Old_Manuals manual].</big></big></big><br />
[[File:api.png|right|alt="api"|link=]]<br />
<mkmeta>Application Program Interface for MOR Class 5 Softswitch</mkmeta><br />
<br />
<br><br><br />
=About=<br />
MOR API lets other software interact with MOR without knowing the internal structure of the database (DB) and other logic.<br />
<br />
MOR accepts requests by HTML POST and returns results in XML.<br />
<br />
<br><br><br />
=MOR users that are allowed to use MOR API=<br />
* Admin<br />
* Reseller<br />
* Accountant - only by using Admin Hash and Secret key<br />
* Simple User<br />
<br />
<br><br><br />
<br />
=Functions=<br />
<br />
== API Related ==<br />
* [[API Configuration]] – configuration options for API.<br />
* [[MOR API hash construction|Hash construction]] – how to construct hash to authenticate data over API.<br />
<br />
<br><br />
==Balance==<br />
* [[MOR API user balance update | user_balance_update]] (change_user_balance) – changes User's Balance<br />
Various methods to retrieve User balance<br />
* [[MOR API user_balance_get|user_balance_get]] (balance) – retrieves a User Balance.<br />
* [[Balance in phone | user_simple_balance_get]] (simple_balance) – gets User's Balance<br />
* [[MOR API user balance get by psw | user_balance_get_by_psw]] – gets User's Balance by his owned Device's Password<br />
* [[MOR API User Balance get by Username | user_balance_get_by_username]] – gets User's Balance by his owned Device's Username<br />
<br />
<br><br />
<br />
==Callback==<br />
* [[MOR API callback init|callback_init]] (callback) – initiates callback.<br />
<br />
<br><br />
==Calling Cards==<br />
* [[MOR API card_by_cli_update| card_by_cli_update]] (cc_by_cli) – creates and updates calling cards, including adding and transferring funds, by being identified according the Caller_ID.<br />
* [[MOR API card_from_group_sell| card_from_group_sell]] (buy_card_from_callingroup) – sells cards from calling card group.<br />
* [[MOR API card_group_get| card_group_get]] (show_calling_card_group) – show calling group info.<br />
* [[MOR API card_balance_get| card_balance_get]] (card_balance_get) – show card's balance.<br />
* [[MOR API card_payment_add| card_payment_add]] – add payment to the calling card.<br />
* [[MOR_API_Calling_Cards_create| calling_cards_create]] – create Calling Cards.<br />
* [[MOR_API_cc_groups_get| cc_groups_get]] – show Calling Cards Group info.<br />
<br><br />
<br />
==Calls==<br />
* [[MOR API user calls get|user_calls_get]] (user_calls) – retrieves a list of calls in a selected time period for a user/device.<br />
<br />
<br><br />
<br />
==Conflines==<br />
* [[MOR API conflines update|conflines_update]] – changes settings for API, Default User or Default Device.<br />
<br />
<br><br />
==Credit notes==<br />
* [[MOR API credit_notes_get| credit_notes_get]] (credit_notes) – credit notes list.<br />
* [[MOR API credit_note_update| credit_note_update]] – credit note update.<br />
* [[MOR API credit_notes_create| credit_note_create]] – credit note create.<br />
* [[MOR API credit_notes_delete| credit_note_delete]] – credit note delete.<br />
<br />
<br><br />
==Device==<br />
* [[MOR API device create| device_create]] – create device<br />
* [[MOR API device delete| device_delete]] (delete_device) – delete device<br />
* [[MOR API devices get | devices_get]] (device_list) – users device list<br />
* [[MOR API device callflow get| device_callflow_get]] - returns information about specified device callflow state.<br />
* [[MOR API device callflow update | device_callflow_update]] – updates information of specified device callflow state. <br />
* [[MOR API CLI info get | cli_info_get]] (cli_get_info) – shows id of device where CLI belongs.<br />
* [[MOR API CLI delete | cli_delete]] – deletes specified CLI. <br />
* [[MOR API CLI add | cli_add]] – creates CLI and assigns it to the specified device.<br />
* [[MOR API device clis get | device_clis_get]] – CLIs list by User and/or Device<br />
* [[MOR API device details get | device_details_get]] – shows all information about specified device.<br />
* [[MOR_API_device_update | device_update]] – updates location_id of selected Device.<br />
<br />
<br><br />
<br />
==DID==<br />
<br />
* [[MOR API dids get| dids_get]] – get list of particular DIDs<br />
* [[MOR API did_create| did_create]] – DID create<br />
* [[MOR_API_did_device_assign| did_device_assign]] (did_assign_device) – Assign Device to DID<br />
* [[MOR_API_did_device_unassign| did_device_unassign]] (did_unassign_device) – Unassign Device from DID<br />
* [[MOR_API_did_details_update| did_details_update]] (did_details_update) – Update DID details <br />
* [[MOR API did subscription stop|did_subscription_stop]] – STOP DID subscription<br />
<br />
<br><br />
<br />
==Email==<br />
* [[MOR API email send| email_send]] (send_email) – send Email.<br />
<br />
<br><br />
==Financial statements==<br />
* [[MOR API financial_statements_get| financial_statements_get]] (financial_statements) – financial statements list.<br />
<br />
<br><br />
==Invoices==<br />
* [[MOR API invoices_get|invoices_get]] (invoices) – retrieves a list of invoices in a selected time period.<br />
<br />
<br><br />
==Login==<br />
* [[MOR API user_login|user_login]] (login) – logs user in to MOR.<br />
* [[MOR API user_logout|user_logout]] (logout) – logs user out from MOR.<br />
<br />
<br><br />
==Monitorings==<br />
* [[MOR API ma_activate_api| ma_activate]] – turn on monitorings addon<br />
<br />
<br><br />
==Payments==<br />
* [[MOR API payment_create| payment_create]] (create_payment) – create payment.<br />
* [[MOR API payments_get| payments_get]] (payments_list) – payments list.<br />
<br />
<br><br />
==Phonebooks==<br />
* [[MOR API phonebooks_get| phonebooks_get]] (phonebooks_api ) – phonebooks list.<br />
* [[MOR API phonebook_edit| phonebook_edit]] (phonebook_edit_api) – edit phonebook.<br />
* [[MOR API phonebook_record_create| phonebook_record_create]] – create phonebook.<br />
<br />
<br><br />
==Quickforwards==<br />
* [[MOR API Quickforwards get| quickforwards_dids_get]] (quickforwards_dids_get) – get Quickforwards.<br />
* [[MOR API Quickforwards update| quickforwards_did_update]] (quickforwards_did_update) – update Quickforwards.<br />
* [[MOR API Quickforwards delete| quickforwards_did_delete]] (quickforwards_did_delete) – delete Quickforwards.<br />
<br />
<br><br />
==Rates==<br />
* [[MOR API rate get|rate_get]] (rate) – check user rate by prefix<br />
* [[MOR API tariff rates get| tariff_rates_get]] (get_tariff) – get all tariff's rates<br />
* [[MOR API tariff_retail_import | tariff_retail_import ]] (import_relail_tariff) – import xml retail tariff<br />
* [[MOR API tariff_wholesale_update | tariff_wholesale_update ]] (wholesale_tariff) – update or create wholesale tariff<br />
<br />
<br><br />
==Services==<br />
* [[MOR API Service create| service_create]] – create Service.<br />
* [[MOR API Service delete| service_delete]] – delete Service.<br />
* [[MOR API Services get| services_get]] – get Services.<br />
* [[MOR API Service update| service_update]] – update Service.<br />
<br />
<br><br />
<br />
==SMS==<br />
* [[MOR API sms send| sms_send]] (send_sms) – send SMS.<br />
* [[MOR_API_user_sms_service_subscribe | user_sms_service_subscribe ]] – User subscription to SMS Service.<br />
<br />
<br><br />
==Subscriptions==<br />
* [[MOR API subscription delete|subscription_delete]] - Subscription delete.<br />
* [[MOR API Subscriptions get|subscriptions_get]] - Subscriptions get.<br />
* [[MOR API subscription create|subscription_create]] - Subscription create.<br />
* [[MOR API subscription update|subscription_update]] - Subscription delete.<br />
<br><br />
<br />
==User==<br />
<br />
* [[MOR API user_register| user_register]] – create new user from params.<br />
* [[MOR API user_details_get | user_details_get]] (user_details) – gets user details.<br />
* [[MOR_API_user_details_update| user_details_update]] (user_update_api) – update user from params.<br />
<br><br />
<br />
== Resellers ==<br />
* [[MOR API reseller group create]] - create new Reseller Group<br />
<br />
<br><br />
==Version==<br />
* [[MOR API system version get| system_version_get]] (get_version) – get MOR version number.<br />
<br />
<br><br />
= Examples =<br />
* [[MOR API PHP Examples]]<br />
<br />
<br><br><br />
=HTML POST=<br />
All requests are in a similar format:<br />
<br />
HTML POST: http://<SERVER_IP>/billing/api/<function>?u=username<br />
<br />
* username - the user name and password of the user who is asking for the data. <br />
<br />
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.<br />
<br><br><br />
=Useful to know=<br />
<br />
* 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:<br />
** Value of money will be returned in Default System [[Currencies|Currency]].<br />
** Date will not be affected of [[Configuration_from_GUI#Visual| Default date format]] setting.<br />
** Value of money will not be affected of [[Configuration_from_GUI#Visual|Number digits]] setting.<br />
<br />
<br><br><br />
=See also =<br />
* [[API Configuration]]<br />
* [[MOR integration]]<br />
* [[How to block access to some API functions]]<br />
* [[API specification to be implemented in the future]]</div>Edvinashttps://wiki.kolmisoft.com/index.php?title=MOR_API_Card_Groups_get&diff=20287MOR API Card Groups get2015-11-04T17:37:39Z<p>Edvinas: Created page with '= NOTE: Available from MOR X7 = =Description= MOR API Calling Cards Groups get <br><br> =Usage= * From '''MOR X7''' Calling Cards Groups: '''/api/cc_groups_get''' * Methods…'</p>
<hr />
<div>= NOTE: Available from MOR X7 =<br />
<br />
=Description=<br />
[[MOR API]] Calling Cards Groups get<br />
<br><br><br />
=Usage=<br />
<br />
* From '''MOR X7''' Calling Cards Groups: '''/api/cc_groups_get'''<br />
* Methods: POST, GET(if allowed, not recomended)<br />
<br><br><br />
===Parametres===<br />
<br />
* u - username for authentication. '''Required'''.<br />
* cc_group_id - Calling Cards Group ID.<br />
* [[MOR API hash construction | hash]] - SHA1 hash constructed using '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.<br />
<br><br><br />
<br />
===Request===<br />
<br />
We have: API Secret Key = secret<br />
<br />
We send:<br />
HTML POST: http://<SERVER_IP>/billing/api/cc_groups_get?u=admin&cc_group_id=1&hash=e5e9fa1ba31ecd1ae84f75caaa474f3a663f05f4<br />
'''NOTE that username is not included in hash'''<br />
<br><br><br />
<br />
'''Success'''<br />
<br />
<page><br />
<status><br />
<group_id>1</group_id><br />
<group_image>example.jpg</group_image><br />
<group_name>Test_cardgroup</group_name><br />
<group_description>Test_cardgroup description</group_description><br />
<group_number_pin_length>10/4</group_number_pin_length><br />
<group_tarrif>Test Tariff for Users</group_tarrif><br />
<group_lcr>Primary</group_lcr><br />
<group_price>10.0840</group_price><br />
<group_price_without_tax>10.0840</group_price_without_tax><br />
<group_cards_count>21</group_cards_count><br />
</status><br />
</page><br />
<br><br><br />
----<br />
<br />
'''Errors'''<br />
* <error>Bad login</error> - User supplied bad login.<br />
* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string. <br />
* <error>You are not authorized to use this functionality</error> - User does not have rights to manage Calling Cards.<br />
* <error>Access Denied</error> - User does not have access to Calling Cards.<br />
* <error>Wrong calling cards group ID</error> - User supplied wrong Calling Cards group ID.<br />
* <error>Calling cards groups were not found</error> - Calling cards groups were not found.<br />
<br><br><br />
<br />
=See also=<br />
<br />
* [[MOR API]]</div>Edvinashttps://wiki.kolmisoft.com/index.php?title=MOR_API&diff=20286MOR API2015-11-04T13:31:40Z<p>Edvinas: /* Calling Cards */</p>
<hr />
<div>[[File:warning.png|100px|alt="warning"|link=]]<big><big><big>IMPORTANT!!! API methods described here are for MOR X6. For previous versions please check appropriate [http://wiki.kolmisoft.com/index.php/MOR_Manual#Old_Manuals manual].</big></big></big><br />
[[File:api.png|right|alt="api"|link=]]<br />
<mkmeta>Application Program Interface for MOR Class 5 Softswitch</mkmeta><br />
<br />
<br><br><br />
=About=<br />
MOR API lets other software interact with MOR without knowing the internal structure of the database (DB) and other logic.<br />
<br />
MOR accepts requests by HTML POST and returns results in XML.<br />
<br />
<br><br><br />
=MOR users that are allowed to use MOR API=<br />
* Admin<br />
* Reseller<br />
* Accountant - only by using Admin Hash and Secret key<br />
* Simple User<br />
<br />
<br><br><br />
<br />
=Functions=<br />
<br />
== API Related ==<br />
* [[API Configuration]] – configuration options for API.<br />
* [[MOR API hash construction|Hash construction]] – how to construct hash to authenticate data over API.<br />
<br />
<br><br />
==Balance==<br />
* [[MOR API user balance update | user_balance_update]] (change_user_balance) – changes User's Balance<br />
Various methods to retrieve User balance<br />
* [[MOR API user_balance_get|user_balance_get]] (balance) – retrieves a User Balance.<br />
* [[Balance in phone | user_simple_balance_get]] (simple_balance) – gets User's Balance<br />
* [[MOR API user balance get by psw | user_balance_get_by_psw]] – gets User's Balance by his owned Device's Password<br />
* [[MOR API User Balance get by Username | user_balance_get_by_username]] – gets User's Balance by his owned Device's Username<br />
<br />
<br><br />
<br />
==Callback==<br />
* [[MOR API callback init|callback_init]] (callback) – initiates callback.<br />
<br />
<br><br />
==Calling Cards==<br />
* [[MOR API card_by_cli_update| card_by_cli_update]] (cc_by_cli) – creates and updates calling cards, including adding and transferring funds, by being identified according the Caller_ID.<br />
* [[MOR API card_from_group_sell| card_from_group_sell]] (buy_card_from_callingroup) – sells cards from calling card group.<br />
* [[MOR API card_group_get| card_group_get]] (show_calling_card_group) – show calling group info.<br />
* [[MOR API card_balance_get| card_balance_get]] (card_balance_get) – show card's balance.<br />
* [[MOR API card_payment_add| card_payment_add]] – add payment to the calling card.<br />
* [[MOR_API_Calling_Cards_create| calling_cards_create]] – create Calling Cards.<br />
<br />
<br><br />
<br />
==Calls==<br />
* [[MOR API user calls get|user_calls_get]] (user_calls) – retrieves a list of calls in a selected time period for a user/device.<br />
<br />
<br><br />
<br />
==Conflines==<br />
* [[MOR API conflines update|conflines_update]] – changes settings for API, Default User or Default Device.<br />
<br />
<br><br />
==Credit notes==<br />
* [[MOR API credit_notes_get| credit_notes_get]] (credit_notes) – credit notes list.<br />
* [[MOR API credit_note_update| credit_note_update]] – credit note update.<br />
* [[MOR API credit_notes_create| credit_note_create]] – credit note create.<br />
* [[MOR API credit_notes_delete| credit_note_delete]] – credit note delete.<br />
<br />
<br><br />
==Device==<br />
* [[MOR API device create| device_create]] – create device<br />
* [[MOR API device delete| device_delete]] (delete_device) – delete device<br />
* [[MOR API devices get | devices_get]] (device_list) – users device list<br />
* [[MOR API device callflow get| device_callflow_get]] - returns information about specified device callflow state.<br />
* [[MOR API device callflow update | device_callflow_update]] – updates information of specified device callflow state. <br />
* [[MOR API CLI info get | cli_info_get]] (cli_get_info) – shows id of device where CLI belongs.<br />
* [[MOR API CLI delete | cli_delete]] – deletes specified CLI. <br />
* [[MOR API CLI add | cli_add]] – creates CLI and assigns it to the specified device.<br />
* [[MOR API device clis get | device_clis_get]] – CLIs list by User and/or Device<br />
* [[MOR API device details get | device_details_get]] – shows all information about specified device.<br />
* [[MOR_API_device_update | device_update]] – updates location_id of selected Device.<br />
<br />
<br><br />
<br />
==DID==<br />
<br />
* [[MOR API dids get| dids_get]] – get list of particular DIDs<br />
* [[MOR API did_create| did_create]] – DID create<br />
* [[MOR_API_did_device_assign| did_device_assign]] (did_assign_device) – Assign Device to DID<br />
* [[MOR_API_did_device_unassign| did_device_unassign]] (did_unassign_device) – Unassign Device from DID<br />
* [[MOR_API_did_details_update| did_details_update]] (did_details_update) – Update DID details <br />
* [[MOR API did subscription stop|did_subscription_stop]] – STOP DID subscription<br />
<br />
<br><br />
<br />
==Email==<br />
* [[MOR API email send| email_send]] (send_email) – send Email.<br />
<br />
<br><br />
==Financial statements==<br />
* [[MOR API financial_statements_get| financial_statements_get]] (financial_statements) – financial statements list.<br />
<br />
<br><br />
==Invoices==<br />
* [[MOR API invoices_get|invoices_get]] (invoices) – retrieves a list of invoices in a selected time period.<br />
<br />
<br><br />
==Login==<br />
* [[MOR API user_login|user_login]] (login) – logs user in to MOR.<br />
* [[MOR API user_logout|user_logout]] (logout) – logs user out from MOR.<br />
<br />
<br><br />
==Monitorings==<br />
* [[MOR API ma_activate_api| ma_activate]] – turn on monitorings addon<br />
<br />
<br><br />
==Payments==<br />
* [[MOR API payment_create| payment_create]] (create_payment) – create payment.<br />
* [[MOR API payments_get| payments_get]] (payments_list) – payments list.<br />
<br />
<br><br />
==Phonebooks==<br />
* [[MOR API phonebooks_get| phonebooks_get]] (phonebooks_api ) – phonebooks list.<br />
* [[MOR API phonebook_edit| phonebook_edit]] (phonebook_edit_api) – edit phonebook.<br />
* [[MOR API phonebook_record_create| phonebook_record_create]] – create phonebook.<br />
<br />
<br><br />
==Quickforwards==<br />
* [[MOR API Quickforwards get| quickforwards_dids_get]] (quickforwards_dids_get) – get Quickforwards.<br />
* [[MOR API Quickforwards update| quickforwards_did_update]] (quickforwards_did_update) – update Quickforwards.<br />
* [[MOR API Quickforwards delete| quickforwards_did_delete]] (quickforwards_did_delete) – delete Quickforwards.<br />
<br />
<br><br />
==Rates==<br />
* [[MOR API rate get|rate_get]] (rate) – check user rate by prefix<br />
* [[MOR API tariff rates get| tariff_rates_get]] (get_tariff) – get all tariff's rates<br />
* [[MOR API tariff_retail_import | tariff_retail_import ]] (import_relail_tariff) – import xml retail tariff<br />
* [[MOR API tariff_wholesale_update | tariff_wholesale_update ]] (wholesale_tariff) – update or create wholesale tariff<br />
<br />
<br><br />
==Services==<br />
* [[MOR API Service create| service_create]] – create Service.<br />
* [[MOR API Service delete| service_delete]] – delete Service.<br />
* [[MOR API Services get| services_get]] – get Services.<br />
* [[MOR API Service update| service_update]] – update Service.<br />
<br />
<br><br />
<br />
==SMS==<br />
* [[MOR API sms send| sms_send]] (send_sms) – send SMS.<br />
* [[MOR_API_user_sms_service_subscribe | user_sms_service_subscribe ]] – User subscription to SMS Service.<br />
<br />
<br><br />
==Subscriptions==<br />
* [[MOR API subscription delete|subscription_delete]] - Subscription delete.<br />
* [[MOR API Subscriptions get|subscriptions_get]] - Subscriptions get.<br />
* [[MOR API subscription create|subscription_create]] - Subscription create.<br />
* [[MOR API subscription update|subscription_update]] - Subscription delete.<br />
<br><br />
<br />
==User==<br />
<br />
* [[MOR API user_register| user_register]] – create new user from params.<br />
* [[MOR API user_details_get | user_details_get]] (user_details) – gets user details.<br />
* [[MOR_API_user_details_update| user_details_update]] (user_update_api) – update user from params.<br />
<br><br />
<br />
== Resellers ==<br />
* [[MOR API reseller group create]] - create new Reseller Group<br />
<br />
<br><br />
==Version==<br />
* [[MOR API system version get| system_version_get]] (get_version) – get MOR version number.<br />
<br />
<br><br />
= Examples =<br />
* [[MOR API PHP Examples]]<br />
<br />
<br><br><br />
=HTML POST=<br />
All requests are in a similar format:<br />
<br />
HTML POST: http://<SERVER_IP>/billing/api/<function>?u=username<br />
<br />
* username - the user name and password of the user who is asking for the data. <br />
<br />
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.<br />
<br><br><br />
=Useful to know=<br />
<br />
* 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:<br />
** Value of money will be returned in Default System [[Currencies|Currency]].<br />
** Date will not be affected of [[Configuration_from_GUI#Visual| Default date format]] setting.<br />
** Value of money will not be affected of [[Configuration_from_GUI#Visual|Number digits]] setting.<br />
<br />
<br><br><br />
=See also =<br />
* [[API Configuration]]<br />
* [[MOR integration]]<br />
* [[How to block access to some API functions]]<br />
* [[API specification to be implemented in the future]]</div>Edvinashttps://wiki.kolmisoft.com/index.php?title=MOR_API&diff=20285MOR API2015-11-04T13:30:39Z<p>Edvinas: /* Calling Cards */</p>
<hr />
<div>[[File:warning.png|100px|alt="warning"|link=]]<big><big><big>IMPORTANT!!! API methods described here are for MOR X6. For previous versions please check appropriate [http://wiki.kolmisoft.com/index.php/MOR_Manual#Old_Manuals manual].</big></big></big><br />
[[File:api.png|right|alt="api"|link=]]<br />
<mkmeta>Application Program Interface for MOR Class 5 Softswitch</mkmeta><br />
<br />
<br><br><br />
=About=<br />
MOR API lets other software interact with MOR without knowing the internal structure of the database (DB) and other logic.<br />
<br />
MOR accepts requests by HTML POST and returns results in XML.<br />
<br />
<br><br><br />
=MOR users that are allowed to use MOR API=<br />
* Admin<br />
* Reseller<br />
* Accountant - only by using Admin Hash and Secret key<br />
* Simple User<br />
<br />
<br><br><br />
<br />
=Functions=<br />
<br />
== API Related ==<br />
* [[API Configuration]] – configuration options for API.<br />
* [[MOR API hash construction|Hash construction]] – how to construct hash to authenticate data over API.<br />
<br />
<br><br />
==Balance==<br />
* [[MOR API user balance update | user_balance_update]] (change_user_balance) – changes User's Balance<br />
Various methods to retrieve User balance<br />
* [[MOR API user_balance_get|user_balance_get]] (balance) – retrieves a User Balance.<br />
* [[Balance in phone | user_simple_balance_get]] (simple_balance) – gets User's Balance<br />
* [[MOR API user balance get by psw | user_balance_get_by_psw]] – gets User's Balance by his owned Device's Password<br />
* [[MOR API User Balance get by Username | user_balance_get_by_username]] – gets User's Balance by his owned Device's Username<br />
<br />
<br><br />
<br />
==Callback==<br />
* [[MOR API callback init|callback_init]] (callback) – initiates callback.<br />
<br />
<br><br />
==Calling Cards==<br />
* [[MOR API card_by_cli_update| card_by_cli_update]] (cc_by_cli) – creates and updates calling cards, including adding and transferring funds, by being identified according the Caller_ID.<br />
* [[MOR API card_from_group_sell| card_from_group_sell]] (buy_card_from_callingroup) – sells cards from calling card group.<br />
* [[MOR API card_group_get| card_group_get]] (show_calling_card_group) – show calling group info.<br />
* [[MOR API card_balance_get| card_balance_get]] (card_balance_get) – show card's balance.<br />
* [[MOR API card_payment_add| card_payment_add]] – add payment to the calling card.<br />
* [[MOR_API_Calling_Cards_create| calling_cards_create]] – create calling cards.<br />
<br />
<br><br />
<br />
==Calls==<br />
* [[MOR API user calls get|user_calls_get]] (user_calls) – retrieves a list of calls in a selected time period for a user/device.<br />
<br />
<br><br />
<br />
==Conflines==<br />
* [[MOR API conflines update|conflines_update]] – changes settings for API, Default User or Default Device.<br />
<br />
<br><br />
==Credit notes==<br />
* [[MOR API credit_notes_get| credit_notes_get]] (credit_notes) – credit notes list.<br />
* [[MOR API credit_note_update| credit_note_update]] – credit note update.<br />
* [[MOR API credit_notes_create| credit_note_create]] – credit note create.<br />
* [[MOR API credit_notes_delete| credit_note_delete]] – credit note delete.<br />
<br />
<br><br />
==Device==<br />
* [[MOR API device create| device_create]] – create device<br />
* [[MOR API device delete| device_delete]] (delete_device) – delete device<br />
* [[MOR API devices get | devices_get]] (device_list) – users device list<br />
* [[MOR API device callflow get| device_callflow_get]] - returns information about specified device callflow state.<br />
* [[MOR API device callflow update | device_callflow_update]] – updates information of specified device callflow state. <br />
* [[MOR API CLI info get | cli_info_get]] (cli_get_info) – shows id of device where CLI belongs.<br />
* [[MOR API CLI delete | cli_delete]] – deletes specified CLI. <br />
* [[MOR API CLI add | cli_add]] – creates CLI and assigns it to the specified device.<br />
* [[MOR API device clis get | device_clis_get]] – CLIs list by User and/or Device<br />
* [[MOR API device details get | device_details_get]] – shows all information about specified device.<br />
* [[MOR_API_device_update | device_update]] – updates location_id of selected Device.<br />
<br />
<br><br />
<br />
==DID==<br />
<br />
* [[MOR API dids get| dids_get]] – get list of particular DIDs<br />
* [[MOR API did_create| did_create]] – DID create<br />
* [[MOR_API_did_device_assign| did_device_assign]] (did_assign_device) – Assign Device to DID<br />
* [[MOR_API_did_device_unassign| did_device_unassign]] (did_unassign_device) – Unassign Device from DID<br />
* [[MOR_API_did_details_update| did_details_update]] (did_details_update) – Update DID details <br />
* [[MOR API did subscription stop|did_subscription_stop]] – STOP DID subscription<br />
<br />
<br><br />
<br />
==Email==<br />
* [[MOR API email send| email_send]] (send_email) – send Email.<br />
<br />
<br><br />
==Financial statements==<br />
* [[MOR API financial_statements_get| financial_statements_get]] (financial_statements) – financial statements list.<br />
<br />
<br><br />
==Invoices==<br />
* [[MOR API invoices_get|invoices_get]] (invoices) – retrieves a list of invoices in a selected time period.<br />
<br />
<br><br />
==Login==<br />
* [[MOR API user_login|user_login]] (login) – logs user in to MOR.<br />
* [[MOR API user_logout|user_logout]] (logout) – logs user out from MOR.<br />
<br />
<br><br />
==Monitorings==<br />
* [[MOR API ma_activate_api| ma_activate]] – turn on monitorings addon<br />
<br />
<br><br />
==Payments==<br />
* [[MOR API payment_create| payment_create]] (create_payment) – create payment.<br />
* [[MOR API payments_get| payments_get]] (payments_list) – payments list.<br />
<br />
<br><br />
==Phonebooks==<br />
* [[MOR API phonebooks_get| phonebooks_get]] (phonebooks_api ) – phonebooks list.<br />
* [[MOR API phonebook_edit| phonebook_edit]] (phonebook_edit_api) – edit phonebook.<br />
* [[MOR API phonebook_record_create| phonebook_record_create]] – create phonebook.<br />
<br />
<br><br />
==Quickforwards==<br />
* [[MOR API Quickforwards get| quickforwards_dids_get]] (quickforwards_dids_get) – get Quickforwards.<br />
* [[MOR API Quickforwards update| quickforwards_did_update]] (quickforwards_did_update) – update Quickforwards.<br />
* [[MOR API Quickforwards delete| quickforwards_did_delete]] (quickforwards_did_delete) – delete Quickforwards.<br />
<br />
<br><br />
==Rates==<br />
* [[MOR API rate get|rate_get]] (rate) – check user rate by prefix<br />
* [[MOR API tariff rates get| tariff_rates_get]] (get_tariff) – get all tariff's rates<br />
* [[MOR API tariff_retail_import | tariff_retail_import ]] (import_relail_tariff) – import xml retail tariff<br />
* [[MOR API tariff_wholesale_update | tariff_wholesale_update ]] (wholesale_tariff) – update or create wholesale tariff<br />
<br />
<br><br />
==Services==<br />
* [[MOR API Service create| service_create]] – create Service.<br />
* [[MOR API Service delete| service_delete]] – delete Service.<br />
* [[MOR API Services get| services_get]] – get Services.<br />
* [[MOR API Service update| service_update]] – update Service.<br />
<br />
<br><br />
<br />
==SMS==<br />
* [[MOR API sms send| sms_send]] (send_sms) – send SMS.<br />
* [[MOR_API_user_sms_service_subscribe | user_sms_service_subscribe ]] – User subscription to SMS Service.<br />
<br />
<br><br />
==Subscriptions==<br />
* [[MOR API subscription delete|subscription_delete]] - Subscription delete.<br />
* [[MOR API Subscriptions get|subscriptions_get]] - Subscriptions get.<br />
* [[MOR API subscription create|subscription_create]] - Subscription create.<br />
* [[MOR API subscription update|subscription_update]] - Subscription delete.<br />
<br><br />
<br />
==User==<br />
<br />
* [[MOR API user_register| user_register]] – create new user from params.<br />
* [[MOR API user_details_get | user_details_get]] (user_details) – gets user details.<br />
* [[MOR_API_user_details_update| user_details_update]] (user_update_api) – update user from params.<br />
<br><br />
<br />
== Resellers ==<br />
* [[MOR API reseller group create]] - create new Reseller Group<br />
<br />
<br><br />
==Version==<br />
* [[MOR API system version get| system_version_get]] (get_version) – get MOR version number.<br />
<br />
<br><br />
= Examples =<br />
* [[MOR API PHP Examples]]<br />
<br />
<br><br><br />
=HTML POST=<br />
All requests are in a similar format:<br />
<br />
HTML POST: http://<SERVER_IP>/billing/api/<function>?u=username<br />
<br />
* username - the user name and password of the user who is asking for the data. <br />
<br />
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.<br />
<br><br><br />
=Useful to know=<br />
<br />
* 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:<br />
** Value of money will be returned in Default System [[Currencies|Currency]].<br />
** Date will not be affected of [[Configuration_from_GUI#Visual| Default date format]] setting.<br />
** Value of money will not be affected of [[Configuration_from_GUI#Visual|Number digits]] setting.<br />
<br />
<br><br><br />
=See also =<br />
* [[API Configuration]]<br />
* [[MOR integration]]<br />
* [[How to block access to some API functions]]<br />
* [[API specification to be implemented in the future]]</div>Edvinashttps://wiki.kolmisoft.com/index.php?title=MOR_API&diff=20284MOR API2015-11-04T13:30:28Z<p>Edvinas: /* Calling Cards */</p>
<hr />
<div>[[File:warning.png|100px|alt="warning"|link=]]<big><big><big>IMPORTANT!!! API methods described here are for MOR X6. For previous versions please check appropriate [http://wiki.kolmisoft.com/index.php/MOR_Manual#Old_Manuals manual].</big></big></big><br />
[[File:api.png|right|alt="api"|link=]]<br />
<mkmeta>Application Program Interface for MOR Class 5 Softswitch</mkmeta><br />
<br />
<br><br><br />
=About=<br />
MOR API lets other software interact with MOR without knowing the internal structure of the database (DB) and other logic.<br />
<br />
MOR accepts requests by HTML POST and returns results in XML.<br />
<br />
<br><br><br />
=MOR users that are allowed to use MOR API=<br />
* Admin<br />
* Reseller<br />
* Accountant - only by using Admin Hash and Secret key<br />
* Simple User<br />
<br />
<br><br><br />
<br />
=Functions=<br />
<br />
== API Related ==<br />
* [[API Configuration]] – configuration options for API.<br />
* [[MOR API hash construction|Hash construction]] – how to construct hash to authenticate data over API.<br />
<br />
<br><br />
==Balance==<br />
* [[MOR API user balance update | user_balance_update]] (change_user_balance) – changes User's Balance<br />
Various methods to retrieve User balance<br />
* [[MOR API user_balance_get|user_balance_get]] (balance) – retrieves a User Balance.<br />
* [[Balance in phone | user_simple_balance_get]] (simple_balance) – gets User's Balance<br />
* [[MOR API user balance get by psw | user_balance_get_by_psw]] – gets User's Balance by his owned Device's Password<br />
* [[MOR API User Balance get by Username | user_balance_get_by_username]] – gets User's Balance by his owned Device's Username<br />
<br />
<br><br />
<br />
==Callback==<br />
* [[MOR API callback init|callback_init]] (callback) – initiates callback.<br />
<br />
<br><br />
==Calling Cards==<br />
* [[MOR API card_by_cli_update| card_by_cli_update]] (cc_by_cli) – creates and updates calling cards, including adding and transferring funds, by being identified according the Caller_ID.<br />
* [[MOR API card_from_group_sell| card_from_group_sell]] (buy_card_from_callingroup) – sells cards from calling card group.<br />
* [[MOR API card_group_get| card_group_get]] (show_calling_card_group) – show calling group info.<br />
* [[MOR API card_balance_get| card_balance_get]] (card_balance_get) – show card's balance.<br />
* [[MOR API card_payment_add| card_payment_add]] – add payment to the calling card.<br />
* [[MOR_API_Calling_Cards_create| alling_cards_create]] – create calling cards.<br />
<br />
<br><br />
<br />
==Calls==<br />
* [[MOR API user calls get|user_calls_get]] (user_calls) – retrieves a list of calls in a selected time period for a user/device.<br />
<br />
<br><br />
<br />
==Conflines==<br />
* [[MOR API conflines update|conflines_update]] – changes settings for API, Default User or Default Device.<br />
<br />
<br><br />
==Credit notes==<br />
* [[MOR API credit_notes_get| credit_notes_get]] (credit_notes) – credit notes list.<br />
* [[MOR API credit_note_update| credit_note_update]] – credit note update.<br />
* [[MOR API credit_notes_create| credit_note_create]] – credit note create.<br />
* [[MOR API credit_notes_delete| credit_note_delete]] – credit note delete.<br />
<br />
<br><br />
==Device==<br />
* [[MOR API device create| device_create]] – create device<br />
* [[MOR API device delete| device_delete]] (delete_device) – delete device<br />
* [[MOR API devices get | devices_get]] (device_list) – users device list<br />
* [[MOR API device callflow get| device_callflow_get]] - returns information about specified device callflow state.<br />
* [[MOR API device callflow update | device_callflow_update]] – updates information of specified device callflow state. <br />
* [[MOR API CLI info get | cli_info_get]] (cli_get_info) – shows id of device where CLI belongs.<br />
* [[MOR API CLI delete | cli_delete]] – deletes specified CLI. <br />
* [[MOR API CLI add | cli_add]] – creates CLI and assigns it to the specified device.<br />
* [[MOR API device clis get | device_clis_get]] – CLIs list by User and/or Device<br />
* [[MOR API device details get | device_details_get]] – shows all information about specified device.<br />
* [[MOR_API_device_update | device_update]] – updates location_id of selected Device.<br />
<br />
<br><br />
<br />
==DID==<br />
<br />
* [[MOR API dids get| dids_get]] – get list of particular DIDs<br />
* [[MOR API did_create| did_create]] – DID create<br />
* [[MOR_API_did_device_assign| did_device_assign]] (did_assign_device) – Assign Device to DID<br />
* [[MOR_API_did_device_unassign| did_device_unassign]] (did_unassign_device) – Unassign Device from DID<br />
* [[MOR_API_did_details_update| did_details_update]] (did_details_update) – Update DID details <br />
* [[MOR API did subscription stop|did_subscription_stop]] – STOP DID subscription<br />
<br />
<br><br />
<br />
==Email==<br />
* [[MOR API email send| email_send]] (send_email) – send Email.<br />
<br />
<br><br />
==Financial statements==<br />
* [[MOR API financial_statements_get| financial_statements_get]] (financial_statements) – financial statements list.<br />
<br />
<br><br />
==Invoices==<br />
* [[MOR API invoices_get|invoices_get]] (invoices) – retrieves a list of invoices in a selected time period.<br />
<br />
<br><br />
==Login==<br />
* [[MOR API user_login|user_login]] (login) – logs user in to MOR.<br />
* [[MOR API user_logout|user_logout]] (logout) – logs user out from MOR.<br />
<br />
<br><br />
==Monitorings==<br />
* [[MOR API ma_activate_api| ma_activate]] – turn on monitorings addon<br />
<br />
<br><br />
==Payments==<br />
* [[MOR API payment_create| payment_create]] (create_payment) – create payment.<br />
* [[MOR API payments_get| payments_get]] (payments_list) – payments list.<br />
<br />
<br><br />
==Phonebooks==<br />
* [[MOR API phonebooks_get| phonebooks_get]] (phonebooks_api ) – phonebooks list.<br />
* [[MOR API phonebook_edit| phonebook_edit]] (phonebook_edit_api) – edit phonebook.<br />
* [[MOR API phonebook_record_create| phonebook_record_create]] – create phonebook.<br />
<br />
<br><br />
==Quickforwards==<br />
* [[MOR API Quickforwards get| quickforwards_dids_get]] (quickforwards_dids_get) – get Quickforwards.<br />
* [[MOR API Quickforwards update| quickforwards_did_update]] (quickforwards_did_update) – update Quickforwards.<br />
* [[MOR API Quickforwards delete| quickforwards_did_delete]] (quickforwards_did_delete) – delete Quickforwards.<br />
<br />
<br><br />
==Rates==<br />
* [[MOR API rate get|rate_get]] (rate) – check user rate by prefix<br />
* [[MOR API tariff rates get| tariff_rates_get]] (get_tariff) – get all tariff's rates<br />
* [[MOR API tariff_retail_import | tariff_retail_import ]] (import_relail_tariff) – import xml retail tariff<br />
* [[MOR API tariff_wholesale_update | tariff_wholesale_update ]] (wholesale_tariff) – update or create wholesale tariff<br />
<br />
<br><br />
==Services==<br />
* [[MOR API Service create| service_create]] – create Service.<br />
* [[MOR API Service delete| service_delete]] – delete Service.<br />
* [[MOR API Services get| services_get]] – get Services.<br />
* [[MOR API Service update| service_update]] – update Service.<br />
<br />
<br><br />
<br />
==SMS==<br />
* [[MOR API sms send| sms_send]] (send_sms) – send SMS.<br />
* [[MOR_API_user_sms_service_subscribe | user_sms_service_subscribe ]] – User subscription to SMS Service.<br />
<br />
<br><br />
==Subscriptions==<br />
* [[MOR API subscription delete|subscription_delete]] - Subscription delete.<br />
* [[MOR API Subscriptions get|subscriptions_get]] - Subscriptions get.<br />
* [[MOR API subscription create|subscription_create]] - Subscription create.<br />
* [[MOR API subscription update|subscription_update]] - Subscription delete.<br />
<br><br />
<br />
==User==<br />
<br />
* [[MOR API user_register| user_register]] – create new user from params.<br />
* [[MOR API user_details_get | user_details_get]] (user_details) – gets user details.<br />
* [[MOR_API_user_details_update| user_details_update]] (user_update_api) – update user from params.<br />
<br><br />
<br />
== Resellers ==<br />
* [[MOR API reseller group create]] - create new Reseller Group<br />
<br />
<br><br />
==Version==<br />
* [[MOR API system version get| system_version_get]] (get_version) – get MOR version number.<br />
<br />
<br><br />
= Examples =<br />
* [[MOR API PHP Examples]]<br />
<br />
<br><br><br />
=HTML POST=<br />
All requests are in a similar format:<br />
<br />
HTML POST: http://<SERVER_IP>/billing/api/<function>?u=username<br />
<br />
* username - the user name and password of the user who is asking for the data. <br />
<br />
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.<br />
<br><br><br />
=Useful to know=<br />
<br />
* 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:<br />
** Value of money will be returned in Default System [[Currencies|Currency]].<br />
** Date will not be affected of [[Configuration_from_GUI#Visual| Default date format]] setting.<br />
** Value of money will not be affected of [[Configuration_from_GUI#Visual|Number digits]] setting.<br />
<br />
<br><br><br />
=See also =<br />
* [[API Configuration]]<br />
* [[MOR integration]]<br />
* [[How to block access to some API functions]]<br />
* [[API specification to be implemented in the future]]</div>Edvinashttps://wiki.kolmisoft.com/index.php?title=MOR_API_Calling_Cards_create&diff=20283MOR API Calling Cards create2015-11-04T13:28:59Z<p>Edvinas: Created page with '=Description= MOR API Calling Cards create <br><br> =Usage= * Call: /api/calling_cards_create * Methods: POST, GET(if allowed, not recomended) <br><br> ===Parameters=== Pa…'</p>
<hr />
<div>=Description=<br />
[[MOR API]] Calling Cards create<br />
<br><br><br />
=Usage=<br />
<br />
* Call: /api/calling_cards_create<br />
* Methods: POST, GET(if allowed, not recomended)<br />
<br><br><br />
===Parameters===<br />
<br />
<br />
Parameters which are '''included''' into hash:<br />
<br />
* card_group_id - id of a Card Group '''Required'''.<br />
* cards_from - Cards' (to be created) number range beginning '''Required'''.<br />
* cards_till - Cards' (to be created) number range ending '''Required'''.<br />
<br />
'''* Note that cards_from <= cards_till. Both of the previous parameters are 10-digit-long integers.'''<br><br />
'''* Note that the parameters are shown in the same order as they need to be when generating the hash. The last parameter in a row is an API_Secret_Key.'''<br />
<br />
<br><br><br />
Parameters which are '''not included''' into hash:<br />
<br />
* '''[[MOR API hash construction | hash]]''' - SHA1 hash constructed using the '''parameters''' which are listed above. Note that the parameters are shown in the same order as they need to be when generating the hash. The last parameter in a row is '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.<br><br />
* '''u''' - username for authentication. '''Required'''.<br />
* batch_number - batch number for the Calling Cards.<br />
* min_balance - minimum balance for the Calling Cards.<br />
* distributor_id - Calling Cards' distributor's (User's) id.<br />
* language - Language for the Calling Cards.<br />
<br><br><br />
<br />
===Request===<br />
<br />
We have u = admin, API Secret Key = secret<br />
<br />
We send:<br />
<br />
HTML POST: http://<SERVER_IP>/billing/api/calling_cards_create?u=admin&card_group_id=1&cards_from=1000000025&cards_till=1000000035&batch_number=50&min_balance=15&language=en&distributor_id=2&hash=7e112ededcfee097cce21b6201c6d2a00dda1f4c<br />
<br />
* Now we can find 11 newly created Calling Cards (number range: 1000000025-1000000035) in the Card Group's (id = 1) Cards' list.'''<br><br />
'''* Note that some Calling Cards may fail on creation if a given range overlaps with already existing Cards in a Card Group.'''<br><br />
'''* Note that passing invalid optional parameters will not be notified. Default values will be used instead.'''<br><br />
'''* Note that a Username and a Password are not included into hash'''<br />
<br><br><br />
===Returns===<br />
<br />
'''Success'''<br />
<br />
<?xml version="1.0" encoding="UTF-8"?><br />
<page><br />
<status><br />
<success>Cards created: 11/11</success><br />
</status><br />
</page><br />
<br><br><br />
----<br />
<br />
'''Errors'''<br />
<br />
* <error>Access Denied</error> - User is not authorized or is a Simple User. Only Admin, Reseller or Accounant can use this API method. <br />
* <error>Incorrect hash</error> - hash is not correct. Check API_Secret_Key and order or parameters while concatenating a hash_string.<br />
* <error>You are not authorized to use this functionality</error> - User has no permissions to manage Calling Cards. <br />
* <error>Bad login</error> - User is not authorized (possibly wrong Username). <br />
* <error>Card Group was not found</error> - Card Group under a given id does not exist or a card_group_id parameter is missing from the API parameters' list.<br />
* <error>Cards from was not found</error> - required cards_from parameter is missing.<br />
* <error>Cards till was not found</error> - required cards_till parameter is missing. <br />
* <error>Cards from is in incorrect format</error> - cards_from parameter's value is not numeric or is not 10-digit-long. <br />
* <error>Cards till is in incorrect format</error> - cards_till parameter's value is not numeric or is not 10-digit-long. <br />
* <error>Cards from must not be greater than Cards till</error> - cards_from parameter's value must not be grater than cards_till parameter's value. No proper Cards' number range is possible.<br />
* <error>PIN is too short for this interval</error> - Card Group does not provide enough PIN codes for a given Cards' number range. <br />
<br />
Example:<br />
<br />
<?xml version="1.0" encoding="UTF-8"?><br />
<page><br />
<status><br />
<error>Cards from must not be greater than Cards till</error><br />
</status><br />
</page><br />
<br><br><br />
<br />
=See also=<br />
<br />
* [[MOR API]]</div>Edvinashttps://wiki.kolmisoft.com/index.php?title=MOR_API_device_clis_get&diff=20044MOR API device clis get2015-09-01T14:17:42Z<p>Edvinas: </p>
<hr />
<div>=Description=<br />
<!---This functionality is available in MOR X5 and MOR X6---><br />
[[MOR API]] Device clis get<br />
<br />
Please note that accountant and reseller must have permissions to use this API. <br />
<br />
<br><br><br />
=Usage=<br />
<br />
* Call: /api/device_clis_get<br />
* Methods: POST, GET(if allowed, not recomended)<br />
<br />
<br><br><br />
===Parametres===<br />
<br />
* u – username to login. '''Required'''.<br />
* devices_id – this is the id of users device. '''Optional'''.<br />
* users_id - this is the id of the user whose CLIs will be selected. '''Optional'''<br />
* [[MOR API hash construction | hash]] – SHA1 hash constructed using '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.<br />
<br />
<br><br><br />
<br />
===Request===<br />
<br />
We have API Secret Key = secret <br /><br />
We send:<br />
<br />
HTML POST: http://<server_ip>/billing/api/device_clis_get?u=admin&devices_id=6&users_id=3&e5e9fa1ba31ecd1ae84f75caaa474f3a663f05f4 <br />
<br />
'''* Note that username and password are not included in hash'''<br />
<br><br><br />
<br />
===Returns===<br />
<br />
'''Success'''<br />
<br />
<page><br />
<status><br />
<cli_id>3</cli_id><br />
<cli_cli>45456464</cli_cli><br />
<cli_device>IAX2/ipauth4aa73a4300</cli_device><br />
<cli_description>Test Reseller</cli_description><br />
<cli_added_at>2015-08-31 12:40:23 +0300</cli_added_at><br />
<cli_updated_at>2015-08-31 16:14:48 +0300</cli_updated_at><br />
<cli_comment>rhrtghg</cli_comment><br />
<cli_email_callback>0</cli_email_callback><br />
<cli_banned>0</cli_banned><br />
</status><br />
</page><br />
<br />
<br />
<br><br><br />
----<br />
<br />
'''Errors'''<br />
* <error>Device was not found</error> – Device was not found.<br />
* <error>CLIs were not found</error> – No CLIs found.<br />
* <error>Access Denied</error> – username (u) is not found.<br />
* <error>You are not authorized to use this functionality</error> – username (u) is reseller or accountant without permissions.<br />
* <error>User was not found</error> – specified user via user_id does not exist.<br />
* <error>Incorrect hash</error> – Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.<br />
<br><br><br />
<br />
=See also=<br />
<br />
* [[MOR API]]</div>Edvinashttps://wiki.kolmisoft.com/index.php?title=MOR_API_device_clis_get&diff=20043MOR API device clis get2015-09-01T13:39:26Z<p>Edvinas: </p>
<hr />
<div>=Description=<br />
<!---This functionality is available in MOR X5 and MOR X6---><br />
[[MOR API]] Device clis get<br />
<br />
Please note that only admins users and admin can use this API. <br />
<br />
<br><br><br />
=Usage=<br />
<br />
* Call: /api/voucher_use<br />
* Methods: POST, GET(if allowed, not recomended)<br />
<br />
<br><br><br />
===Parametres===<br />
<br />
* u – username to login. '''Required'''.<br />
* devices_id – this is the id of users device. '''Optional'''.<br />
* users_id - this is the id of the user whose CLIs will be selected. '''Optional'''<br />
* [[MOR API hash construction | hash]] – SHA1 hash constructed using '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.<br />
<br />
<br><br><br />
<br />
===Request===<br />
<br />
We have API Secret Key = secret <br /><br />
We send:<br />
<br />
HTML POST: http://<server_ip>/billing/api/device_clis_get?u=admin&devices_id=6&users_id=3&e5e9fa1ba31ecd1ae84f75caaa474f3a663f05f4 <br />
<br />
'''* Note that username and password are not included in hash'''<br />
<br><br><br />
<br />
===Returns===<br />
<br />
'''Success'''<br />
<br />
<page><br />
<status><br />
<cli_id>3</cli_id><br />
<cli_cli>45456464</cli_cli><br />
<cli_device>IAX2/ipauth4aa73a4300</cli_device><br />
<cli_description>Test Reseller</cli_description><br />
<cli_added_at>2015-08-31 12:40:23 +0300</cli_added_at><br />
<cli_updated_at>2015-08-31 16:14:48 +0300</cli_updated_at><br />
<cli_comment>rhrtghg</cli_comment><br />
<cli_email_callback>0</cli_email_callback><br />
<cli_banned>0</cli_banned><br />
</status><br />
</page><br />
<br />
<br />
<br><br><br />
----<br />
<br />
'''Errors'''<br />
* <error>Device was not found</error> – Device was not found.<br />
* <error>CLIs were not found</error> – No CLIs found.<br />
* <error>Access Denied</error> – username (u) is not found.<br />
* <error>You are not authorized to use this functionality</error> – username (u) is reseller or accountant without permissions.<br />
* <error>User was not found</error> – specified user via user_id does not exist.<br />
* <error>Incorrect hash</error> – Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.<br />
<br><br><br />
<br />
=See also=<br />
<br />
* [[MOR API]]</div>Edvinashttps://wiki.kolmisoft.com/index.php?title=MOR_API_device_clis_get&diff=20042MOR API device clis get2015-09-01T13:37:43Z<p>Edvinas: Created page with '=Description= <!---This functionality is available in MOR X5 and MOR X6---> MOR API Device clis get Please note that only admins users and admin can use this API. <br><br>…'</p>
<hr />
<div>=Description=<br />
<!---This functionality is available in MOR X5 and MOR X6---><br />
[[MOR API]] Device clis get<br />
<br />
Please note that only admins users and admin can use this API. <br />
<br />
<br><br><br />
=Usage=<br />
<br />
* Call: /api/voucher_use<br />
* Methods: POST, GET(if allowed, not recomended)<br />
<br />
<br><br><br />
===Parametres===<br />
<br />
* u – username to login. '''Required'''.<br />
* devices_id – this is the id of users device. '''Optional'''.<br />
* users_id - this is the id of the user whose CLIs will be selected. '''Optional'''<br />
* [[MOR API hash construction | hash]] – SHA1 hash constructed using '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.<br />
<br />
<br><br><br />
<br />
===Request===<br />
<br />
We have API Secret Key = secret <br /><br />
We send:<br />
<br />
HTML POST: http://<server_ip>/billing/api/device_clis_get?u=admin&devices_id=6&users_id=3&e5e9fa1ba31ecd1ae84f75caaa474f3a663f05f4 <br />
<br />
'''* Note that username and password are not included in hash'''<br />
<br><br><br />
<br />
===Returns===<br />
<br />
'''Success'''<br />
<br />
<page><br />
<status><br />
<cli_id>3</cli_id><br />
<cli_cli>45456464</cli_cli><br />
<cli_device>IAX2/ipauth4aa73a4300</cli_device><br />
<cli_description>Test Reseller</cli_description><br />
<cli_added_at>2015-08-31 12:40:23 +0300</cli_added_at><br />
<cli_updated_at>2015-08-31 16:14:48 +0300</cli_updated_at><br />
<cli_comment>rhrtghg</cli_comment><br />
<cli_email_callback>0</cli_email_callback><br />
<cli_banned>0</cli_banned><br />
</status><br />
</page><br />
<br />
<br />
<br><br><br />
----<br />
<br />
'''Errors'''<br />
* <error>Device was not found</error> – Device was not found.<br />
* <error>CLIs were not found</error> – No CLIs found.<br />
* <error>Access Denied</error> – username (u) is not found.<br />
* <error>You are not authorized to use this functionality</error> – username (u) is reseller or accountant without permissions.<br />
* <error>User was not found</error> – specified user via user_id does not exist.<br />
* <error>Incorrect hash</error> – Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.<br />
<br><br><br />
<br />
=See also=<br />
<br />
* [[MOR API]]</div>Edvinashttps://wiki.kolmisoft.com/index.php?title=Hide_Device_username_for_Users&diff=19891Hide Device username for Users2015-08-04T20:00:25Z<p>Edvinas: Created page with '<!---This functionality is available from MOR 9---> ==What is Hide Device username?== This feature if enabled disallows ordinary users to see device username in GUI <br><br> ==W…'</p>
<hr />
<div><!---This functionality is available from MOR 9---><br />
==What is Hide Device username?==<br />
<br />
This feature if enabled disallows ordinary users to see device username in GUI<br />
<br><br><br />
==Where to enable this feature?==<br />
You can enable this feature in '''Setup -> Settings''' "Visual" tab:<br />
<br><br><br />
[[File:password_png.png]]<br />
<br><br><br />
'''Don't forget to save the settings!'''<br />
<br><br><br />
<br />
==Additional Notes==<br />
<br />
* Reseller user is also able to use this feature for his users</div>Edvinashttps://wiki.kolmisoft.com/index.php?title=File:Password_png.png&diff=19890File:Password png.png2015-08-04T20:00:08Z<p>Edvinas: </p>
<hr />
<div></div>Edvinashttps://wiki.kolmisoft.com/index.php?title=Integrity_Check&diff=19889Integrity Check2015-08-04T19:27:49Z<p>Edvinas: </p>
<hr />
<div>=Description=<br />
This function tests various properties of the billing system and tells where potential problems may be. It helps to prevent security issues and human errors.<br />
<br />
= Usage =<br />
<br />
Go to '''SETTINGS –> Setup –> Integrity Check''':<br />
<br><br><br />
[[Image:integrity-check-menu.png]]<br />
<br><br><br />
In this page you can see vulnerabilities in the system and by clicking on Fix icon [[Image:fix_icon.png]] you can quickly go to device's, user's or whatever else is broken edit page and change options that are causing insecurities. <br />
<br><br><br />
[[File:Integritycheck insecure.png]]<br />
<br><br><br />
<br />
== What every Integrity Check error means? ==<br />
<br />
This is more detailed explanation of every error in Integrity Check page. <br />
<br><br><br />
====Destinations not assigned to Destination Groups====<br />
<br />
This window shows [http://wiki.kolmisoft.com/index.php/Directions_and_Destinations Destinations] which are not assigned to any [http://wiki.kolmisoft.com/index.php/Destinations_Groups Destination Group]. This can lead to many problems, such as incorrect billing. <br />
<br><br><br />
[[Image:integrity-check-destinations.png]]<br />
<br><br><br />
Destinations not assigned to any Destination Group appear after the tariff rate import. It is necessary to assign these Destinations to their correct Destination Groups.<br />
<br><br />
Selected destination group in a dropdown matches group by destination name. <br />
<br />
'''IMPORTANT: if you have Destinations not assigned to Destination Groups, your Detailed Invoices will have incorrect call amounts!'''<br />
<br><br><br />
====Actions errors====<br />
When you click on Fix icon [[Image:fix_icon.png]] it opens [http://wiki.kolmisoft.com/index.php/Action_log action log] with errors selected. These actions requires attention and possibly changes in configuration. It reports about issues such as unsent emails and suspicious activity on accounts. <br />
<br><br><br />
[[Image:integrity-check-action-log.png]]<br />
<br><br><br />
====Users with weak password====<br />
Shows list of users who have weak passwords. Passwords of these users should be changed. Click [[Image:fix_icon.png]] ''Fix'' to see the list and click on edit icon [[Image:edit.png]] to go to user's edit page.<br />
<br><br><br />
====Devices with weak password====<br />
Shows list of devices which have weak passwords. Passwords of these devices should be changed. Click [[Image:fix_icon.png]] ''Fix'' to see the list and click on edit icon [[Image:edit.png]] to go to device's edit page.<br />
<br><br><br />
====Users that are set to Postpaid and allowed to make Loss Calls====<br />
Shows list of postpaid users who have [http://wiki.kolmisoft.com/index.php/Allow_loss_calls ''Allow loss calls''] option enabled. Click [[Image:fix_icon.png]]''Fix'' to see the list and click on edit icon [[Image:edit.png]] to go to user's edit page.<br />
<br><br><br />
====Default user warning: Default user is set to postpaid and allowed loss calls====<br />
Shows list of postpaid [http://wiki.kolmisoft.com/index.php/Default_user default users] who have [http://wiki.kolmisoft.com/index.php/Allow_loss_calls ''Allow loss calls''] option enabled. Click [[Image:fix_icon.png]] ''Fix'' to see the list and click on edit icon [[Image:edit.png]] to go to user's edit page.<br />
<br><br><br />
====Insecure devices====<br />
Shows a list of devices which have Dynamic IP and Insecure Invite and Port options enabled. Such combination allows to make call with incorrect device password.<br />
<br><br><br />
[[Image:Integrity-check-insecure-devices.png]]<br />
<br><br><br />
Click on device name or edit icon [[Image:edit.png]] to go to device's edit and change settings. There is also owner of the user whose device is insecure displayed. If column is empty, it means user's owner is System Admin. <br />
<br><br><br />
====Servers with low free space====<br />
<br />
Lights up if there is some [[Multi_Server_support|Servers]] with lower free space than it is set in '''[[Configuration_from_GUI#Various|Setup -> Settings -> Various tab]]''', '''Server free space limit''' setting.<br />
<br><br><br />
[[Image:Integrity-check-servers_with_low_fre_space.png]]<br />
<br><br><br />
=See also=<br />
<br />
* [[Destinations Groups]]<br />
* [[Device settings]]<br />
* [[User Details]]</div>Edvinashttps://wiki.kolmisoft.com/index.php?title=Integrity_Check&diff=19888Integrity Check2015-08-04T19:27:22Z<p>Edvinas: </p>
<hr />
<div>=Description=<br />
This function tests various properties of the billing system and tells where potential problems may be. It helps to prevent security issues and human errors.<br />
<br />
= Usage =<br />
<br />
Go to '''SETTINGS –> Setup –> Integrity Check''':<br />
<br><br><br />
[[Image:integrity-check-menu.png]]<br />
<br><br><br />
In this page you can see vulnerabilities in the system and by clicking on Fix icon [[Image:fix_icon.png]] you can quickly go to device's, user's or whatever else is broken edit page and change options that are causing insecurities. <br />
<br><br><br />
[[File:Integritycheck insecure.png]]<br />
<br><br><br />
<br />
== What every Integrity Check error means? ==<br />
<br />
This is more detailed explanation of every error in Integrity Check page. <br />
<br><br><br />
====Destinations not assigned to Destination Groups====<br />
<br />
This window shows [http://wiki.kolmisoft.com/index.php/Directions_and_Destinations Destinations] which are not assigned to any [http://wiki.kolmisoft.com/index.php/Destinations_Groups Destination Group]. This can lead to many problems, such as incorrect billing. <br />
<br><br><br />
[[Image:integrity-check-destinations.png]]<br />
<br><br><br />
Destinations not assigned to any Destination Group appear after the tariff rate import. It is necessary to assign these Destinations to their correct Destination Groups.<br />
Selected destination group in a dropdown matches group by destination name. <br />
<br />
'''IMPORTANT: if you have Destinations not assigned to Destination Groups, your Detailed Invoices will have incorrect call amounts!'''<br />
<br><br><br />
====Actions errors====<br />
When you click on Fix icon [[Image:fix_icon.png]] it opens [http://wiki.kolmisoft.com/index.php/Action_log action log] with errors selected. These actions requires attention and possibly changes in configuration. It reports about issues such as unsent emails and suspicious activity on accounts. <br />
<br><br><br />
[[Image:integrity-check-action-log.png]]<br />
<br><br><br />
====Users with weak password====<br />
Shows list of users who have weak passwords. Passwords of these users should be changed. Click [[Image:fix_icon.png]] ''Fix'' to see the list and click on edit icon [[Image:edit.png]] to go to user's edit page.<br />
<br><br><br />
====Devices with weak password====<br />
Shows list of devices which have weak passwords. Passwords of these devices should be changed. Click [[Image:fix_icon.png]] ''Fix'' to see the list and click on edit icon [[Image:edit.png]] to go to device's edit page.<br />
<br><br><br />
====Users that are set to Postpaid and allowed to make Loss Calls====<br />
Shows list of postpaid users who have [http://wiki.kolmisoft.com/index.php/Allow_loss_calls ''Allow loss calls''] option enabled. Click [[Image:fix_icon.png]]''Fix'' to see the list and click on edit icon [[Image:edit.png]] to go to user's edit page.<br />
<br><br><br />
====Default user warning: Default user is set to postpaid and allowed loss calls====<br />
Shows list of postpaid [http://wiki.kolmisoft.com/index.php/Default_user default users] who have [http://wiki.kolmisoft.com/index.php/Allow_loss_calls ''Allow loss calls''] option enabled. Click [[Image:fix_icon.png]] ''Fix'' to see the list and click on edit icon [[Image:edit.png]] to go to user's edit page.<br />
<br><br><br />
====Insecure devices====<br />
Shows a list of devices which have Dynamic IP and Insecure Invite and Port options enabled. Such combination allows to make call with incorrect device password.<br />
<br><br><br />
[[Image:Integrity-check-insecure-devices.png]]<br />
<br><br><br />
Click on device name or edit icon [[Image:edit.png]] to go to device's edit and change settings. There is also owner of the user whose device is insecure displayed. If column is empty, it means user's owner is System Admin. <br />
<br><br><br />
====Servers with low free space====<br />
<br />
Lights up if there is some [[Multi_Server_support|Servers]] with lower free space than it is set in '''[[Configuration_from_GUI#Various|Setup -> Settings -> Various tab]]''', '''Server free space limit''' setting.<br />
<br><br><br />
[[Image:Integrity-check-servers_with_low_fre_space.png]]<br />
<br><br><br />
=See also=<br />
<br />
* [[Destinations Groups]]<br />
* [[Device settings]]<br />
* [[User Details]]</div>Edvinashttps://wiki.kolmisoft.com/index.php?title=User_Details&diff=19600User Details2015-06-09T10:13:26Z<p>Edvinas: </p>
<hr />
<div>=Where to find user details?=<br />
<br />
Go to '''SETTINGS –> Users'''<br />
<br><br> <br />
[[File:Users_path.png]] <br />
<br><br> <br />
Here you can see list of all users. In brackets by the Accountant or Reseller you are able to see to which Permissions Group([[Reseller Permissions]] or [[Accountant permissions]]) they belong. <br />
<br><br> <br />
[[File:Users_list.png]] <!---From MOR X4 some of cells are empty because reseller/accountant does not make calls anymore---><br />
<br><br> <br />
Select the [[image:icon_edit.png]] icon in window above and you will reach personal user settings page. In this window you will see a lot of options grouped into sections like General, Blocking, Warning Balance Email, Invoices, Payments, Details, Taxes, Registration Address, Recordings and Blacklists.<br />
<br />
<!---This functionality is available from MOR X4---><br />
'''NOTE''' that admin is not shown in Users list. To see your own details go to '''PERSONAL MENU –> Details'''.<br />
<br><br><br />
<br />
= Details update = <br />
Every User can update his own details in '''PERSONAL MENU –> Details'''.<br><br><br />
To disallow users to change their details Admin/Reseller has to check setting "Do not allow users to change their Personal Details" in '''SETTINGS -> Setup -> Settings -> Various'''. After this User Details can only be updated by user's owner.<br><br><br />
'''NOTE''' that even if User is not allowed to update his own details, he still can see it in '''PERSONAL MENU –> Details''' as form with not editable options.<br><br><br />
<br />
= General =<br />
<br />
* Username – username for user to login to MOR GUI.<br />
* Password – password for user to login to MOR GUI.<br />
* [[Users#User_types | User type]] – by default it is "user".<br />
* [[LCR]] – LCR indicating which of the user's devices will be used to dial out.<br />
* [[Tariffs | Tariff]] – prices for the user. <br />
* [[Balance and Credit | Balance]] – the user's balance.<br />
* Daily credit limit – Total credit available for user per day.<br />
* [[Balance and Credit | Credit]] – the user's credit, showing how low the user's balance can go.<br />
* [[Minimum contract billing | Minimal Charge for Calls]] - minimum charge user pays for voice calls.<br />
* [[Minimum contract billing | Minimal Charge for Calls Date]] - date since when the previous option is valid.<br />
* Postpaid/Prepaid – type of user.<br />
* [[Hide Users | Not Hidden/Hidden]] – is this user hidden?<br />
* Primary device – the primary device for this user.<br />
* [[Allow loss calls]] – should loss calls be allowed for this user?<br />
* [[Simultaneous call limitation | Call Limit]] - how many simultaneous calls the user can make?<br />
* Responsible accountant – dropdown to choose accountant responsible for user's profit. <br />
* Hide Non-Answered calls – with this option enabled simple user sees only answered calls in [[Last Calls]] and in Detailed Statistics page. <!-- veikia su x5_functionality_15 --> <br />
* Ignore Global Alerts – check and User will be ignored on checking for [[Alerts]] <!---from x5---><br />
<br><br><br />
<br />
= Blocking =<br />
<br />
Various options for [[User Blocking]].<br />
<br><br><br />
= Warning Balance Email =<br />
<br />
If you want to send an email notification to a user (or take another action) when his balance drops lower than a certain amount, check this setting and enter the desired amount.<br />
<br />
More details: [[Warning balance]]<br />
<br><br><br />
= Invoices =<br />
<br><br><br />
[[Image:user_invoice_details.png]]<br />
<br><br><br />
* Generate Invoice – should we generate an invoice for this user when we choose to generate invoices for a period?<br />
* Invoice, Detailed, By CallerID, By Destinations and PDF/CSV show various types of invoices which should be showed in Users ''PERSONAL MENU –> Details –> Invoices'' and/or sent to the User as an email attachment.<br />
* Show zero Calls – if the call price = 0, should such calls appear in the invoice or not?<br />
<br><br><br />
= Payments =<br />
<br />
* Cyberplat - check this option if you want to allow the user to use this payment gateway.<br />
<br />
<br><br><br />
= Details =<br />
<br />
Self-explanatory.<br />
<br />
If Country of Taxation is in the EU, validation of TAX Registration Number will be checked from this website: http://ec.europa.eu/taxation_customs/vies/<br />
<br><br><br />
= Taxes =<br />
<br />
Here tax parameters are entered for the user.<br />
<br />
The tax system is explained [[Multi-Tax system | here]].<br />
<br><br><br />
= Registration Address =<br />
<br />
Self-explanatory.<br />
<br><br><br />
= Recordings = <br />
<br />
This section is available when the [[Recordings Addon]] is installed in the system.<br />
<br><br><br />
=Blacklists / Whitelists=<br />
<br><br><br />
[[Image:user_blacklists_details.png]]<br />
<br><br><br />
<!---FROM MOR X7---><br />
'''Enable static Source''' - enables static Blacklist or Whitelist<br><br />
* '''No''' - do not use any Blacklist or Whitelist<br />
* '''Blacklist''' - choose [[Number Pool]] which will be used to block User from receiving specific Source numbers. If User receives number which is in selected [[Number Pool]] then call will be hangup with hangupcause ''262 - Source number is in blacklist''<br />
* '''Whitelist''' - choose [[Number Pool]] which will be used to allow User to receive only specific Source numbers. If User receives number which is NOT in selected [[Number Pool]] then call will be hangup with hangupcause ''263 - Source number is not in whitelist''<br />
<br />
<!---FROM MOR X5---><br />
'''Enable static Destination''' - enables static Blacklist or Whitelist<br><br />
* '''No''' - do not use any Blacklist or Whitelist<br />
* '''Blacklist''' - choose [[Number Pool]] which will be used to block User from calling specific Destination numbers. If User calls number which is in selected [[Number Pool]] then call will be hangup with hangupcause ''255 - Destination is in blacklist''<br />
* '''Whitelist''' - choose [[Number Pool]] which will be used to allow User to call only specific Destination numbers. If User calls number which is NOT in selected [[Number Pool]] then call will be hangup with hangupcause ''256 - Destination is not in whitelist''<br />
<br><br><br />
Also you can manage '''[[Dynamic Blacklist Functionality]]''' settings for Single User. You are able to manage:<br />
<br />
'''Enable Dynamic Blacklist''' – enables dynamic Blacklist functionality for this user.<br><br />
'''Blacklist LCR''' – [[LCR]] with Blacklist Providers.<br><br />
'''Routing Threshold''' – sum of SRC, DST and RTP IP limit. If SRC, DST or RTP IP scores sum received during the call is bigger than Defaullt Threshold, call will be routed through selected Blacklist LCR. <br><br />
<br />
Choose option '''Global''' if you want to apply [[ Monitorings_Addon#Monitorings_Settings | global settingas]] for this user.<br />
<br><br><br />
<br />
= Comment = <br />
<br />
Here you are able to write private comment about user.</div>Edvinashttps://wiki.kolmisoft.com/index.php?title=User_Details&diff=19599User Details2015-06-09T10:13:04Z<p>Edvinas: </p>
<hr />
<div>=Where to find user details?=<br />
<br />
Go to '''SETTINGS –> Users'''<br />
<br><br> <br />
[[File:Users_path.png]] <br />
<br><br> <br />
Here you can see list of all users. In brackets by the Accountant or Reseller you are able to see to which Permissions Group([[Reseller Permissions]] or [[Accountant permissions]]) they belong. <br />
<br><br> <br />
[[File:Users_list.png]] <!---From MOR X4 some of cells are empty because reseller/accountant does not make calls anymore---><br />
<br><br> <br />
Select the [[image:icon_edit.png]] icon in window above and you will reach personal user settings page. In this window you will see a lot of options grouped into sections like General, Blocking, Warning Balance Email, Invoices, Payments, Details, Taxes, Registration Address, Recordings and Blacklists.<br />
<br />
<!---This functionality is available from MOR X4---><br />
'''NOTE''' that admin is not shown in Users list. To see your own details go to '''PERSONAL MENU –> Details'''.<br />
<br><br><br />
<br />
= Details update = <br />
Every User can update his own details in '''PERSONAL MENU –> Details'''.<br><br><br />
To disallow users to change their details Admin/Reseller has to check setting "Do not allow users to change their Personal Details" in '''SETTINGS -> Setup -> Settings -> Various'''. After this User Details can only be updated by user's owner.<br><br><br />
'''NOTE''' that even if User is not allowed to update his own details, he still can see it in '''PERSONAL MENU –> Details''' as form with not editable options.<br><br><br />
<br />
= General =<br />
<br />
* Username – username for user to login to MOR GUI.<br />
* Password – password for user to login to MOR GUI.<br />
* [[Users#User_types | User type]] – by default it is "user".<br />
* [[LCR]] – LCR indicating which of the user's devices will be used to dial out.<br />
* [[Tariffs | Tariff]] – prices for the user. <br />
* [[Balance and Credit | Balance]] – the user's balance.<br />
* [[Daily credit limit]] – Total credit available for user per day.<br />
* [[Balance and Credit | Credit]] – the user's credit, showing how low the user's balance can go.<br />
* [[Minimum contract billing | Minimal Charge for Calls]] - minimum charge user pays for voice calls.<br />
* [[Minimum contract billing | Minimal Charge for Calls Date]] - date since when the previous option is valid.<br />
* Postpaid/Prepaid – type of user.<br />
* [[Hide Users | Not Hidden/Hidden]] – is this user hidden?<br />
* Primary device – the primary device for this user.<br />
* [[Allow loss calls]] – should loss calls be allowed for this user?<br />
* [[Simultaneous call limitation | Call Limit]] - how many simultaneous calls the user can make?<br />
* Responsible accountant – dropdown to choose accountant responsible for user's profit. <br />
* Hide Non-Answered calls – with this option enabled simple user sees only answered calls in [[Last Calls]] and in Detailed Statistics page. <!-- veikia su x5_functionality_15 --> <br />
* Ignore Global Alerts – check and User will be ignored on checking for [[Alerts]] <!---from x5---><br />
<br><br><br />
<br />
= Blocking =<br />
<br />
Various options for [[User Blocking]].<br />
<br><br><br />
= Warning Balance Email =<br />
<br />
If you want to send an email notification to a user (or take another action) when his balance drops lower than a certain amount, check this setting and enter the desired amount.<br />
<br />
More details: [[Warning balance]]<br />
<br><br><br />
= Invoices =<br />
<br><br><br />
[[Image:user_invoice_details.png]]<br />
<br><br><br />
* Generate Invoice – should we generate an invoice for this user when we choose to generate invoices for a period?<br />
* Invoice, Detailed, By CallerID, By Destinations and PDF/CSV show various types of invoices which should be showed in Users ''PERSONAL MENU –> Details –> Invoices'' and/or sent to the User as an email attachment.<br />
* Show zero Calls – if the call price = 0, should such calls appear in the invoice or not?<br />
<br><br><br />
= Payments =<br />
<br />
* Cyberplat - check this option if you want to allow the user to use this payment gateway.<br />
<br />
<br><br><br />
= Details =<br />
<br />
Self-explanatory.<br />
<br />
If Country of Taxation is in the EU, validation of TAX Registration Number will be checked from this website: http://ec.europa.eu/taxation_customs/vies/<br />
<br><br><br />
= Taxes =<br />
<br />
Here tax parameters are entered for the user.<br />
<br />
The tax system is explained [[Multi-Tax system | here]].<br />
<br><br><br />
= Registration Address =<br />
<br />
Self-explanatory.<br />
<br><br><br />
= Recordings = <br />
<br />
This section is available when the [[Recordings Addon]] is installed in the system.<br />
<br><br><br />
=Blacklists / Whitelists=<br />
<br><br><br />
[[Image:user_blacklists_details.png]]<br />
<br><br><br />
<!---FROM MOR X7---><br />
'''Enable static Source''' - enables static Blacklist or Whitelist<br><br />
* '''No''' - do not use any Blacklist or Whitelist<br />
* '''Blacklist''' - choose [[Number Pool]] which will be used to block User from receiving specific Source numbers. If User receives number which is in selected [[Number Pool]] then call will be hangup with hangupcause ''262 - Source number is in blacklist''<br />
* '''Whitelist''' - choose [[Number Pool]] which will be used to allow User to receive only specific Source numbers. If User receives number which is NOT in selected [[Number Pool]] then call will be hangup with hangupcause ''263 - Source number is not in whitelist''<br />
<br />
<!---FROM MOR X5---><br />
'''Enable static Destination''' - enables static Blacklist or Whitelist<br><br />
* '''No''' - do not use any Blacklist or Whitelist<br />
* '''Blacklist''' - choose [[Number Pool]] which will be used to block User from calling specific Destination numbers. If User calls number which is in selected [[Number Pool]] then call will be hangup with hangupcause ''255 - Destination is in blacklist''<br />
* '''Whitelist''' - choose [[Number Pool]] which will be used to allow User to call only specific Destination numbers. If User calls number which is NOT in selected [[Number Pool]] then call will be hangup with hangupcause ''256 - Destination is not in whitelist''<br />
<br><br><br />
Also you can manage '''[[Dynamic Blacklist Functionality]]''' settings for Single User. You are able to manage:<br />
<br />
'''Enable Dynamic Blacklist''' – enables dynamic Blacklist functionality for this user.<br><br />
'''Blacklist LCR''' – [[LCR]] with Blacklist Providers.<br><br />
'''Routing Threshold''' – sum of SRC, DST and RTP IP limit. If SRC, DST or RTP IP scores sum received during the call is bigger than Defaullt Threshold, call will be routed through selected Blacklist LCR. <br><br />
<br />
Choose option '''Global''' if you want to apply [[ Monitorings_Addon#Monitorings_Settings | global settingas]] for this user.<br />
<br><br><br />
<br />
= Comment = <br />
<br />
Here you are able to write private comment about user.</div>Edvinashttps://wiki.kolmisoft.com/index.php?title=MOR_API_did_details_update&diff=19155MOR API did details update2015-03-18T17:56:28Z<p>Edvinas: /* Parametres */</p>
<hr />
<div>=Description=<br />
<!---This functionality is available in MOR X5 and MOR X6---><br />
[[MOR API]] DID details update<br />
<br />
Please note that only admin, accountant(with device management) with permission and reseller can use this API. <br />
<br />
<br><br><br />
=Usage=<br />
<br />
* Call: /api/did_details_update<br />
* Methods: POST, GET(if allowed, not recomended)<br />
<br />
<br><br><br />
===Parametres===<br />
<br />
* u – username to login. '''Required'''.<br />
* did_id – this is number of voucher which will be used. '''Required'''.<br />
* call_limit - call limit of did which will be updated. '''Optional'''<br />
* [[MOR API hash construction | hash]] – SHA1 hash constructed using '''did_id''' and '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.<br />
<br />
<br><br><br />
<br />
===Request===<br />
<br />
We have API Secret Key = secret, did_id = 6511 <br /><br />
We send:<br />
<br />
HTML POST: http://<server_ip>/billing//api/did_details_update?u=admin&did_id=6511&call_limit=999&hash=f7de355c9b4421ce6c705b4b32c89dbcaca51e46<br />
<br />
'''* Note that username and password are not included in hash'''<br />
<br><br><br />
<br />
===Returns===<br />
<br />
'''Success'''<br />
<br />
<page><br />
<status><br />
<success>DID details successfully updated</success><br />
</status><br />
</page><br />
<br />
'''After successfully updating DID action log record is added.'''<br />
<br><br><br />
----<br />
'''Errors'''<br />
<br />
* <error>Call limit is incorrect format</error> – Specified call limit is 0 or positive number.<br />
* <error>DID was not found</error> – Specified did does not exist or it belongs to different username(u).<br />
* <error>Access Denied</error> – Specified username (u) does not exist or u is not admin, reseller or accountant with permission.<br />
* <error>Incorrect hash</error> – Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.<br />
<br><br><br />
<br />
=See also=<br />
<br />
* [[MOR API]]</div>Edvinashttps://wiki.kolmisoft.com/index.php?title=MOR_API_did_details_update&diff=19126MOR API did details update2015-03-17T15:05:51Z<p>Edvinas: </p>
<hr />
<div>=Description=<br />
<!---This functionality is available in MOR X5 and MOR X6---><br />
[[MOR API]] DID details update<br />
<br />
Please note that only admin, accountant(with device management) with permission and reseller can use this API. <br />
<br />
<br><br><br />
=Usage=<br />
<br />
* Call: /api/did_details_update<br />
* Methods: POST, GET(if allowed, not recomended)<br />
<br />
<br><br><br />
===Parametres===<br />
<br />
* u – username to login. '''Required'''.<br />
* did_id – this is number of voucher which will be used. '''Required'''.<br />
* call_limit - this will be updated. '''Optional'''<br />
* [[MOR API hash construction | hash]] – SHA1 hash constructed using '''did_id''' and '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.<br />
<br />
<br><br><br />
<br />
===Request===<br />
<br />
We have API Secret Key = secret, did_id = 6511 <br /><br />
We send:<br />
<br />
HTML POST: http://<server_ip>/billing//api/did_details_update?u=admin&did_id=6511&call_limit=999&hash=f7de355c9b4421ce6c705b4b32c89dbcaca51e46<br />
<br />
'''* Note that username and password are not included in hash'''<br />
<br><br><br />
<br />
===Returns===<br />
<br />
'''Success'''<br />
<br />
<page><br />
<status><br />
<success>DID details successfully updated</success><br />
</status><br />
</page><br />
<br />
'''After successfully updating DID action log record is added.'''<br />
<br><br><br />
----<br />
'''Errors'''<br />
<br />
* <error>Call limit is incorrect format</error> – Specified call limit is 0 or positive number.<br />
* <error>DID was not found</error> – Specified did does not exist or it belongs to different username(u).<br />
* <error>Access Denied</error> – Specified username (u) does not exist or u is not admin, reseller or accountant with permission.<br />
* <error>Incorrect hash</error> – Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.<br />
<br><br><br />
<br />
=See also=<br />
<br />
* [[MOR API]]</div>Edvinashttps://wiki.kolmisoft.com/index.php?title=MOR_API_did_details_update&diff=19123MOR API did details update2015-03-17T15:00:08Z<p>Edvinas: </p>
<hr />
<div>=Description=<br />
<!---This functionality is available in MOR X5 and MOR X6---><br />
[[MOR API]] DID details update<br />
<br />
Please note that only admin, accountant(with device management) with permission and reseller can use this API. <br />
<br />
<br><br><br />
=Usage=<br />
<br />
* Call: /api/did_details_update<br />
* Methods: POST, GET(if allowed, not recomended)<br />
<br />
<br><br><br />
===Parametres===<br />
<br />
* u – username to login. '''Required'''.<br />
* did_id – this is number of voucher which will be used. '''Required'''.<br />
* call_limit - this will be updated. '''Optional'''<br />
* [[MOR API hash construction | hash]] – SHA1 hash constructed using '''did_id''' and '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.<br />
<br />
<br><br><br />
<br />
===Request===<br />
<br />
We have API Secret Key = secret, did_id = 10007 <br /><br />
We send:<br />
<br />
HTML POST: http://<server_ip>/billing//api/did_details_update?u=admin&did_id=6511&call_limit=999&hash=f7de355c9b4421ce6c705b4b32c89dbcaca51e46<br />
<br />
'''* Note that username and password are not included in hash'''<br />
<br><br><br />
<br />
===Returns===<br />
<br />
'''Success'''<br />
<br />
<page><br />
<status><br />
<success>DID details successfully updated</success><br />
</status><br />
</page><br />
<br />
'''After successfully updating DID action log record is added.'''<br />
<br><br><br />
----<br />
'''Errors'''<br />
<br />
* <error>Call limit is incorrect format</error> – Specified call limit is 0 or positive number.<br />
* <error>DID was not found</error> – Specified did does not exist or it belongs to different username(u).<br />
* <error>Access Denied</error> – Specified username (u) does not exist or u is not admin, reseller or accountant with permission.<br />
* <error>Incorrect hash</error> – Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.<br />
<br><br><br />
<br />
=See also=<br />
<br />
* [[MOR API]]</div>Edvinashttps://wiki.kolmisoft.com/index.php?title=MOR_API_did_details_update&diff=19122MOR API did details update2015-03-17T14:59:46Z<p>Edvinas: </p>
<hr />
<div>=Description=<br />
<!---This functionality is available in MOR X5 and MOR X6---><br />
[[MOR API]] DID details update<br />
<br />
Please note that only admin, accountant(with device management) with permission and reseller can use this API. <br />
<br />
<br><br><br />
=Usage=<br />
<br />
* Call: /api/did_details_update<br />
* Methods: POST, GET(if allowed, not recomended)<br />
<br />
<br><br><br />
===Parametres===<br />
<br />
* u – username to login. '''Required'''.<br />
* did_id – this is number of voucher which will be used. '''Required'''.<br />
* call_limit - this will be updated. '''Optional'''<br />
* [[MOR API hash construction | hash]] – SHA1 hash constructed using '''did_id''' and '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.<br />
<br />
<br><br><br />
<br />
===Request===<br />
<br />
We have API Secret Key = secret, did_id = 10007 <br /><br />
We send:<br />
<br />
HTML POST: http://<server_ip>/billing//api/did_details_update?u=admin&did_id=6511&call_limit=999&hash=f7de355c9b4421ce6c705b4b32c89dbcaca51e46<br />
<br />
'''* Note that username and password are not included in hash'''<br />
<br><br><br />
<br />
===Returns===<br />
<br />
'''Success'''<br />
<br />
<page><br />
<status><br />
<success>DID details successfully updated</success><br />
</status><br />
</page><br />
<br />
'''After successfully updating DID action log record is added.'''<br />
<br><br><br />
----<br />
'''Errors'''<br />
<br />
* <error>Call limit is incorrect format</error> – Specified call limit is 0 or positive number.<br />
* <error>DID was not found</error> – Specified did does not exist or it belongs to different username(u).<br />
* <error>Access Denied</error> – Specified username (u) does not exist or u is not admin, reseller or accountant with permission.<br />
* <error>Incorrect hash</error> – Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.<br />
<br><br><br />
<br />
=See also=<br />
<br />
* [[MOR API]]</div>Edvinashttps://wiki.kolmisoft.com/index.php?title=MOR_API&diff=19121MOR API2015-03-17T14:59:11Z<p>Edvinas: Undo revision 19092 by Edvinas (Talk)</p>
<hr />
<div>[[File:warning.png|100px]]<big><big><big>IMPORTANT!!! API methods described here are for MOR X6. For previous versions please check appropriate [http://wiki.kolmisoft.com/index.php/MOR_Manual#Old_Manuals manual].</big></big></big><br />
<br />
<br><br><br />
=About=<br />
MOR API lets other software interact with MOR without knowing the internal structure of the database (DB) and other logic.<br />
<br />
MOR accepts requests by HTML POST and returns results in XML.<br />
<br />
<br><br><br />
=MOR users that are allowed to use MOR API=<br />
* Admin<br />
* Reseller<br />
* Accountant - only by using Admin Hash and Secret key<br />
* Simple User<br />
<br />
<br><br><br />
<br />
=Functions=<br />
<br />
== API Related ==<br />
* [[API Configuration]] – configuration options for API.<br />
* [[MOR API hash construction|Hash construction]] – how to construct hash to authenticate data over API.<br />
<br />
<br><br />
==Balance==<br />
* [[MOR API user balance update | user_balance_update]] (change_user_balance) – changes User's Balance<br />
Various methods to retrieve User balance<br />
* [[MOR API user_balance_get|user_balance_get]] (balance) – retrieves a User Balance.<br />
* [[Balance in phone | user_simple_balance_get]] (simple_balance) – gets User's Balance<br />
* [[MOR API user balance get by psw | user_balance_get_by_psw]] – gets User's Balance by his owned Device's Password<br />
* [[MOR API User Balance get by Username | user_balance_get_by_username]] – gets User's Balance by his owned Device's Username<br />
<br />
<br><br />
<br />
==Callback==<br />
* [[MOR API callback init|callback_init]] (callback) – initiates callback.<br />
<br />
<br><br />
==Calling Cards==<br />
* [[MOR API card_by_cli_update| card_by_cli_update]] (cc_by_cli) – creates and updates calling cards, including adding and transferring funds, by being identified according the Caller_ID.<br />
* [[MOR API card_from_group_sell| card_from_group_sell]] (buy_card_from_callingroup) – sells cards from calling card group.<br />
* [[MOR API card_group_get| card_group_get]] (show_calling_card_group) – show calling group info.<br />
* [[MOR API card_balance_get| card_balance_get]] (card_balance_get) – show card's balance.<br />
* [[MOR API card_payment_add| card_payment_add]] – add payment to the calling card.<br />
<br />
<br><br />
<br />
==Calls==<br />
* [[MOR API user calls get|user_calls_get]] (user_calls) – retrieves a list of calls in a selected time period for a user/device.<br />
<br />
<br><br />
<br />
==Conflines==<br />
* [[MOR API conflines update|conflines_update]] – changes settings for API, Default User or Default Device.<br />
<br />
<br><br />
==Credit notes==<br />
* [[MOR API credit_notes_get| credit_notes_get]] (credit_notes) – credit notes list.<br />
* [[MOR API credit_note_update| credit_note_update]] – credit note update.<br />
* [[MOR API credit_notes_create| credit_note_create]] – credit note create.<br />
* [[MOR API credit_notes_delete| credit_note_delete]] – credit note delete.<br />
<br />
<br><br />
==Device==<br />
* [[MOR API device create| device_create]] – create device<br />
* [[MOR API device delete| device_delete]] (delete_device) – delete device<br />
* [[MOR API devices get | devices_get]] (device_list) – users device list<br />
* [[MOR API device callflow get| device_callflow_get]] - returns information about specified device callflow state.<br />
* [[MOR API device callflow update | device_callflow_update]] – updates information of specified device callflow state. <br />
* [[MOR API CLI info get | cli_info_get]] (cli_get_info) – shows id of device where CLI belongs.<br />
* [[MOR API CLI delete | cli_delete]] – deletes specified CLI. <br />
* [[MOR API CLI add | cli_add]] – creates CLI and assigns it to the specified device.<br />
* [[MOR API device details get | device_details_get]] – shows all information about specified device.<br />
* [[MOR_API_device_update | device_update]] – updates location_id of selected Device.<br />
<br />
<br><br />
<br />
==DID==<br />
<br />
* [[MOR API dids get| dids_get]] – get list of particular DIDs<br />
* [[MOR API did_create| did_create]] – DID create<br />
* [[MOR_API_did_device_assign| did_device_assign]] (did_assign_device) – Assign Device to DID<br />
* [[MOR_API_did_device_unassign| did_device_unassign]] (did_unassign_device) – Unassign Device from DID<br />
* [[MOR_API_did_details_update| did_details_update]] (did_details_update) - Update DID details <br />
<br />
<br><br />
<br />
==Email==<br />
* [[MOR API email send| email_send]] (send_email) – send Email.<br />
<br />
<br><br />
==Financial statements==<br />
* [[MOR API financial_statements_get| financial_statements_get]] (financial_statements) – financial statements list.<br />
<br />
<br><br />
==Invoices==<br />
* [[MOR API invoices_get|invoices_get]] (invoices) – retrieves a list of invoices in a selected time period.<br />
<br />
<br><br />
==Login==<br />
* [[MOR API user_login|user_login]] (login) – logs user in to MOR.<br />
* [[MOR API user_logout|user_logout]] (logout) – logs user out from MOR.<br />
<br />
<br><br />
==Monitorings==<br />
* [[MOR API ma_activate_api| ma_activate]] – turn on monitorings addon<br />
<br />
<br><br />
==Payments==<br />
* [[MOR API payment_create| payment_create]] (create_payment) – create payment.<br />
* [[MOR API payments_get| payments_get]] (payments_list) – payments list.<br />
<br />
<br><br />
==Phonebooks==<br />
* [[MOR API phonebooks_get| phonebooks_get]] (phonebooks_api ) – phonebooks list.<br />
* [[MOR API phonebook_edit| phonebook_edit]] (phonebook_edit_api) – edit phonebook.<br />
* [[MOR API phonebook_record_create| phonebook_record_create]] – create phonebook.<br />
<br />
<br><br />
==Quickforwards==<br />
* [[MOR API Quickforwards get| quickforwards_dids_get]] (quickforwards_dids_get) – get Quickforwards.<br />
* [[MOR API Quickforwards update| quickforwards_did_update]] (quickforwards_did_update) – update Quickforwards.<br />
* [[MOR API Quickforwards delete| quickforwards_did_delete]] (quickforwards_did_delete) – delete Quickforwards.<br />
<br />
<br><br />
==Rates==<br />
* [[MOR API rate get|rate_get]] (rate) – check user rate by prefix<br />
* [[MOR API tariff rates get| tariff_rates_get]] (get_tariff) – get all tariff's rates<br />
* [[MOR API tariff_retail_import | tariff_retail_import ]] (import_relail_tariff) – import xml retail tariff<br />
* [[MOR API tariff_wholesale_update | tariff_wholesale_update ]] (wholesale_tariff) – update or create wholesale tariff<br />
<br />
<br><br />
==Services==<br />
* [[MOR API Service create| service_create]] – create Service.<br />
* [[MOR API Service delete| service_delete]] – delete Service.<br />
* [[MOR API Services get| services_get]] – get Services.<br />
* [[MOR API Service update| service_update]] – update Service.<br />
<br />
<br><br />
<br />
==SMS==<br />
* [[MOR API sms send| sms_send]] (send_sms) – send SMS.<br />
* [[MOR_API_user_sms_service_subscribe | user_sms_service_subscribe ]] – User subscription to SMS Service.<br />
<br />
<br><br />
==Subscriptions==<br />
* [[MOR API subscription delete|subscription_delete]] - Subscription delete.<br />
* [[MOR API Subscriptions get|subscriptions_get]] - Subscriptions get.<br />
* [[MOR API subscription create|subscription_create]] - Subscription create.<br />
* [[MOR API subscription update|subscription_update]] - Subscription delete.<br />
<br><br />
<br />
==User==<br />
<br />
* [[MOR API user_register| user_register]] – create new user from params.<br />
* [[MOR API user_details_get | user_details_get]] (user_details) – gets user details.<br />
* [[MOR_API_user_details_update| user_details_update]] (user_update_api) – update user from params.<br />
<br><br />
<br />
== Resellers ==<br />
* [[MOR API reseller group create]] - create new Reseller Group<br />
<br />
<br><br />
==Version==<br />
* [[MOR API system version get| system_version_get]] (get_version) – get MOR version number.<br />
<br />
<br><br />
= Examples =<br />
* [[MOR API PHP Examples]]<br />
<br />
<br><br><br />
=HTML POST=<br />
All requests are in a similar format:<br />
<br />
HTML POST: http://<SERVER_IP>/billing/api/<function>?u=username<br />
<br />
* username - the user name and password of the user who is asking for the data. <br />
<br />
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.<br />
<br><br><br />
=Useful to know=<br />
<br />
* 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:<br />
** Value of money will be returned in Default System [[Currencies|Currency]].<br />
** Date will not be affected of [[Configuration_from_GUI#Visual| Default date format]] setting.<br />
** Value of money will not be affected of [[Configuration_from_GUI#Visual|Number digits]] setting.<br />
<br />
<br><br><br />
=See also =<br />
* [[API Configuration]]<br />
* [[MOR integration]]<br />
* [[How to block access to some API functions]]<br />
* [[API specification to be implemented in the future]]</div>Edvinashttps://wiki.kolmisoft.com/index.php?title=MOR_API_did_details_update&diff=19120MOR API did details update2015-03-17T14:58:20Z<p>Edvinas: </p>
<hr />
<div>=Description=<br />
<!---This functionality is available in MOR X5 and MOR X6---><br />
[[MOR API]] DID details update<br />
<br />
Please note that only admin, accountant(with device management) with permission and reseller can use this API. <br />
<br />
<br><br><br />
=Usage=<br />
<br />
* Call: /api/did_details_update<br />
* Methods: POST, GET(if allowed, not recomended)<br />
<br />
<br><br><br />
===Parametres===<br />
<br />
* u – username to login. '''Required'''.<br />
* did_id – this is number of voucher which will be used. '''Required'''.<br />
* call_limit - this will be updated. '''Optional'''<br />
* [[MOR API hash construction | hash]] – SHA1 hash constructed using '''did_id''' and '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.<br />
<br />
<br><br><br />
<br />
===Request===<br />
<br />
We have API Secret Key = secret, did_id = 10007 <br /><br />
We send:<br />
<br />
HTML POST: http://<server_ip>/billing//api/did_details_update?u=admin&did_id=6511&call_limit=999&hash=f7de355c9b4421ce6c705b4b32c89dbcaca51e46<br />
<br />
'''* Note that username and password are not included in hash'''<br />
<br><br><br />
<br />
===Returns===<br />
<br />
'''Success'''<br />
<br />
<page><br />
<status><br />
<success>DID details successfully updated</success><br />
</status><br />
</page><br />
<br />
<br><br><br />
<br />
<br><br><br />
'''After successfully updating DID action log record is added.'''<br />
----<br />
'''Errors'''<br />
<br />
* <error>Call limit is incorrect format</error> – Specified call limit is 0 or positive number.<br />
* <error>DID was not found</error> – Specified did does not exist or it belongs to different username(u).<br />
* <error>Access Denied</error> – Specified username (u) does not exist or u is not admin, reseller or accountant with permission.<br />
* <error>Incorrect hash</error> – Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.<br />
<br><br><br />
<br />
=See also=<br />
<br />
* [[MOR API]]</div>Edvinashttps://wiki.kolmisoft.com/index.php?title=MOR_API_did_details_update&diff=19119MOR API did details update2015-03-17T14:57:44Z<p>Edvinas: </p>
<hr />
<div>=Description=<br />
<!---This functionality is available in MOR X5 and MOR X6---><br />
[[MOR API]] DID details update<br />
<br />
Please note that only admin, accountant(with device management) with permission and reseller can use this API. <br />
<br />
<br><br><br />
=Usage=<br />
<br />
* Call: /api/did_details_update<br />
* Methods: POST, GET(if allowed, not recomended)<br />
<br />
<br><br><br />
===Parametres===<br />
<br />
* u – username to login. '''Required'''.<br />
* did_id – this is number of voucher which will be used. '''Required'''.<br />
* call_limit - this will be updated. '''Optional'''<br />
* [[MOR API hash construction | hash]] – SHA1 hash constructed using '''did_id''' and '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.<br />
<br />
<br><br><br />
<br />
===Request===<br />
<br />
We have API Secret Key = secret, did_id = 10007 <br /><br />
We send:<br />
<br />
HTML POST: http://<server_ip>/billing//api/did_details_update?u=admin&did_id=6511&call_limit=999&hash=f7de355c9b4421ce6c705b4b32c89dbcaca51e46<br />
<br />
'''* Note that username and password are not included in hash'''<br />
<br><br><br />
<br />
===Returns===<br />
<br />
'''Success'''<br />
<br />
<page><br />
<status><br />
<success>DID details successfully updated</success><br />
</status><br />
</page><br />
<br />
<br><br><br />
----<br />
<br><br><br />
'''After successfully updating DID action log record is added.'''<br />
<br />
'''Errors'''<br />
<br />
* <error>Call limit is incorrect format</error> – Specified call limit is 0 or positive number.<br />
* <error>DID was not found</error> – Specified did does not exist or it belongs to different username(u).<br />
* <error>Access Denied</error> – Specified username (u) does not exist or u is not admin, reseller or accountant with permission.<br />
* <error>Incorrect hash</error> – Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.<br />
<br><br><br />
<br />
=See also=<br />
<br />
* [[MOR API]]</div>Edvinashttps://wiki.kolmisoft.com/index.php?title=MOR_API_did_details_update&diff=19118MOR API did details update2015-03-17T14:57:02Z<p>Edvinas: </p>
<hr />
<div>=Description=<br />
<!---This functionality is available in MOR X5 and MOR X6---><br />
[[MOR API]] DID details update<br />
<br />
Please note that only admin, accountant(with device management) with permission and reseller can use this API. <br />
<br />
<br><br><br />
=Usage=<br />
<br />
* Call: /api/did_details_update<br />
* Methods: POST, GET(if allowed, not recomended)<br />
<br />
<br><br><br />
===Parametres===<br />
<br />
* u – username to login. '''Required'''.<br />
* did_id – this is number of voucher which will be used. '''Required'''.<br />
* call_limit - this will be updated. '''Optional'''<br />
* [[MOR API hash construction | hash]] – SHA1 hash constructed using '''did_id''' and '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.<br />
<br />
<br><br><br />
<br />
===Request===<br />
<br />
We have API Secret Key = secret, did_id = 10007 <br /><br />
We send:<br />
<br />
HTML POST: http://<server_ip>/billing//api/did_details_update?u=admin&did_id=6511&call_limit=999&hash=f7de355c9b4421ce6c705b4b32c89dbcaca51e46<br />
<br />
'''* Note that username and password are not included in hash'''<br />
<br><br><br />
<br />
===Returns===<br />
<br />
'''Success'''<br />
<br />
<page><br />
<status><br />
<success>DID details successfully updated</success><br />
</status><br />
</page><br />
<br />
<br><br><br />
After successfully updating DID action log record is added.<br />
<br><br><br />
----<br />
<br />
'''Errors'''<br />
<br />
* <error>Call limit is incorrect format</error> – Specified call limit is 0 or positive number.<br />
* <error>DID was not found</error> – Specified did does not exist or it belongs to different username(u).<br />
* <error>Access Denied</error> – Specified username (u) does not exist or u is not admin, reseller or accountant with permission.<br />
* <error>Incorrect hash</error> – Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.<br />
<br><br><br />
<br />
=See also=<br />
<br />
* [[MOR API]]</div>Edvinashttps://wiki.kolmisoft.com/index.php?title=MOR_API&diff=19092MOR API2015-03-17T11:33:21Z<p>Edvinas: </p>
<hr />
<div>[[File:warning.png|100px]]<big><big><big>IMPORTANT!!! API methods described here are for MOR X6. For previous versions please check appropriate [http://wiki.kolmisoft.com/index.php/MOR_Manual#Old_Manuals manual].</big></big></big><br />
<br />
<br><br><br />
=About=<br />
MOR API lets other software interact with MOR without knowing the internal structure of the database (DB) and other logic.<br />
<br />
MOR accepts requests by HTML POST and returns results in XML.<br />
<br />
<br><br><br />
=MOR users that are allowed to use MOR API=<br />
* Admin<br />
* Reseller<br />
* Accountant - only by using Admin Hash and Secret key<br />
* Simple User<br />
<br />
<br><br><br />
<br />
=Functions=<br />
<br />
== API Related ==<br />
* [[API Configuration]] – configuration options for API.<br />
* [[MOR API hash construction|Hash construction]] – how to construct hash to authenticate data over API.<br />
<br />
<br><br />
==Balance==<br />
* [[MOR API user balance update | user_balance_update]] (change_user_balance) – changes User's Balance<br />
Various methods to retrieve User balance<br />
* [[MOR API user_balance_get|user_balance_get]] (balance) – retrieves a User Balance.<br />
* [[Balance in phone | user_simple_balance_get]] (simple_balance) – gets User's Balance<br />
* [[MOR API user balance get by psw | user_balance_get_by_psw]] – gets User's Balance by his owned Device's Password<br />
* [[MOR API User Balance get by Username | user_balance_get_by_username]] – gets User's Balance by his owned Device's Username<br />
<br />
<br><br />
<br />
==Callback==<br />
* [[MOR API callback init|callback_init]] (callback) – initiates callback.<br />
<br />
<br><br />
==Calling Cards==<br />
* [[MOR API card_by_cli_update| card_by_cli_update]] (cc_by_cli) – creates and updates calling cards, including adding and transferring funds, by being identified according the Caller_ID.<br />
* [[MOR API card_from_group_sell| card_from_group_sell]] (buy_card_from_callingroup) – sells cards from calling card group.<br />
* [[MOR API card_group_get| card_group_get]] (show_calling_card_group) – show calling group info.<br />
* [[MOR API card_balance_get| card_balance_get]] (card_balance_get) – show card's balance.<br />
* [[MOR API card_payment_add| card_payment_add]] – add payment to the calling card.<br />
<br />
<br><br />
<br />
==Calls==<br />
* [[MOR API user calls get|user_calls_get]] (user_calls) – retrieves a list of calls in a selected time period for a user/device.<br />
<br />
<br><br />
<br />
==Conflines==<br />
* [[MOR API conflines update|conflines_update]] – changes settings for API, Default User or Default Device.<br />
<br />
<br><br />
==Credit notes==<br />
* [[MOR API credit_notes_get| credit_notes_get]] (credit_notes) – credit notes list.<br />
* [[MOR API credit_note_update| credit_note_update]] – credit note update.<br />
* [[MOR API credit_notes_create| credit_note_create]] – credit note create.<br />
* [[MOR API credit_notes_delete| credit_note_delete]] – credit note delete.<br />
<br />
<br><br />
==Device==<br />
* [[MOR API device create| device_create]] – create device<br />
* [[MOR API device delete| device_delete]] (delete_device) – delete device<br />
* [[MOR API devices get | devices_get]] (device_list) – users device list<br />
* [[MOR API device callflow get| device_callflow_get]] - returns information about specified device callflow state.<br />
* [[MOR API device callflow update | device_callflow_update]] – updates information of specified device callflow state. <br />
* [[MOR API CLI info get | cli_info_get]] (cli_get_info) – shows id of device where CLI belongs.<br />
* [[MOR API CLI delete | cli_delete]] – deletes specified CLI. <br />
* [[MOR API CLI add | cli_add]] – creates CLI and assigns it to the specified device.<br />
* [[MOR API device details get | device_details_get]] – shows all information about specified device.<br />
* [[MOR_API_device_update | device_update]] – updates location_id of selected Device.<br />
<br />
<br><br />
<br />
==DID==<br />
<br />
* [[MOR API dids get| dids_get]] – get list of particular DIDs<br />
* [[MOR API did_create| did_create]] – DID create<br />
* [[MOR_API_did_device_assign| did_device_assign]] (did_assign_device) – Assign Device to DID<br />
* [[MOR_API_did_device_unassign| did_device_unassign]] (did_unassign_device) – Unassign Device from DID <br />
<br />
<br><br />
<br />
==Email==<br />
* [[MOR API email send| email_send]] (send_email) – send Email.<br />
<br />
<br><br />
==Financial statements==<br />
* [[MOR API financial_statements_get| financial_statements_get]] (financial_statements) – financial statements list.<br />
<br />
<br><br />
==Invoices==<br />
* [[MOR API invoices_get|invoices_get]] (invoices) – retrieves a list of invoices in a selected time period.<br />
<br />
<br><br />
==Login==<br />
* [[MOR API user_login|user_login]] (login) – logs user in to MOR.<br />
* [[MOR API user_logout|user_logout]] (logout) – logs user out from MOR.<br />
<br />
<br><br />
==Monitorings==<br />
* [[MOR API ma_activate_api| ma_activate]] – turn on monitorings addon<br />
<br />
<br><br />
==Payments==<br />
* [[MOR API payment_create| payment_create]] (create_payment) – create payment.<br />
* [[MOR API payments_get| payments_get]] (payments_list) – payments list.<br />
<br />
<br><br />
==Phonebooks==<br />
* [[MOR API phonebooks_get| phonebooks_get]] (phonebooks_api ) – phonebooks list.<br />
* [[MOR API phonebook_edit| phonebook_edit]] (phonebook_edit_api) – edit phonebook.<br />
* [[MOR API phonebook_record_create| phonebook_record_create]] – create phonebook.<br />
<br />
<br><br />
==Quickforwards==<br />
* [[MOR API Quickforwards get| quickforwards_dids_get]] (quickforwards_dids_get) – get Quickforwards.<br />
* [[MOR API Quickforwards update| quickforwards_did_update]] (quickforwards_did_update) – update Quickforwards.<br />
* [[MOR API Quickforwards delete| quickforwards_did_delete]] (quickforwards_did_delete) – delete Quickforwards.<br />
<br />
<br><br />
==Rates==<br />
* [[MOR API rate get|rate_get]] (rate) – check user rate by prefix<br />
* [[MOR API tariff rates get| tariff_rates_get]] (get_tariff) – get all tariff's rates<br />
* [[MOR API tariff_retail_import | tariff_retail_import ]] (import_relail_tariff) – import xml retail tariff<br />
* [[MOR API tariff_wholesale_update | tariff_wholesale_update ]] (wholesale_tariff) – update or create wholesale tariff<br />
<br />
<br><br />
==Services==<br />
* [[MOR API Service create| service_create]] – create Service.<br />
* [[MOR API Service delete| service_delete]] – delete Service.<br />
* [[MOR API Services get| services_get]] – get Services.<br />
* [[MOR API Service update| service_update]] – update Service.<br />
<br />
<br><br />
<br />
==SMS==<br />
* [[MOR API sms send| sms_send]] (send_sms) – send SMS.<br />
* [[MOR_API_user_sms_service_subscribe | user_sms_service_subscribe ]] – User subscription to SMS Service.<br />
<br />
<br><br />
==Subscriptions==<br />
* [[MOR API subscription delete|subscription_delete]] - Subscription delete.<br />
* [[MOR API Subscriptions get|subscriptions_get]] - Subscriptions get.<br />
* [[MOR API subscription create|subscription_create]] - Subscription create.<br />
* [[MOR API subscription update|subscription_update]] - Subscription delete.<br />
<br><br />
<br />
==User==<br />
<br />
* [[MOR API user_register| user_register]] – create new user from params.<br />
* [[MOR API user_details_get | user_details_get]] (user_details) – gets user details.<br />
* [[MOR_API_user_details_update| user_details_update]] (user_update_api) – update user from params.<br />
<br><br />
<br />
== Resellers ==<br />
* [[MOR API reseller group create]] - create new Reseller Group<br />
<br />
<br><br />
==Version==<br />
* [[MOR API system version get| system_version_get]] (get_version) – get MOR version number.<br />
<br />
<br><br />
= Examples =<br />
* [[MOR API PHP Examples]]<br />
<br />
<br><br><br />
=HTML POST=<br />
All requests are in a similar format:<br />
<br />
HTML POST: http://<SERVER_IP>/billing/api/<function>?u=username<br />
<br />
* username - the user name and password of the user who is asking for the data. <br />
<br />
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.<br />
<br><br><br />
=Useful to know=<br />
<br />
* 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:<br />
** Value of money will be returned in Default System [[Currencies|Currency]].<br />
** Date will not be affected of [[Configuration_from_GUI#Visual| Default date format]] setting.<br />
** Value of money will not be affected of [[Configuration_from_GUI#Visual|Number digits]] setting.<br />
<br />
<br><br><br />
=See also =<br />
* [[API Configuration]]<br />
* [[MOR integration]]<br />
* [[How to block access to some API functions]]<br />
* [[API specification to be implemented in the future]]</div>Edvinashttps://wiki.kolmisoft.com/index.php?title=File:Tariffs_list.png&diff=19091File:Tariffs list.png2015-03-17T11:29:12Z<p>Edvinas: uploaded a new version of "File:Tariffs list.png"</p>
<hr />
<div></div>Edvinashttps://wiki.kolmisoft.com/index.php?title=File:Tariffs.png&diff=19090File:Tariffs.png2015-03-17T11:19:43Z<p>Edvinas: uploaded a new version of "File:Tariffs.png"</p>
<hr />
<div></div>Edvinas