Charging customers based on voicemail transcription usage

Link copied to clipboard

This handbook demonstrates how to set up charges for voicemail transcription services based on the total duration of transcribed voicemail messages.

EXAMPLE
A service provider offers a prepaid bundle “10h Voicemail Transcription” for $4.99 per month. Every time a voicemail message is transcribed, the duration of the voicemail is deducted from the transcription allocation. Once the allocated volume is used up, customers are charged $0.05 per minute for transcription.

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

To provide voicemail transcription services, an active subscription to the corresponding Add-on Mart speech-to-text module is required.

Call recording transcription can be monetized using the same setup described in this guide. See Charging customers based on the used volume of call recordings and transcriptions for a call recording-specific example. If transcription is enabled for both call recordings and voicemails, their transcription duration is counted as a single usage total (using rate code SpeechToText). Both transcription types consume the same bundle allocation and are billed according to the same pay-as-you-go rate once the allocated volume is exhausted.

This handbook assumes that you have already configured the voicemail and transcription features in the system.

Configuration overview

Link copied to clipboard

The configuration consists of deploying a CDR Mediation instance (typically performed by the PortaOne support team) and configuring billing entities in the PortaBilling web UI, including tariffs, bundle, and product settings.

Configuration steps include:

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

1. CDR Mediation setup

Link copied to clipboard

Billing voicemail transcription requires configuration of CDR Mediation 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 CDR Mediation is configured, obtain the name of the created node from the Support team. This information will be needed when creating the vendor connection in step 3.3.

2. Create a rate code

Link copied to clipboard

To proceed with bundle and pay-as-you-go rate configuration, add the SpeechToText special rate code to your system.

You can find instructions on how to add new rate codes in the Initial configuration: Create rate codes handbook.

The system uses this rate code to identify speech-to-text transcription “events, ” match them with the corresponding tariff rates, and apply bundles.

Create a rate code

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.2, you need to create a vendor connection. This connection will be used to keep records of all transcribed voicemails 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 it as “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.

      Create vendor

  3. Click Save.

3.2 Create a vendor tariff

Link copied to clipboard

The vendor tariff should include a rate for the rate code SpeechToText created in step 2.

To create a vendor 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 transcription”.
    • Currency – choose the currency in which the cost of transcription services will be calculated.
    • Service – select Voice recording.
    • Applied to – select Vendor.
    • Define prices – set per individual rate code.
    • Code group set – select None.

      Add tariff

  3. Open the Rates tab. To add a rate for voicemail transcription, click Add and fill in the rate details:
    • Rate code – type in “SpeechToText” 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 transcribed voicemail that is going to be billed.
    • Next interval, seconds – specify the next rounding interval in seconds (default is 1 second). This determines how the duration beyond the initial interval is billed.
    • First price – specify the price set by the transcription service provider.
    • Next price – specify the price set by the transcription service provider.
    • 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 it from the calendar.

      Add rate

  4. Click Save.

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.

      Create connection

  3. Click Save.

4. Set up the service package

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 a pay-as-you-go rate, e.g., $0.05/minute for transcription. Therefore, it should include a rate for the SpeechToText rate code created in step 2.

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., “Voicemail 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 a customer tariff

  3. Open the Rates tab. To add a rate for transcription, click Add and fill in the rate details:
    • Rate code – type in “SpeechToText” 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 transcribed voicemail that is going to be billed to the customer. For instance, if the first interval is set to 30 seconds, a voice recording lasting between 1 and 30 seconds will be billed as a 30-second voicemail transcription.
    • Next interval, seconds – specify the next rounding interval in seconds (default is 1 second). This determines how the duration of the voicemail 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 voice recording lasts for 36 seconds, the customer will be charged for 36 seconds.
    • First price – specify the per-minute price for the first interval ($0.05 in our example).
    • Next price – specify the per-minute price for the next interval (for our example, it is the same – $0.05).
    • 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 it from the calendar.

      Add rate to the customer tariff

  4. Click Save.

4.2 Create a code group set and code group

Link copied to clipboard

To proceed with the bundle configuration, you need to create a code group set that will be associated with the bundle. The code group set, e.g., “Transcription,” should include the code group “Transcription.” This code group should include the SpeechToText rate code.

You can add a code group “Transcription” to an existing code group set.

To create a code group set and a code group:

  1. Navigate to Service catalog > Code group sets.
  2. Click Add and fill in the required information:
    • Name – type in a descriptive name for the code group set (e.g., “Transcription”).
    • Rate match mode – leave None (default).
    • Type – leave the default type Regular.

      Create a code group set

  3. Open the created Code group set. To add the “Transcription” code group:
    • Click Add and specify the code group name, and optionally, add a description.

      Create a code group

    • Click Save.
  4. To add the rate code to the “Transcription” code group:
    • On the Code group page, click All rate codes.

      Click All rate codes

    • In the Rate code search panel, select Custom in the Format field, specify SpeechToText in the Prefix field to find the required rate code in the list, and click Apply filters.

      Filter custom rate code SpeechToText

    • On the Rate code list panel, select the SpeechToText prefix and click Assign to group.
    • Select the code group “Transcription” and click Assign.

      Assign the rate code to group

  5. Click Save.

4.3 Create a bundle

Link copied to clipboard

The transcription volume (10 hours of 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 “10h Voicemail Transcription”.
    • Currency – select the currency in which you charge your customers.
    • Code group set – select the code group set created at step 4.2.
    • Bundle type – select “Renewable by calendar”.
    • Managed by – select “Administrator only”.
    • Apply bundle if a rate code is found that – leave it in the default option “Matches the rate exactly”.
    • Description – optionally, you can add a short description for this bundle.

      Add a bundle

  3. Create a bundle item with the service volume for voicemail transcription. To add a bundle item, navigate to Bundle items, click Add, and fill in the details:
    • Service – select Voice recording.
    • Code group – select the “Transcription” code group created in step 4.2.
    • Measured as – select Service used.
    • Service volume – specify the service volume in minutes (e.g., 600).

      Add a bundle item

  4. Click Save.

4.4 Create a subscription

Link copied to clipboard

To define the recurring charges (e.g., $4.99 per month) for the allocated transcription volume, 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, “$4.99 Transcription”.
    • Currency – specify the currency in which you charge your customers.
    • Managed by – select Administrator only.
    • 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.
    • Subscription charges applied – select At the end of the billing period.
    • Can be applied more than once – leave this checkbox unchecked.

      Add a subscription plan

  3. Switch to the Fees tab and specify:
    • Activation fee – leave the default value of $0.
    • Monthly fee – specify the monthly periodic fee, e.g., $4.99.

      Specify the monthly fee

  4. Click Save.

4.5 Configure the product

Link copied to clipboard

Before proceeding with this step, ensure that both

voicemail and transcription services are configured for your product.

To edit the existing product:

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

    Add Voice recording service to product

  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.

      Configure usage charges

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

    Select the default bundle

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

    Select the subscription

    6. Click Save.

Docs for
What's new
Admin manuals
Handbooks
UI help
Developers documentation