Yeastar Management Plane - Version 2.0

Overview

The Yeastar Management Plane - Version 2.0 collector retrieves Cloud PBX instance data from the Yeastar Management Platform (YMP) using the YMP Open API.

This collector provides visibility into each Cloud PBX instance’s extension capacity, call recording capacity, and activation status, enabling service providers to validate PBX subscriptions and allocate costs 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 PBX instances and their capacity allocations 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 Management Platform

Yeastar Management Platform (YMP) is a cloud-hosted management console used by service providers and managed service providers to deploy, manage, and monitor Yeastar Cloud PBX instances across their customer base.

Each Cloud PBX instance represents an individual customer’s hosted phone system. YMP tracks each instance’s status, extension capacity, concurrent call capacity, and call recording capacity. Service providers use YMP to centrally manage their entire Cloud PBX portfolio from a single administrative portal.

Data Collected

The Yeastar Management Plane - Version 2.0 collector retrieves unrated Cloud PBX instance allocation data from the Yeastar Management Platform. The collector queries all PBX instances, filters to those with a status of Running, and produces three types of records:

Each record type uses a separate Product Identifier prefix configured in the collector parameters, with the PBX instance’s activation status appended (either Activated or Unactivated).

Records are automatically excluded in the following cases:

• Extension records are excluded when the extension count is zero.
• Call recording records are excluded when call recording is not enabled on the PBX instance, or when the recording capacity is zero.

Prerequisites

Before configuring this collector, ensure that:

• You have administrator access to the Yeastar Management Platform portal
• The YMP API feature has been enabled within the YMP portal
• You have generated or located the Client ID and Client Secret values from the API settings
• You have noted the host URL of your YMP portal (for example, https://ymp.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 Management Platform instance using OAuth 2.0 client credentials.

Product Identifier Parameters

Each data type uses a Product Identifier prefix that is combined with the PBX instance’s activation status to form the final Product Identifier submitted to Varibill.

Operational Parameters

These parameters control file management behavior.

Configuration Steps

Step 1: Prepare Yeastar Management Platform

1. Log in to the YMP portal as an administrator.
2. Navigate to the API settings section.
3. Enable the API feature if it is not already enabled.
4. Copy the Client ID value.
5. Copy the Client Secret value.
6. Note the host URL of your YMP portal.

For detailed instructions, see the YMP API Overview.

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 Management Plane - Version 2.0

3. Enter the connection parameters:

   • YMP Host: The base URL of your YMP portal (for example, https://ymp.example.com)
   • YMP Client ID: The Client ID from the YMP API settings
   • YMP Client Secret: The Client Secret from the YMP API settings

4. Enter the Product Identifier prefix for each data type:

   • Extension Code Product Identifier Prefix: The prefix for extension records (for example, YMPExt)
   • Recording Code Product Identifier Prefix: The prefix for call recording records (for example, YMPRecording)
   • PBX Instance Product Identifier Prefix: The prefix for PBX instance records (for example, YMPPBXInstance)

5. 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 Management Platform, verify that:

• The YMP Host URL is correct and includes https:// with no trailing slash.
• The YMP Client ID is correct.
• The YMP Client Secret is valid and has not been regenerated since it was last configured.
• The YMP API feature is enabled in the YMP portal.
• 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 PBX instances with a status of Running in your YMP environment.
• The PBX instances have non-zero extension or recording capacity values (records with zero values are automatically excluded).

Yeastar References

The following resources may assist with locating values or configuring your Yeastar Management Platform API access.

Yeastar Documentation (External)

• Yeastar Website
• YMP API Overview