Setup guide

1. Turn on the Yeastar API

1. Sign in to the Yeastar PBX web portal as an administrator.
2. Go to Integrations > API and switch the API on.
3. Note the Client ID (API Username in the app) and Client Secret (API Password).
4. If IP restriction is on for the API, allow Freshworks' outbound IP addresses for your region, or the app's requests will be refused.

2. Turn on the Linkus SDK

1. In the same portal, go to Integrations > Linkus SDK and switch it on.
2. Note the AccessID and AccessKey. They are different from the API credentials in step 1.

3. Find your PBX host

• With Yeastar remote access, use the domain alone, e.g. acme.ras.yeastar.com.
• With your own domain, add the web port if it isn't 443, e.g. pbx.acme.com:8088.
• Use a domain name, not an IP address: Freshworks does not call IP addresses. Leave out https:// and any trailing /.
• Self-hosted PBX: the domain needs a publicly trusted SSL certificate. If Drop All but Accepted IPs is on, accept Freshworks' outbound IPs and the public IPs your agents work from.

4. Give every agent's extension an email address

1. In the PBX portal, open Extension and Trunk > Extension and edit each agent's extension.
2. Fill in the Email Address, using the same email the agent signs in to Freshworks with. The dialer cannot sign in an extension without one, and the email lets tickets be assigned to the right agent.

5. Get your Freshworks details

• Domain: the first part of the address you sign in at. For https://acme.freshdesk.com, enter acme.
• API key: click your avatar (top right), then Profile Settings, then API key. Use an administrator's key: calls are logged with its permissions.

6. Install the app

1. Find Jasco Dialer in the Freshworks Marketplace and click Install.
2. Enter your License Key. The form checks it as you type and shows whether it is accepted.
3. Choose your product: Freshdesk, Freshservice or Freshworks CRM. Only that product's fields are shown.
4. Enter the PBX host, the API Client ID and Secret, and the Linkus SDK AccessID and AccessKey.
5. Enter your Freshworks domain and API key.
6. Optionally set call dispositions, contact creation and how contact records open.
7. Click Install.

Installation is refused if the License Key is missing, wrong, or not issued for this Freshworks account. Contact Jasco Communications if that happens.

7. Agents sign in

1. Each agent clicks the phone icon in the left bar of Freshworks.
2. They enter their extension number and click Sign In.
3. The browser asks for microphone access, which must be allowed.