Yeastar P Series Cloud Edition PBX - Version 1.0

Overview

The Yeastar P Series Cloud Edition PBX - Version 1.0 collector retrieves PBX extension allocation data from a Yeastar P-Series PBX (Cloud Edition) using the Yeastar P-Series OpenAPI v1.0.

This collector provides visibility into registered extensions across the PBX, enabling organizations to validate subscriptions, allocate costs per extension, and reconcile PBX license usage within Varibill.

The collector retrieves unrated allocation data, meaning no monetary values are supplied by the source system. Pricing and billing calculations are applied within Varibill based on configured contracts and pricing rules.

This is a point-in-time collector, meaning each execution retrieves the current state of extensions registered on the PBX at the time of collection.

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

Collector Summary

About Yeastar P-Series Cloud Edition

Yeastar is a global provider of unified communications solutions for businesses. The Yeastar P-Series PBX System is a next-generation phone system designed for businesses of all sizes, offering voice, video, messaging, and contact centre capabilities in a single platform.

The Cloud Edition of the P-Series PBX is a hosted deployment managed by a service provider, giving customers a fully featured business communications system without on-premises hardware. Each PBX instance supports extensions, trunks, call management features, and integrations configured through a web-based administration interface.

Service providers use the P-Series Cloud Edition to deliver hosted PBX services across their customer base, with each PBX instance representing an individual customer’s communications system.

Data Collected

The Yeastar P Series Cloud Edition PBX - Version 1.0 collector retrieves unrated extension allocation data from the PBX. For each registered extension, the collector captures the extension number, caller ID name, email address, mobile number, and role name.

Each extension is submitted as a single allocation record with a quantity of 1, representing one active extension license on the PBX.

The Client Identifier groups records by PBX domain and extension role. It is constructed as {PBX domain}#{role name}, where the PBX domain is the host URL with the protocol removed. Extensions with no assigned role use an empty string for the role portion.

The Product Identifier for all records is set to the configured Product Identifier parameter value.

The Record Identifier for each record takes the form PBX Extension License - Ext. {extension number} ({email address}).

The Unique Identifier for each record is constructed as {PBX domain}#{extension ID}, where the extension ID is the internal identifier assigned by the Yeastar PBX.

Prerequisites

Before configuring this collector, ensure that:

• You have administrator access to the Yeastar P-Series PBX web interface
• The PBX OpenAPI feature has been enabled in the PBX administration settings
• You have created API credentials (username and password) with permission to query extensions
• You have noted the host URL of your PBX instance (for example, https://pbx.example.com)
• You have access to the Varibill Source Collector configuration screen

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 Yeastar P-Series PBX instance.

Billing Parameters

API Behavior Parameters

These parameters control how the collector interacts with the Yeastar PBX API.

Operational Parameters

These parameters control file management behavior.

Configuration Steps

Step 1: Prepare Yeastar P-Series PBX

1. Log in to the Yeastar P-Series PBX web interface as an administrator.
2. Enable the OpenAPI feature in the PBX administration settings.
3. Create or confirm API credentials (username and password) with permission to query extensions.
4. Note the host URL of your PBX instance (for example, https://pbx.example.com).

For detailed instructions, see the Yeastar P-Series Cloud Edition Developer Guide.

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 Yeastar P Series Cloud Edition PBX - Version 1.0

3. Enter the connection parameters:

   • Yeastar P Series PBX URL: The base URL of your PBX instance (for example, https://pbx.example.com)
   • Yeastar P Series API Username: The API username from the PBX settings
   • Yeastar P Series API Password: The API password from the PBX settings

4. Enter the billing parameters:

   • Product Identifier: The product code matching your Varibill product configuration

5. Optionally adjust the API behavior parameters:

   • Number of results per page: Default is 50
   • Seconds to wait between API calls: Default is 1

6. 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 the Yeastar P-Series PBX, verify that:

• The Yeastar P Series PBX URL is correct and includes https:// with no trailing slash.
• The Yeastar P Series API Username is correct.
• The Yeastar P Series API Password is correct and has not been changed since it was last configured.
• The OpenAPI feature is enabled in the PBX administration settings.
• No firewall or IP restriction rules are blocking the Varibill collector’s IP address.

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

• There are active extensions registered on the PBX.
• The API user has sufficient permissions to query the extension list.

Yeastar References

The following resources may assist with locating values or configuring your Yeastar P-Series API access.

Yeastar Documentation (External)

• Yeastar Website
• Yeastar P-Series Cloud Edition Developer Guide