Connect your Yeastar

Once your Yeastar is connected, every call that ends is sent to ScanBiz, which fetches its recording, transcribes it and analyses it. The wiring happens in two places: the Yeastar phone system page in ScanBiz, and your Yeastar admin portal.

Before you start

• An administrator ScanBiz account, with your e-mail address confirmed.
• Administrator access to your Yeastar P-Series portal, with call recording enabled on the extensions you want analysed.
• The recording announcement set up in your Yeastar: everyone on the call must know it is recorded and analysed. ScanBiz does not play that announcement.
• "Webhook Event Push" sends the events of the whole phone system. You are adding the ScanBiz address to a list: do not remove any address already there, another tool may be using it. On the ScanBiz side, only the extensions you tick are analysed and billed.

Steps

Open Settings, section Connections, then click Connect next to Yeastar phone system. The page has five steps, to follow in order.

1. Enable the API on your Yeastar, in its portal: Integrations › API. Enable the API, create an access — Yeastar then shows a Client ID and a Client Secret, the secret only once — and tick Webhook Event Push. That box has to be ticked in the portal: nothing else can turn it on for you.
2. Enter the API access and the extensions to analyse: fill in Phone system address (the hostname, without https://), API identifier (Client ID), API secret (Client Secret), and check the Phone system time zone — it is preset to your browser's, and a mistake here shifts the time of every call. Then tick the extensions to supervise (or Analyse every call of the phone system), tick the box confirming the recording announcement, and click Create the connection.
3. Declare the ScanBiz address in Yeastar: the step now shows an address. In Webhook Event Push, add it with the POST method and the single event Call recording completed (30012).
4. Paste the webhook secret: when the address is added, Yeastar generates a secret. Copy it from the portal, paste it into Webhook secret, and save. Without it ScanBiz turns away the calls it receives: that secret is what proves they come from your phone system.
5. Make a first call: call from a supervised extension, hang up, then come back to this step. The call shows up within minutes, then in your alerts.

As long as no extension is ticked, calls arrive but are neither analysed nor billed.

If it does not work

The Make a first call step shows a 7-day diagnosis:

• "No call received yet": check in your Yeastar that Webhook Event Push is ticked, that the ScanBiz address is in the list with the POST method, and that event 30012 is selected.
• "… Now tick the extensions to analyse …": your phone system is connected, all that is left is ticking your extensions.
• "… arrived without their recording": enable call recording on those extensions in your Yeastar.
• "… the recording of … could not be retrieved": check that recordings stay available on your phone system (retention, disk space).
• "Your phone system rejected the stored credentials": the API access was deleted or regenerated on the Yeastar side. Create it again, then replace the Client ID and Client Secret in step 2.
• "… fell outside the analysed scope": those calls came from extensions that are not supervised, or were internal. Tell us if they should have been analysed.
• "No call received for 7 days": check that the ScanBiz address is still in Webhook Event Push.

Good to know

• Test the connection queries your phone system with the stored credentials: that is the only test the API allows. Whether calls arrive is judged on the calls received.
• The subscription is billed per supervised extension. Analyse every call of the phone system also includes internal extensions and test calls.
• The times shown follow the time zone entered in step 2: if your calls appear an hour or two off, that is where to look.
• To disconnect your Yeastar, write to the address shown at the bottom of the page.
• Next: Set up an alert.