Release

Search

Charging customers based on the used volume of call recordings and transcriptions

Link copied to clipboard

This handbook demonstrates how to set up charges for call recording and transcription services based on the total duration of recorded and transcribed calls. You can offer your customers a bundle with the allocated service volume, such as “10+10h Call Recording & Transcription” for $10 per month. When the customers use up the allocated volume, you can charge them at a pay-as-you-go rate.

Charges are applied once a day using the xDR Mediator utility.

To provide call transcription service, an active subscription for the corresponding Add-on Mart module is required. If you do not intend to provide transcription services, you can set up charging for call recording as described in this handbook and disregard all transcription-related instructions. For example, you will not need to add a special SpeechToText destination to the system at step 2 or add the SpeechToText rate to the tariffs at step 3.1.

Example

Link copied to clipboard

A service provider offers a bundle “10+10h Call Recording & Transcription” for $10 per month that includes:

  • 10 hours of call recording
  • 10 hours of call transcription

Recording one hour deducts one hour from both quotas, since all recorded calls are automatically transcribed.

Once the allocated volume is used up, the customers are charged according to the pay-as-you-go rates:

  • $0.03/minute for recording
  • $0.05/minute for transcription
This handbook assumes that you have already configured call recording and transcription features in the system (check instructions on how to configure call transcription via Open AI’s Whisper here).

Configuration overview

Link copied to clipboard

The configuration consists of deploying a new CDR Mediation instance which is typically performed by the PortaOne support team, and configuration steps on the PortaBilling web UI, such as creating tariffs, bundle, and setting up the product.

  1. CDR Mediation setup
  2. Create destinations
  3. Set up a vendor to calculate costs
  4. Set up the service package

1. CDR Mediation setup

Link copied to clipboard

Billing call recordings and transcriptions require CDR Mediation to be configured for your billing environment. Since the CDR Mediation setup is a complex procedure that should be performed by an experienced engineer with advanced knowledge of PortaBilling, we recommend contacting our Support team for assistance.

After the CDR Mediation is configured, make sure to obtain the name of the created node from the Support team. This information will be needed to create a vendor connection at step 4.

2. Create destinations

Link copied to clipboard

To proceed with the bundle and pay-as-you-go rates configuration, add the CallRecording and SpeechToText special destinations to your system. You can find the instructions on how to add new destinations in the Initial configuration: Create destinations handbook.

Create destinations

3. Set up a vendor to calculate costs

Link copied to clipboard

PortaBilling requires that every service is accounted for both on the revenue side (customers) and the cost side (vendors). You need to create a vendor in the system to calculate service costs. To assign a vendor tariff created at step 3.1, you need to create a vendor connection. This connection will be used to keep records of all recorded/transcribed calls and track the costs, for example, charges from your speech-to-text provider like Whisper.

3.1 Create a vendor

Link copied to clipboard
  1. On the navigation menu on the left, select Infrastructure, then Vendors.
  2. Click Create and fill in the Create vendor form:
    • Name – type a short name for the vendor, for example, “Third-party services”.
    • Currency – choose the currency in which the costs are calculated.
    • Opening balance – this option is usually used when you migrate a vendor from a legacy system to PortaSwitch. Leave “0” here.
    • Billing period – choose a billing period for the vendor. A billing period defines how often the vendor will bill you, e.g., monthly.
  3. Click Save.

    Create a vendor

3.2 Create a vendor tariff

Link copied to clipboard

The vendor tariff should include rates for destinations CallRecording and SpeechToText created in step 2. The system uses these destinations to distinguish between call recording and transcription services while matching them with the rate within a tariff.

  1. Navigate to Service catalog > Tariff.
  2. Click Add and fill in the tariff details:
    • Name – specify a name for the tariff, such as “Vendor call recording & transcription”.
    • Currency – choose the currency in which the cost of call recording and transcription services will be calculated.
    • Service – select Voice recording.
    • Applied to – select Vendor.
    • Routing – leave this toggle disabled.

      Add vendor tariff

  3. Open the Rates tab. To add a rate for call recording, click Add and fill in the rate details:
    • Destination – type in “CallRecording” or select it from the list.
    • Rating mode – select Flat rate.
    • First interval, seconds – specify the first rounding interval in seconds (default is 1 second). This interval defines the minimum duration of the recorded call that is going to be billed to the customer. For instance, if the first interval is set to 30 seconds, a recording lasting between 1 and 30 seconds will be billed as a 30-second call.
    • Next interval, seconds – specify the next rounding interval in seconds (default is 1 second). This determines how the call recording duration beyond the initial interval is billed. For example, if the next interval is set to 1 second, any duration beyond the initial interval will be billed in 1-second increments. If you set the first interval to 30 seconds and the next interval to 1 second, and the call recording lasts for 36 seconds, the customer will be charged for 36 seconds.
    • First price – specify the per-minute price for the first interval.
    • Next price – specify the per-minute price for the next interval.
    • Effective from – specify when the rate becomes effective. By default, this parameter is set to “immediately”. If you want this rate to take effect sometime in the future, select “Specific time” and type in the date manually, or select in the calendar.Add vendor tariff rate

Add a rate for the transcription service in the same way. Select the “SpeechToText” destination for this rate and set the corresponding price set by the transcription service provider.

3.3 Create a vendor connection

Link copied to clipboard
  1. On your vendor’s panel, click Connections.
  2. Click Add and fill in the connection details:
    • Description – type a short description for the connection.
    • Service type – select Voice recording.
    • Tariff – select the vendor tariff created in step 3.2.
    • Node – select the name of the node from step 1.
    • Capacity –  type “1” here.
  3. Click Save.

    Create vendor connection

4. Set up the product

Link copied to clipboard

Charging at a pay-as-you-go rate can be enabled only on the Main product. You can create a new product or update an existing one.

When setting up the product, use the default service type “Voice recording”.

4.1 Create a customer tariff

Link copied to clipboard

You need to create a Customer tariff that will be used to charge your customers at pay-as-you-go rates, e.g., $0.03/minute for recording and $0.05/minute for transcription. Therefore, it should include rates for destinations CallRecording and SpeechToText created in step 2.

The system uses these destinations to distinguish between call recording and transcription services while matching them with the rate within a tariff.

To create a customer tariff:

  1. Navigate to Service catalog > Tariffs.
  2. Click Add and fill in the tariff details:
    • Name – set a descriptive name for the customer tariff, e.g., “Call recording & transcription”.
    • Currency – select the currency in which you will charge your customers.
    • Service – select Voice recording.
    • Applied to – select Customer.
    • Managed by – select Administrator only here.

      Create customer tariff

  3. Open the Rates tab. To add a rate for call recording, click Add and fill in the rate details:
    • Destination – type in “CallRecording” or select it from the list.
    • Rating mode – select Flat rate.
    • First interval, seconds – specify the first rounding interval in seconds (default is 1 second). This interval defines the minimum duration of the recorded call that is going to be billed to the customer. For instance, if the first interval is set to 30 seconds, a call lasting between 1 and 30 seconds will be billed as a 30-second call.
    • Next interval, seconds – specify the next rounding interval in seconds (default is 1 second). This determines how the call recording duration beyond the initial interval is billed. For example, if the next interval is set to 1 second, any duration beyond the initial interval will be billed in 1-second increments. If you set the first interval to 30 seconds and the next interval to 1 second, and the call lasts for 36 seconds, the customer will be charged for 36 seconds.
    • First price – specify the per-minute price for the first interval ($0.03 in our example).
    • Next price – specify the per-minute price for the next interval (for our example, it is the same – $0.03).
    • Effective from – specify when the rate becomes effective. By default, this parameter is set to “immediately”. If you want this rate to take effect sometime in the future, select “Specific time” and type in the date manually, or select in the calendar.

      Add rates to the customer tariff

Add a rate for the transcription service in the same way. Select the “SpeechToText” destination for this rate and set the corresponding price ($0.05 in our example).

Customer tariff rate list

4.2 Create a destination group set and a destination group

Link copied to clipboard

To proceed with the bundle configuration, you need to create a destination group set that will be associated with the bundle. The destination group set, e.g., “Call recording and transcription,” should include two destination groups, e.g., “Call recording” and “Recording transcription.” These destination groups should include the CallRecording and SpeechToText destinations correspondingly.

You can add the destination groups “Call recording” and “Recording transcription” to an existing destination group set.

To create a destination group set and a destination group:

  1. Navigate to Service catalog > Destination group sets

    Service catalogue - gestination group set

  2. Click Add and fill in the required information:
    • Name – type in a descriptive name for the destination group set (e.g., “Call recording and transcription”).
    • Type – leave the default type Regular.

      Add destination group set

  3. Open the created Destination group set. To add the “Call recording” destination group:
    • click Add and specify the destination group name, and optionally, add a description.

      Add destination group

    • Click Save.
  4. To add the destination to the “Call recording” destination group:
    • On the Destination group page, click All destinations.

      All destinations list

    • In the Destination search panel, select Custom in the Format field, specify CallRecording in the Prefix field to find the required destination in the list, and click Apply filters.

      Apply filters

    • On the Destination list panel, select the CallRecording prefix and click Assign to group.
    • Select the destination group “Call recording” and click Assign.

      Assign destination

Repeat steps d-e to add the “Call transcription” destination group with the corresponding destination.

List of destinations in group

4.3 Create a bundle

Link copied to clipboard

The quotas (10 hours of call recording and 10 hours of call transcription) can be provided within a bundle.

To create a bundle:

  1. Navigate to Bundles and click Add.
  2. Fill in the required fields:
    • Name – give the bundle a descriptive name. In this example, the bundle name is “10+10h Call Recording & Transcription”.
    • Currency – select the currency in which you charge your customers.
    • Destination group set – select the destination group set created at step 4.2
    • Managed by – select “Administrator only”.
    • Apply bundle if a destination is found that – leave the default option “Matches the rate exactly”.
    • Bundle type – select “Legacy (quotas and wallets) ”.
    • Description – optionally, you can add a short description for this bundle.

      Add a bundle

  3. Create a quota with the service volume for call recording. To add a quota, navigate to Bundle items, click Add, and fill in the details:
    • Type – select Quota.
    • Service – select Voice recording.
    • Destination group – select the “Call recording” destination group created in step 4.2.
    • Measured as – select Service used.
    • Service volume –  specify the service volume in minutes.

      Add call recording quota

  4. Add a quota with the service volume for call transcription:
    • Type – select Quota.
    • Service – select Voice recording.
    • Destination group – select the “Call transcription” destination group created at step 4.2.
    • Measured as – select Service used.
    • Service volume –  specify the service volume in minutes.

Every time a call is recorded and transcribed, the system will deduct the same number of minutes from both quotas.

Bundle item list

4.4 Create a subscription

Link copied to clipboard

To define the recurring charges (e.g., $10 per month) for the allocated call recording and transcription quotas, create a subscription:

  1. Navigate to Subscriptions and click Add.
  2. Fill in the subscription details:
    • Name – type the name of the subscription plan; in this example, “10$ Call recording & transcription”.
    • Currency – specify the currency in which you charge your customers.
    • Managed by – select  Administrator only.
    • Subscription charges applied – select At the end of the billing period.
    • Activation mode – leave the default option "At the given start date." This means that the subscription will be activated when it’s assigned to an account with a product.
    • Activation fee – leave the default value of $0.
    • Monthly fee – specify the monthly periodic fee, e.g., $10.
    • Can be applied more than once – leave this checkbox unchecked.
  3. Click Save.

    Add subscription plan

4.5 Configure the product

Link copied to clipboard

Before proceeding with this step, ensure that both call recording and transcription services are configured on your product.

To edit the existing product:

  1. Open the product’s Services tab and add the Voice recording service.

    Product - Services

  2. Open Charges > Usage charges, and click Add. Fill in the details:
    • Service – select Voice recording
    • Node – select the node created at step 1.
    • Access code – leave this field empty.
    • Tariff – select the customer tariff created in step 4.1.

      Product - usage charges

  3. On the Charges > General info panel, select the bundle created at step 4.3 from the Default bundle dropdown list.

    Default bundle

  4. On the Charges > General info > Account subscription panel, select the subscription plan created at step 4.4 from the Account subscription dropdown list.

    Account subscription

  5. Click Save on the toolbar.

On this page

Release
What's new
Admin manuals
Handbooks
API
UI help
Search