Yeastar S Series Cloud Edition – Version 1.0

Modified on Mon, 20 Jul at 2:22 PM

Overview

The Yeastar S Series Cloud Edition Collector retrieves PBX extension allocation data from a Yeastar S Series PBX (Cloud Edition) using the Yeastar S Series API v2.

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

Field	Value
Source Collector Name	Yeastar S Series Cloud Edition – Version 1.0
Collection Behavior	Point in Time
Rating Model	Unrated
Vendor Name	Yeastar
Product	Yeastar S Series PBX – Cloud Edition
Purpose	Retrieves PBX extension allocation data from a Yeastar S Series Cloud Edition PBX for billing and validation within Varibill

About Yeastar S Series Cloud Edition

Yeastar is a global provider of unified communications solutions for businesses. The Yeastar S Series PBX is an IP phone system designed for small to medium-sized enterprises, offering voice, video, and collaboration features.

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

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

Data Collected

The Yeastar S Series Cloud Edition 1.0 collector retrieves unrated extension allocation data from the PBX. For each registered extension, the collector captures the extension number, associated trunk information, caller ID details, and email address.

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

Note: The Yeastar S Series Cloud Edition 1.0 collector reflects the state of the PBX at the time it runs. More frequent execution improves billing accuracy for environments with frequent extension changes.

Prerequisites

Before configuring this collector, ensure that:

You have administrator access to the Yeastar S Series PBX web interface
The PBX API feature has been enabled in the PBX administration settings
You have an API 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

Note: The S Series API v2 requires authentication with a username and password. The password may need to be provided in MD5-encoded format depending on your PBX configuration. The collector includes an option to convert the password to MD5 automatically.

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

Parameter	What it is	Where to find it
Yeastar S Series PBX Host	The base URL of your Yeastar S Series PBX instance	Your PBX administrator or hosting provider. Format: `https://pbx.example.com` (include `https://`, no trailing slash)
Yeastar S Series API Username	The API username used to authenticate with the PBX	PBX web interface → API settings or your PBX administrator
Yeastar S Series API Password	The API password used to authenticate with the PBX	PBX web interface → API settings or your PBX administrator
Convert Password to MD5 Encoding	When set to `true`, the collector automatically converts the API password to MD5 format before authenticating. Set to `false` if the password is already MD5-encoded.	Default: `true`

Warning! The API password grants access to your Yeastar PBX. Store it securely and do not share it. If the password is compromised, change it immediately in the PBX administration interface.

Billing Parameters

Parameter	What it is	Where to find it
Product Identifier Code	The Product Identifier applied to each extension allocation record submitted to Varibill. This value must match the product code configured in your Varibill billing setup.	Your Varibill product configuration. Example: `YS-Cloud-Ext`

Operational Parameters

These parameters control collection and file management behavior.

Parameter	What it is	Default
Delete data files older than	The number of days after which locally stored collection files are automatically deleted	`62`
Maximum number of records per file	The maximum number of records written to a single output file before a new file is started	`10000`

Yeastar References

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

Yeastar Documentation (External)

Note: Yeastar documentation is provided for reference. Steps and interface labels may vary depending on your PBX firmware version and account permissions.

Configuration Steps

Step 1: Prepare Yeastar S Series PBX

Log in to the Yeastar S Series PBX web interface as an administrator.
Enable the API feature in the PBX administration settings.
Create or confirm an API username and password.
Note the host URL of your PBX instance.

Step 2: Configure the Collector in Varibill

In the Varibill User Interface, open the Source Collector configuration screen.
Enter the required field values under the Details tab:
- Hosting Provider: Select Varibill Cloud
- Source Collector Name: Select Yeastar S Series Cloud Edition
Enter the connection parameters:
- Yeastar S Series PBX Host: The base URL of your PBX instance (for example, https://pbx.example.com)
- Yeastar S Series API Username: The API username from the PBX settings
- Yeastar S Series API Password: The API password from the PBX settings
- Convert Password to MD5 Encoding: Set to true unless your password is already MD5-encoded
Enter the billing parameters:
- Product Identifier Code: The product code matching your Varibill product configuration
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 S Series PBX, verify that:

The PBX Host URL is correct and includes https:// with no trailing slash.
The API Username is correct.
The API Password is correct and has not been changed since it was last configured.
The Convert Password to MD5 Encoding setting matches your PBX requirements.
The API feature is enabled in the PBX administration settings.
No firewall or IP restriction rules are blocking the Varibill collector’s IP address.

If no data is returned despite a successful connection, verify that:

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