PortaOne Trunk - Version 8.0

Modified on Wed, 19 Aug at 9:51 AM

Overview

The PortaOne Trunk - Version 8.0 collector retrieves an inventory of SIP trunks and aliases from a PortaOne billing and switching environment, providing a current snapshot of active trunk and alias provisioning across all customers.

This collector enables organizations to track the number of SIP trunks and aliases provisioned per customer in PortaOne, supporting billing for trunk capacity and virtual number (alias) allocations within Varibill.

The collector retrieves unrated data, meaning no monetary values are included. Pricing is applied within Varibill using configured price lists and billing rules.

This is a point-in-time collector, meaning each execution captures the current state of trunk and alias provisioning at the time the collector runs, rather than data for a historical date range.

For general instructions on creating and running Source Collectors, see: Configuring a New Cloud Source Collector

Collector Summary

Field Value
Source Collector Name PortaOne Trunk - Version 8.0
Collection Behavior Point-in-Time
Rating Model Unrated
Vendor Name PortaOne
Product PortaSwitch / PortaBilling
Purpose Retrieves an inventory of SIP trunks and aliases from PortaOne for billing trunk and alias provisioning within Varibill

About PortaOne

PortaOne is a telecommunications software company that provides integrated billing and service management solutions for communication service providers worldwide. Founded in 2001, PortaOne serves over 500 telecom operators across more than 100 countries, ranging from wholesale carriers to retail service providers.

PortaOne’s core platform, PortaSwitch, is a unified service management and delivery platform covering voice, messaging, IoT/M2M, and data traffic. PortaBilling, its accompanying billing component, enables service providers to manage subscriber accounts, rating, and revenue collection.

PortaOne is used by a broad range of providers including Mobile Virtual Network Operators (MVNOs), cloud PBX operators, traditional carriers, and internet-based telephony providers.

Note: PortaOne documentation is available at docs.portaone.com. Documentation is version-specific — ensure you are referencing the guide for your deployed PortaOne release.

Data Collected

The PortaOne Trunk - Version 8.0 collector retrieves the current inventory of SIP trunks and aliases provisioned in a PortaOne environment. The collector retrieves the full customer list, then queries each customer’s active (not closed) accounts to identify trunks and aliases.

Each record represents a single trunk or alias and includes:

  • The type of account — trunk or alias — determined by the account’s billing model
  • The account number (the id field from PortaOne)
  • The customer name associated with the account
  • A quantity of 1 per record

The collector distinguishes between two types of accounts:

  • Trunks — accounts with a billing model value of 1 and no extension ID. These represent SIP trunk connections.
  • Aliases — all other accounts that pass the filter. These represent virtual numbers or DID allocations.

An optional SIP Trunk Only filter allows the collector to restrict output to trunk-type accounts only, excluding aliases entirely.

The identifiers submitted to Varibill for each record are constructed as follows:

  • Product Identifier — uses the configured Product Identifier for Trunk parameter for trunk accounts, or the configured Product Identifier for Alias parameter for alias accounts
  • Client Identifier — the PortaOne customer ID
  • Record Identifier — describes the account type and number. For trunks: A trunk exists with number {account number}. For aliases: An alias exists with number {account number}
  • Unique Identifier — the PortaOne internal account ID (i_account)

Note: This collector submits unrated data — no monetary values are included in the collected records. Pricing for trunks and aliases is applied within Varibill.

Prerequisites

Before configuring this collector, ensure that:

  • You have access to a PortaOne environment (PortaSwitch / PortaBilling)
  • You have a PortaOne user account with read access to customer and account data
  • You have an API token associated with that account
  • You have noted the base URL of your PortaOne instance (for example, https://portaone.example.com)
  • You have access to the Varibill Source Collector configuration screen

Tip: PortaOne API tokens are typically generated or retrieved from within the PortaOne administrative interface. Contact your PortaOne system administrator if you do not have a token or are unsure of the correct host URL.

Warning! The PortaOne Token grants API access to your PortaOne environment. Store it securely and do not share it. The token is masked in the Varibill UI once saved.

Configuration Parameters

The parameters below are entered when configuring the collector in Varibill. They are grouped by function.

Connection Parameters

These parameters identify and authenticate against your PortaOne instance.

Parameter What it is Where to find it
Portaone Host The base URL of your PortaOne instance Your PortaOne management interface URL. Format: https://portaone.example.com (include https://, no trailing slash)
Portaone Username The username of the PortaOne account used to connect Your PortaOne user account name
Portaone Token The API token associated with the PortaOne user account Generated or retrieved from the PortaOne administrative interface

Warning! The Portaone Token is a sensitive credential. It is masked in the Varibill UI once saved. If it is compromised, revoke and regenerate it immediately in the PortaOne administrative interface.

Product Identifier Parameters

These parameters define the product identifiers assigned to trunk and alias records when submitted to Varibill. They allow you to map trunk and alias inventory to specific Varibill products for billing.

Parameter What it is Default
Product Identifier for Trunk The product identifier assigned to trunk-type accounts in Varibill (blank)
Product Identifier for Alias The product identifier assigned to alias-type accounts in Varibill (blank)

Note: These values must match the product identifiers configured in your Varibill product catalog. For example, you might use PO-SIP for trunks and PO-VDIN for aliases, but the specific values depend on how your Varibill products are set up.

Account Type Filter

Parameter What it is Default
SIP Trunk Only When set to true, only trunk-type accounts (billing model = 1, no extension ID) are collected. Alias-type accounts are excluded. When set to false, both trunks and aliases are collected. false

Time Zone Parameter

Parameter What it is Default
Time Zone Hourly Offset Applied to the LastSeenDate timestamp to align with your local time zone. A value of 2 represents UTC+2. 0

Operational Parameters

These parameters control API pagination and file management behavior.

Parameter What it is Default
API Page Limit The number of records requested per API page when paginating through results. Must be at least 100. 500
Delete data files older than The number of days after which locally stored collection files are automatically deleted. Must be at least 1. 62
Maximum number of records per file The maximum number of records written to a single output file before a new file is started. Must be between 1,000 and 50,000. 10000

Configuration Steps

Step 1: Prepare Your PortaOne Environment

  1. Confirm that your PortaOne instance is accessible via HTTPS.
  2. Identify the PortaOne user account that Varibill will use to connect. This account must have read access to customer and account data.
  3. Obtain or generate an API token for that user account.
  4. Note the base URL of your PortaOne instance (for example, https://portaone.example.com).

Step 2: Configure the Collector in Varibill

  1. In the Varibill User Interface, open the Source Collector configuration screen.

  2. Enter the required field values under the Details tab:

    • Hosting Provider: Select Varibill Cloud
    • Source Collector Name: Select PortaOne Trunk - Version 8.0
  3. Enter the connection parameters:

    • Portaone Host: The base URL of your PortaOne instance
    • Portaone Username: The PortaOne user account name
    • Portaone Token: The API token for that account
  4. Set the Product Identifier for Trunk to the Varibill product identifier that represents SIP trunks.

  5. Set the Product Identifier for Alias to the Varibill product identifier that represents aliases or virtual numbers. If you plan to use SIP Trunk Only mode, this value can be left blank.

  6. Set the SIP Trunk Only parameter to true if you only want to collect trunk-type accounts, or leave it as false to collect both trunks and aliases.

  7. Set the Time Zone Hourly Offset to reflect the UTC offset of your local time zone.

  8. Save the collector configuration.

Step 3: Run the Collector

Run or schedule the collector according to your standard Source Collector execution process.

For detailed instructions, see: Configuring a New Cloud Source Collector

Troubleshooting

If the collector fails to connect to PortaOne, verify that:

  • The Portaone Host URL is correct and includes https:// with no trailing slash.
  • The Portaone Username is correct and the account is active.
  • The Portaone Token is valid and has not expired or been revoked.
  • The PortaOne instance is reachable from the Varibill Cloud environment. If your PortaOne instance restricts access by IP, ensure Varibill’s collector IP addresses are permitted.

If the collector connects successfully but returns no data, verify that:

  • At least one customer exists in the PortaOne environment with active (not closed) accounts.
  • If SIP Trunk Only is set to true, confirm that trunk-type accounts (billing model = 1) exist for at least one customer.
  • The Product Identifier for Trunk and Product Identifier for Alias values match products configured in Varibill.

PortaOne References

The following resources may assist with locating values or understanding your PortaOne configuration.

PortaOne Documentation (External)

Note: PortaOne documentation is provided for reference. Interface labels and available features may vary depending on your deployed PortaOne release version.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article