Yeastar P-Series, S-Series and Cloud PBX

Yeastar PBXs report each finished call as an API event with its call detail record (CDR). P-Series (appliance, software edition and Cloud Edition) can post it to a webhook address, or Telyzer keeps a WebSocket connection to the PBX, or asks its CDR API. S-Series and the earlier Cloud PBX send the event to Telyzer after Telyzer signs in to their API.

Phone systems this guide covers

Values in dashed boxes are this organization's own: the portal's How to connect panel shows them filled in, with copy buttons.

Webhook — the PBX posts each finished call to Telyzer (HTTPS)

Recommended for Telyzer Cloud. For: P-Series PBX System, P-Series Cloud Edition.

Telyzer Cloud

1. Sign in to the PBX web portal and open Integrations → API; turn the API on if it is off. Tick Webhook Event Push and choose Add.
2. Webhook URL: your connector's push address. Request Method: POST.
3. Event: tick Call End Details Notification (event 30012) only.
4. Copy the Secret the PBX generated and paste it into Webhook secret in Telyzer, so every delivery's signature is checked.
5. Set Timeout(s) to 10 and Retry Count to the highest value offered, then Save. The test button under Operations sends a test message that Telyzer accepts.

Telyzer Server

1. Sign in to the PBX web portal and open Integrations → API; turn the API on if it is off. Tick Webhook Event Push and choose Add.
2. Webhook URL: your connector's push address. Request Method: POST.
3. Event: tick Call End Details Notification (event 30012) only.
4. Copy the Secret the PBX generated and paste it into Webhook secret in Telyzer, so every delivery's signature is checked.
5. Set Timeout(s) to 10 and Retry Count to the highest value offered, then Save. The test button under Operations sends a test message that Telyzer accepts.
6. On a Telyzer Server this address is the server's own portal address on your local network; the PBX must be able to reach it.

WebSocket events — Telyzer stays connected to the PBX (with history)

Recommended for Telyzer Server. For: P-Series PBX System, P-Series Cloud Edition.

Telyzer Cloud

1. Sign in to the PBX web portal and open Integrations → API. Turn the API on and note the Client ID and Client Secret it shows.
2. Under IP Restriction, allow the address Telyzer connects from only, so no one else can use these credentials.
3. In Telyzer, enter the PBX's address (Cloud Edition: its domain), the port (8088; Cloud Edition 443), the Client ID as user name and the Client Secret as password, and the series, then choose Check connection.
4. Telyzer subscribes to call-end events and keeps the connection alive. After any interruption it catches up through the CDR API, and on the first connection it collects the last 30 days of calls.
5. An on-premises P-Series must be reachable from the internet on its API port for Telyzer Cloud. If it is not, use the webhook instead, or the Telyzer Relay on your network: telyzer-relay add-collector --kind yeastar_p_ws --host <PBX address> --user <Client ID> --password <Client Secret>, then Restart-Service TelyzerRelay.

Telyzer Server

1. Sign in to the PBX web portal and open Integrations → API. Turn the API on and note the Client ID and Client Secret it shows.
2. Under IP Restriction, allow the address Telyzer connects from only, so no one else can use these credentials.
3. In Telyzer, enter the PBX's address (Cloud Edition: its domain), the port (8088; Cloud Edition 443), the Client ID as user name and the Client Secret as password, and the series, then choose Check connection.
4. Telyzer subscribes to call-end events and keeps the connection alive. After any interruption it catches up through the CDR API, and on the first connection it collects the last 30 days of calls.

CDR API — Telyzer asks the PBX for new records every minute

For: P-Series PBX System, P-Series Cloud Edition.

Telyzer Cloud

1. Sign in to the PBX web portal and open Integrations → API. Turn the API on and note the Client ID and Client Secret it shows.
2. Under IP Restriction, allow the address Telyzer connects from only, so no one else can use these credentials.
3. In Telyzer, enter the PBX's address (Cloud Edition: its domain), the port (8088; Cloud Edition 443), the Client ID as user name and the Client Secret as password, and the series, then choose Check connection.
4. Telyzer asks the PBX's CDR API for new records every minute; on the first connection it collects the last 30 days of calls.
5. An on-premises P-Series must be reachable from the internet on its API port for Telyzer Cloud. If it is not, use the webhook instead, or the Telyzer Relay on your network: telyzer-relay add-collector --kind yeastar_p_api --host <PBX address> --user <Client ID> --password <Client Secret>, then Restart-Service TelyzerRelay.

Telyzer Server

1. Sign in to the PBX web portal and open Integrations → API. Turn the API on and note the Client ID and Client Secret it shows.
2. Under IP Restriction, allow the address Telyzer connects from only, so no one else can use these credentials.
3. In Telyzer, enter the PBX's address (Cloud Edition: its domain), the port (8088; Cloud Edition 443), the Client ID as user name and the Client Secret as password, and the series, then choose Check connection.
4. Telyzer asks the PBX's CDR API for new records every minute; on the first connection it collects the last 30 days of calls.

API events — Telyzer signs in and the PBX sends each record

Recommended for Telyzer Cloud and Telyzer Server. For: S-Series VoIP PBX. The S-Series API is not available on S20, S412 and S412 Lite.

1. Check the model and firmware: the API needs firmware 30.13.0.30 or later, and S20, S412 and S412 Lite do not have it.
2. Sign in to the PBX web interface and open Settings → PBX → General → API. Tick Enabled, set Report Method to HTTP where it is offered, and set a Username and Password for the API (not an administrator login). Save and apply.
3. In Telyzer, enter the PBX's address, port 8088, and the API's Username and Password, then choose Check connection.
4. Telyzer signs in and tells the PBX to send each call record to your Telyzer address port your connector's port; there is nothing else to set on the PBX.

Through the Telyzer Relay on your network

For: S-Series VoIP PBX.

1. Sign in to the PBX web interface and open Settings → PBX → General → API. Tick Enabled, set Report Method to HTTP where it is offered, and set a Username and Password for the API (not an administrator login). Save and apply.
2. In Telyzer, open this connector and choose Create enrollment code. You get a code and a download link for the person at the site; both work once and expire in 24 hours.
3. On an always-on Windows PC on the same network as the phone system, open the link and run TelyzerRelaySetup.exe (the code is filled in). Choose Another phone system and Install. The relay runs as the TelyzerRelay service; only outbound HTTPS leaves this PC.
4. On the relay PC (PowerShell as Administrator): telyzer-relay add-collector --kind yeastar_s_events --host <PBX address> --user <API username> --password <API password>, then Restart-Service TelyzerRelay. The relay signs in and the PBX sends each record to the relay PC on port 33333.
5. Check it from the relay PC: telyzer-relay check-collector <PBX address>.

API events — Telyzer signs in and the PBX sends each record

Recommended for Telyzer Cloud and Telyzer Server. For: Cloud PBX.

1. Sign in to the PBX web interface and open Settings → PBX → General → API. Tick Enabled, set Report Method to HTTP where it is offered, and set a Username and Password for the API (not an administrator login). Save and apply.
2. In Telyzer, enter the Cloud PBX's address (its domain), port 443, and the API's Username and Password, then choose Check connection.
3. Telyzer signs in and tells the Cloud PBX to send each call record to your Telyzer address port your connector's port.

Check that it works

1. Make an external test call and hang up. The phone system sends the record when the call ends, so it arrives a few seconds later.
2. In Telyzer, Waiting for the first call record turns green when the first record is read. If it shows a problem instead — no connection yet, connections refused, or records that could not be read — it names the cause and shows the line received.
3. The same call appears in the PBX's own CDR list. A sign-in problem shows in Telyzer as a precise error (wrong credentials, address refused, PBX unreachable).
4. S-Series and Cloud PBX: five failed sign-ins lock Telyzer's address for 10 minutes. To unlock it at once, delete it under PBX → System → Security → IP Auto Defense → Blocked IP Address (Cloud PBX: Settings → System → Security → Access Control → Blocked IP Address).

Notes

• Webhook needs P-Series firmware 37.20.0.21 or later, or Cloud Edition 84.20.0.21 or later. A PBX holds up to five webhooks, so Telyzer can share it with other applications.
• A webhook carries only calls that end after it is added; the WebSocket and CDR API ways also bring in the last 30 days.
• Telyzer uses the API only to receive call records; it does not control calls or change extensions and routes.

All phone systems