Yeastar PBX Integration
The Yeastar integration connects ACCELERO to a Yeastar PBX, allowing you to make and receive phone calls directly through the browser — without a physical phone or external softphone. Voice communication happens via WebRTC, using Yeastar's official SDK (ys-webrtc-sdk-ui).
The extension numbers are associated with the companies registered in ACCELERO, and a dedicated screen lists the companies with an extension for one-click dialing.
This integration is provided as a plugin (yeastar) and must be installed and enabled by the IONGRADE technical team. Contact support to check compatibility with your ACCELERO version.
Current plugin version: 0.0.1 — compatible with ACCELERO 2.16.9 or higher.
What the integration does
With the plugin active, ACCELERO incorporates a telephony widget into the browser and starts using the Yeastar PBX extensions associated with the companies.
| Feature | What happens in ACCELERO |
|---|---|
| Telephony widget | A telephony component (WebRTC SDK) is injected into every screen for those with the proper permission |
| Make calls | On the Yeastar Extensions screen, the Call button starts a call to the company's extension in one click |
| Receive calls | Incoming calls are handled by the WebRTC widget directly in the browser |
| Associate extensions | The company registry gains the Extension field, linking a PBX extension to the company |
| Extension listing | The Yeastar Extensions screen gathers all enabled companies that have a registered extension |
Dialing and answering directly from the browser, based on the ACCELERO company registry, without dedicated telephony hardware at the workstation.
Configuration
Navigation path: Settings > Plugins - Yeastar PBX
The configuration screen has a single tab (General) with the connection data to the PBX.
The Plugins - Yeastar PBX configuration screen (Settings > Plugins - Yeastar PBX), showing the PBX Address, User, Password, and Email (Generic Extension) fields and the information block.
| Field | Description |
|---|---|
| PBX Address | Full URL of the Yeastar PBX (e.g., https://pbx.exemplo.com) |
| User | User with access to the PBX API |
| Password | Corresponding password |
| Email (Generic Extension) | Email associated with the extension that will be used by ACCELERO for communication. Must match the generic extension on the PBX |
The screen also displays a notice informing that the integration uses the ys-webrtc-sdk-ui SDK for call management.
The PBX address and the API credentials are defined together with the customer's telephony technician. Without PBX Address, User, and Email filled in, the telephony widget is not loaded.
Screen buttons
| Button | Function |
|---|---|
| Back | Returns to the settings list |
| Save | Persists the connection data |
Fields added to entities
Company
The plugin adds the Yeastar Integration section to the company registry, with a single field:
The Yeastar Integration section in the company registry, showing the Extension field.
| Field | Description |
|---|---|
| Extension | Number of the Yeastar extension associated with this company (e.g., 1001). Accepts up to 20 characters |
When saving the company, the provided extension is stored in the company's metadata (yeastar.ramal) and starts appearing on the Yeastar Extensions screen.
The Yeastar Extensions screen lists only enabled companies with the Extension field filled in. Companies without an extension do not enter the dialing list.
Yeastar Extensions (listing and dialing)
Path: Side menu > Yeastar Extensions
The Companies with Extensions screen gathers all enabled companies that have a registered extension, allowing direct dialing.
The Yeastar Extensions screen (Companies with Extensions), showing the search by description, the table of companies with an extension, and the green Call button on each row.
Columns
| Column | Content |
|---|---|
| Description | Company name |
| Division | Company division |
| Extension | Yeastar extension associated with the company |
| Actions | Call button |
Search
The screen offers a search by company Description, with the Search, Close, and Clear buttons.
Dialing
Click the Call button (headset icon) on the company's row to start the call to the corresponding extension:
- If the company does not have an extension, the system displays the message "This company does not have a registered extension."
- If the telephony widget has not yet loaded, it displays "The telephony system is not ready. Wait a few seconds and try again." — wait a few seconds and try again.
The Yeastar Extensions menu and dialing are only available to operators with the Yeastar - make calls permission (yeastarCall).
Telephony widget (WebRTC)
When the integration is configured and the operator has the Yeastar - display telephony widget permission, the plugin automatically injects a telephony component into every ACCELERO screen. This widget, based on Yeastar's WebRTC SDK, is responsible for establishing the voice connection in the browser, starting the calls triggered by the Yeastar Extensions screen, and handling incoming calls.
The Yeastar telephony widget loaded on an ACCELERO screen (idle state and during a call).
Voice communication happens through the browser. Keep ACCELERO open and make sure the browser has permission to access the microphone. The integration is intended for desktop browsers.
Permissions
The plugin creates two operator permissions, controlled by the ACCELERO administrator:
| Permission | Internal function | What it enables |
|---|---|---|
| Yeastar - display telephony widget | yeastarWidget | Loads the WebRTC telephony widget on the ACCELERO screens |
| Yeastar - make calls | yeastarCall | Displays the Yeastar Extensions menu and allows starting calls |
Assign Yeastar - display telephony widget to those who need to answer/make calls in the browser and Yeastar - make calls to those who operate the dialing screen. Normally the two go together for the same operator.
How the integration connects to the PBX
ACCELERO authenticates against the Yeastar PBX API using the configured User and Password, obtains an access token (kept in cache for about 25 minutes), and generates a sign for the WebRTC SDK from the Email (Generic Extension). This sign is used by the widget in the browser to establish the telephony session.
Obtaining the token and generating the sign are handled internally by the plugin. The operator does not need to interact with this process — the configuration just needs to be correct and valid.
Use cases
Enable Yeastar telephony
- Request that IONGRADE install the
yeastarplugin. - In
Settings > Plugins - Yeastar PBX, fill in PBX Address, User, Password, and Email (Generic Extension) and click Save. - Grant the Yeastar - display telephony widget and Yeastar - make calls permissions to the operators who will make calls.
- In the registry of each relevant company, fill in the Extension in the Yeastar Integration section.
Call a company
- In the side menu, access Yeastar Extensions.
- Locate the company (use the search by description, if needed).
- Click the Call button on the company's row.
- Conduct the call through the telephony widget in the browser.
Best practices
- Correct generic extension email: the Email (Generic Extension) field must match the extension used by ACCELERO on the PBX; an incorrect value prevents the generation of the WebRTC session.
- Consistent extensions: register the extension exactly as configured on the PBX. Companies without an extension do not appear on the dialing screen.
- Lean permissions: grant the Yeastar permissions only to the operators who actually use telephony.
- Microphone allowed: advise the operators to allow microphone access in the browser on first use.
Troubleshooting
The telephony widget does not appear
Possible causes:
- Incomplete configuration (missing PBX Address, User, or Email)
- Operator without the Yeastar - display telephony widget permission
- Plugin not enabled
Solution:
- In
Settings > Plugins - Yeastar PBX, confirm that the connection fields are filled in. - Check whether the operator has the Yeastar - display telephony widget permission (
yeastarWidget). - Refresh the page (F5).
The "Call" button does not work
Possible causes:
- The company does not have a registered extension
- The telephony widget has not yet loaded
- Operator without the Yeastar - make calls permission
Solution:
- Confirm that the company has the Extension filled in the Yeastar Integration section.
- If "The telephony system is not ready" appears, wait a few seconds and try again.
- Check the Yeastar - make calls permission (
yeastarCall).
There is no audio on the call
Possible causes:
- Browser without microphone permission
- Computer volume turned off
Solution:
- Allow microphone access in the browser.
- Check the computer's volume and audio devices.
- Refresh the page and redo the call.
Integration with other modules
Companies
The integration depends on the Companies registry: the Extension field links the PBX extension to the company, and the Yeastar Extensions screen lists only enabled companies with an extension filled in.
Operators and Permissions
Access to the widget and to dialing is controlled by the Operators permissions Yeastar - display telephony widget and Yeastar - make calls.