Yeastar Central Management (YCM) - Version 6.0

Overview

The Yeastar Cloud Manager Basic Collector retrieves Cloud PBX instance allocation data from the Yeastar Central Management (YCM) platform using the YCM Open API.

This collector provides visibility into active Cloud PBX instances and their associated capacity allocations — including extension counts, concurrent call capacity, and call recording capacity — enabling organisations to validate 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: Varibill Cloud Source Collectors – Setup and Configuration Guide

Collector Summary

About Yeastar Central Management

Yeastar Central Management (YCM) is a cloud-hosted platform used by service providers and resellers to deploy, manage, and monitor Yeastar Cloud PBX instances across their customer base.

Each Cloud PBX instance (also referred to as a PBX instance) represents an individual customer’s hosted phone system. YCM tracks each instance’s plan, extension capacity, concurrent call capacity, and call recording capacity.

Service providers use YCM to centrally manage their entire Cloud PBX portfolio, giving them visibility into customer subscriptions, capacity allocations, and instance status from a single administrative portal.

Data Collected

The YCMBasic 6.0 collector retrieves unrated Cloud PBX instance allocation data from Yeastar Central Management. The data collected depends on which collection switches are enabled in the collector configuration.

The following allocation types can be collected:

Prerequisites

Before configuring this collector, ensure that:

• You have administrator access to the Yeastar Central Management portal
• The YCM API feature has been enabled in System > API within the YCM portal
• You have copied the Client ID and Client Secret values from System > API
• You have noted the host URL of your YCM portal (for example, https://ycm.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 Central Management instance.

Collection Switches

These parameters control which types of allocation data are collected from each PBX instance. Set each switch to true to collect that data type, or false to skip it.

Product Identifier Parameters

These parameters define the Product Identifier (PI) prefix applied to each allocation record submitted to Varibill. The values must match the product codes configured in your Varibill billing setup.

Operational Parameters

These parameters control collection and file management behaviour.

Configuration Steps

Step 1: Prepare Yeastar Central Management

1. Log in to the YCM portal as an administrator.
2. Navigate to System > API.
3. Enable the API by turning on the API toggle.
4. Copy the Client ID value.
5. Copy the Client Secret value.
6. Note the host URL of your YCM portal.

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 Central Management

3. Enter the connection parameters:

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

4. Configure the collection switches. Set each switch to true for the data types you want to collect.

5. Enter the Product Identifier prefix for each enabled data type. Ensure the values match your Varibill product configuration.

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: Varibill Cloud Source Collectors – Setup and Configuration Guide

Troubleshooting

If the collector fails to connect to Yeastar Central Management, verify that:

• The YCM Host URL is correct and includes https:// with no trailing slash.
• The Client ID is correct.
• The Client Secret is valid and has not been regenerated since it was last copied.
• The YCM API feature is enabled in System > API within the YCM portal.
• No IP restriction rules in the YCM API settings are blocking the Varibill collector’s IP address.

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

• At least one collection switch is set to true.
• There are active PBX instances with a status of Running in your YCM environment.

Yeastar References

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

Yeastar Documentation (External)

• Yeastar Central Management Developer Guide
• Enable YCM API
• YCM API Authorization Rules

Related Documentation

• Introduction to Varibill Cloud Source Collectors
• Varibill Cloud Source Collectors – Setup and Configuration Guide
• Source Collector Classification and Definitions