createTariff()
Create a new tariff.
Available since Sippy 2020
Implementation details
This application supports trusted mode in which case i_customer (integer) parameter should be supplied.
Mandatory parameters
- name - tariff name. String
- currency - tariff currency. String
Optional parameters
- i_tariff_type - tariff type, see getSystemDictionary(tariff_types). Integer. Default is 1.
- connect_fee - connect fee. Double. Default is 0
- free_seconds - free seconds. Integer. Default is 0
- post_call_surcharge - post call surcharge, fraction part. Double. Default is 0
- grace_period - grace period. Integer. Default is 0
- loss_protection - is loss protection enabled. Boolean. Default is FALSE
- max_loss - max loss, fraction part. Double.
- cost_round_up - if call cost is rounded up. If set to 0, default Round is applied to call cost. Boolean. Default is FALSE
- decimal_precision - cost decimal precision. Integer. Default is 20
- average_duration - average call duration (ACD). Integer. Default is 200
- local_calling - is local calling enabled. Boolean. Default is FALSE
- local_calling_cli_validation_rule - CLI validation rule for local calling. String.
Returns
- result - OK means that operation successful. String.
- i_tariff - Id of added tariff. Integer.
- XMLRPC fault in case of any error.
updateTariff()
Update an existing tariff.
Available since Sippy 2020
Implementation details
This application supports trusted mode in which case i_customer (integer) parameter should be supplied.
Mandatory parameters
- i_tariff - tariff Id. Integer.
Optional parameters
all parameters listed in createTariff().
NOTE: currency and i_tariff_type can not be changed after creation of Tariff.
Returns
- result - OK means that operation successful. String.
- XMLRPC fault in case of any error.
deleteTariff()
Delete an existing tariff.
Available since Sippy 2020
Implementation details
This application supports trusted mode in which case i_customer (integer) parameter should be supplied.
Mandatory parameters
- i_tariff - tariff Id. Integer.
Returns
- result - OK means that operation successful. String.
- XMLRPC fault in case of any error.
getTariffInfo()
Get tariff parameters.
Available since Sippy 2020
Implementation details
This application supports trusted mode in which case i_customer (integer) parameter should be supplied.
Mandatory parameters
- i_tariff - tariff Id. Integer.
Returns
- result - OK means that operation successful. String.
- tariff - structure of tariff parameters
- XMLRPC fault in case of any error.
getTariffsList()
Get list of tariffs.
Available since Sippy 2020
Implementation details
This application supports trusted mode in which case i_customer (integer) parameter should be supplied.
Optional parameters
- name_pattern - pattern to filter by tariff name (SQL syntax for the ILIKE operator is used). String.
- offset - skip fist offset records. Integer.
- limit - return only limit records. Integer.
Returns
- result - OK means that operation successful. String.
- tariffs - array of tariffs (i_tariff, name, currency, i_tariff_type)
- XMLRPC fault in case of any error.