Connect Yeastar P-Series PBX

Yeastar P-Series is a phone system sold in three editions — Cloud, Appliance and Software — that share one API. StackJack talks to whichever edition a customer runs, so one connector covers a hosted PBX and an on-premises one alike.

Connecting a Yeastar PBX to StackJack gives your AI assistant a family of yeastar_ MCP tools — MCP (Model Context Protocol) tools are the standardized commands an AI assistant can call through StackJack. With them, your AI can:

• Answer questions about calls — search call detail records, pull the report behind a busy morning, read call notes, and find the recording for a specific call
• Look up the phone system — extensions and who they belong to, extension groups, organizations, company contacts and phonebooks
• Check the estate — PBX capacity before you sell more seats, firmware and system information, storage, backup status and system logs
• Read the call path — SIP trunks and the ITSPs behind them, inbound and outbound routes, blocked and allowed number rules, and PIN lists
• Read call flow — IVRs, ring groups, queues and paging groups, plus queue agents and their current state
• Onboard a person (on Pro plans) — create an extension, put it in the right groups and organization, and send the Linkus welcome email
• Provision a desk phone (on Pro plans) — bulk add phones of the same model, push a rewritten configuration, and reboot or reprovision them
• Change the call path (on Pro plans) — add and edit trunks, inbound and outbound routes, number rules and PIN lists
• Work the contact center (on Pro plans) — manage queues and agents, run conferences, control live calls, and handle messaging channels and sessions
• Handle voicemail and prompts (on Pro plans) — manage voicemail, greetings and the custom prompts an IVR plays

How StackJack authenticates to Yeastar

Yeastar has no vendor portal and no partner-level credential. Every customer's PBX issues its own pair, so you do this once per PBX you want StackJack to reach.

In the PBX web portal go to Integrations > API. Turn the API on, add a third-party application for StackJack, and copy the Client ID and Client Secret it shows you. Paste those into StackJack along with the address you reach that PBX at.

StackJack exchanges the pair for a short-lived session on every call and keeps it cached, so nothing expires on you and there is no renewal step. The pair keeps working until someone regenerates it on the PBX.

Give StackJack its own application

The PBX allows only eight simultaneous sessions per application. If another integration is already using an application, and you point StackJack at the same Client ID, the two compete for the same eight and both start failing at busy moments. Create a separate application for StackJack.

Two things to get right before you save

Use an HTTPS address. The Client Secret travels in the sign-in request and the session token travels in every call. A plain http:// address would expose both.

Check the pair before you save it. Five failed sign-ins in a row cause the PBX to block the caller's address, and Yeastar provides no way to clear that block remotely — an administrator has to clear it in the PBX web portal under Integrations > API. StackJack stops trying after three failures and disables the connection instead, which is what keeps a typo from getting you blocked, but a hand-typed retry loop can still get there.

Reaching an on-premises PBX

A Cloud Edition PBX is already reachable. An Appliance or Software Edition PBX sits on the customer's own network, and StackJack calls it from the internet rather than from inside that network. It works only if you have published the PBX at a public address with a valid certificate. If you have not, that customer's PBX is not reachable and the connection test will say so.

What you can connect

One connection reaches one PBX, because the credentials are minted on the PBX itself. If you manage several customers' phone systems, add one named connection per customer on the same Yeastar card — see Several customers below.

Permissions

Yeastar's API has no permission scopes. A Client ID reaches everything the PBX exposes, and there is nothing to tick or untick on the Yeastar side.

That makes StackJack the only place least privilege happens, so it is worth being deliberate:

• Reads are Free. Everything that only answers a question — call records, extensions, trunks, queues, capacity, reports — is available on the Free plan.
• Every change is Pro. Creating, editing, deleting, and anything that touches a live call.
• The tools you allow are the boundary. An assistant that only needs to answer questions about calls should be granted read tools and nothing else.

Tools that change live phone service

Some of these tools do things a customer will notice immediately. StackJack marks each of them as a change tool, and it is worth knowing which they are before you grant them. Whether your AI application stops to ask you first depends on that application's own settings — see Destructive tools and confirmation. Review those settings, and restrict the tools you grant, before you allow changes:

• Live calls — hanging up, transferring, parking, redirecting or monitoring a call in progress
• Queue agents — logging an agent in or out, or pausing them. Customer calls stop reaching a paused agent with nothing visibly broken
• Desk phones — rebooting, reprovisioning, or pushing a rewritten configuration to phones people are using
• Messages to people — sending an email, a Linkus welcome email, a chat message, leaving a voicemail, playing a recording to an extension, or ringing a hotel room
• Who can call in and out — trunks, outbound routes, PIN lists, and blocked or allowed number rules. A wrong rule silently drops legitimate calls or opens a path you did not intend
• Deletions — every delete, plus wiping an extension's voicemail
• Webhook connectivity tests — the test makes your PBX send a request to the address you give it, so it reaches whatever host that address points at

Where the numbers come from

Every page-size limit here is StackJack's, not Yeastar's. For most lists Yeastar documents no maximum at all, so StackJack caps a page at 500 records to keep a single answer readable. Call detail records are the one place Yeastar publishes a ceiling, and it is 10,000 — StackJack caps them lower, at 1,000, because a 10,000-record answer is past what an assistant can work through in one reply. Ask for a narrower date range or filter rather than a larger page.

Several customers

Every customer has their own PBX. Add one connection per customer from the connector's card, name it after the customer, and your AI names it on each call. Omit the name and the call runs against your default connection. Pin an endpoint to one connection when an AI should never reach past a single customer. See Several connections of one connector.

Full tool reference

Every yeastar_ tool, with its plan and whether it reads or changes something: Yeastar P-Series PBX tools.

Yeastar P-Series PBX tools

yeastar_ · 297 tools · Free 158 · Pro 139

Contacts

Extension

Extension Group

Organization

Phonebook

API Feature Settings

Auto Provisioning

Auto Recording Setting

Backup

Onsite Proxy

Storage

System

System Log

Time Zone

Blocked/Allowed Numbers

Inbound Route

Outbound Route

PIN List

Trunk

IVR

Paging

Queue

Ring Group

Voice Prompt

Voicemail

Voicemail Greeting

Call Note

Call report

CDR

Recording

Messaging

Conference

Call control

uaCSTA call control

WebSocket Audio Streaming

Hotel