3.2. How to add/import tariff rates

Welcome to the next VoipSwitch tutorial! In this session, we will guide you through the process of efficiently adding and importing tariff rates in the VoipSwitch VSM4 portal.

To get started, please visit your VSM4 portal and log in.

1. Introduction

From manually creating and adjusting tariff rates to importing multiple rates at once. Follow these essential steps for effectively managing tariffs.

2. Click "Tariffs"

To get started click on BILLING in the menu, then select TARIFFS

3. Choose "Tariff"

Next, proceed to click on any of the available tariffs listed.

4. Click "Call rates" or "SMS rates"

In the dialog that appears, navigate to the CALL RATES or SMS RATES tab.

5. Click "Add"

A tariff can include an unlimited number of defined prefixes, typically representing country codes. Each prefix is associated with specific rates and additional properties. Billing is conducted using the prefix that most accurately aligns with the dialed number and time span. In this process, more detailed and longer prefixes take priority over shorter ones. In this tab, you can click the Add button to manually create a new tariff rate or use the Import option, which will be detailed later.

6. Click "Prefix"

Click on the PREFIX field and enter the proper data.

7. Fill "Prefix"

Typically, it will be either the country code or the complete phone number for comparison and matching during the billing process.

8. Click "Description"

Next, please provide a concise description for the rate.

9. Fill "Description"

Typically, this field should contain the name of the destination country. The same description can be applied to various prefixes and will facilitate broader summary groupings in the future. It’s crucial to complete the prefix descriptions with accuracy, as they will be referenced throughout the system.

10. Click "Country"

Next, select the country associated with the prefix. This selection helps in organizing the prefixes by country.

11. Choose "Country"

Please note that this field is optional, allowing you to either select a country or leave it blank.

12. Set "Time span"

The values specified in the below section determine the active days of the week and the corresponding hours for the designated prefix with specific properties. You can define the active period by selecting the range of days (From day and To day) and the hours (From hour and To hour) during which the prefix will be in effect.

13. Set "Time span" properties

Please note that time intervals crossing over midnight, such as from 10 PM to 6 AM, you need to create two separate entries. The first entry should represent the period from 10 PM to midnight, and the second entry should cover the time from midnight to 6 AM.

14. Adjust the properties

Many prefix parameters mirror those found in a tariff, enabling you to assign distinct values for individual prefixes.

15. Toggle "Rate"

The first and most important step is to establish the rate value. This represents the cost per minute for calls or the cost per SMS, depending on where you set it—either in the Call Rates or SMS Rates section.

16. Fill "Rate"

Toggle the switch to the green position to set it up. Ensure that this rate is specified in the same currency as the associated tariff.

17. Toggle "Multiplier"

Similarly, to enable the multiplier, simply toggle the switch to the green position.

18. Fill "Multiplier"

It will allow you to adjust the cost of each rate by applying a specified value. For instance, if the multiplier is set to 1.1, every rate will be increased by 10% compared to what is presented to the client. Conversely, setting the multiplier to 0.8 will reduce each rate by 20%.

19. Toggle "Addition"

Proceed to the next field, which is Addition.

20. Fill "Addition"

It works similarly to a multiplier; however, instead of multiplying, it adds a specified value to a rate per minute or SMS.

21. Click "Grace period"

Next, we have the Grace Period feature. To activate it, simply toggle the switch to the green position and specify your preferred duration in seconds. This feature allows users to make free calls for a limited time.

22. Fill "Grace period"

Please notice that calls exceeding the specified duration will be billed at the standard rate, which includes the full length of the call along with the grace period. This feature is particularly beneficial for destinations where call quality may be inconsistent. It allows customers to enjoy a grace period during which they can disconnect without incurring charges if they find the call quality unsatisfactory.

23. Toggle "Minimal time"

In the following row, you have the option to enable the Minimal Time feature.

24. Fill "Minimal time"

This value specifies the minimum duration of a call, measured in seconds, that is used for billing purposes. Regardless of whether the call lasts for a shorter period, the charge will reflect the established minimum time.

25. Toggle "Resolution"

Next you can set up the Resolution

26. Fill "Resolution"

Each rate allocated to a prefix is based on a per-minute basis. The tariff definition enables charging clients for shorter durations, starting from as little as one second and extending to any number of seconds. The resolution parameter governs this aspect. Specified in seconds, the resolution determines the fraction of a minute's price that should be applied to the cost of a call. While the resolution can be set to any value, for straightforward calculations, it is recommended to choose a value that evenly divides 60.

27. Toggle "Surcharge time"

After that, you can modify the surcharge time setting.

28. Fill "Surcharge time"

This value specifies the initial duration of a call, measured in seconds, during which a Surcharge amount may be applied. The remaining duration of the call will be billed according to the rules outlined in the sections on Minimal Time and Resolution. It is important to note that if the Surcharge amount is set to 0, the initial call duration defined in the Surcharge Time will be free for the client.

29. Toggle "Surcharge amount"

Additionally, you can customize the Surcharge amount setting.

30. Fill "Surcharge amount"

This field defines the initial amount added at the start of each call. If the Surcharge time is set to 0, it functions as a connection fee for any call that connects. Once the surcharge period concludes, billing will commence as if it were the start of the call.

31. Click "Bundles"

In the final row, you have the option to assign Bundles to the rate.

32. Choose "Bundles"

You have the flexibility to choose as many bundles as you wish. The charging function will first verify whether the client account has sufficient balance in the selected bundle. If the balance is available, the cost of the call will be calculated based on the properties and rates associated with that bundle.

33. Click "Save"

Congratulations! You have successfully completed the creation of your tariff rate. To finalize this process, simply click the SAVE button.

34. Click "Import"

It's essential to add that you don't have to add rates individually; you can import multiple rates at once. To initiate the import process, just click the Import button.

35. Overview

In the pop-up window, you can easily drag and drop the CSV file that contains the rates you want to import. Please ensure that your CSV file includes a header with the appropriate column names, following a specific order, and that the values are separated by either semicolons or commas. The prefixes for the rates and any additional parameters should be listed directly under the header. To assist you, an example file is available for download; simply click the download icon located in the bottom right corner.

36. Set up "Mapping"

In the Mapping section, you can easily align fields from your import file with the corresponding properties of the tariff rate.

37. Click "Repeated record action"

Please note that, by default, if there are existing prefixes that match those being imported, they will not be replaced. You can choose your preferred action for handling duplicate prefixes during the import process by selecting an option at the top of the window under the Repeated Record Action section.

38. Click "Repeated record action"

You have the option to choose from Default, Skip, Replace, or Remove and insert.

39. Click "Import"

To initiate the import of rates, simply click the 'Import' button.

40. Check "Summary"

Please be aware that the import process may take some time, depending on the number of rows in the file you are importing. Once the import is complete, you can review the summary for details.

This guide detailed the process of adding tariff rates in Voipswitch VSM4 portal. By following the step-by-step instructions, you can efficiently set up tariffs rates within the system and save them with ease. Thank you for watching this tutorial. See you next time.