System General Settings

The system general settings can be applied globally to Yeastar Cloud PBX

System Preference

Configure the preferences settings that will be applied globally to the system.

Go to Settings > PBX > General > Preferences to configure the system preferences.

General Preference

Extension Preference

Below are default extension ranges. You can change the extension range according to your needs.Note: PBX treats Ring Group, Paging Group, Conference, Queue as extensions. Extension users can dial the extension numbers to reach them directly.

Feature Code

Feature codes are used to enable and disable certain features available in the Yeastar Cloud PBX. Extension users can dial feature codes on their phones to use that particular feature.

Go to Settings > PBX > General > Feature Code to view or change the feature code settings.

• Feature Code Digit Timeout: The timeout to input next digit. The default is 4000 ms.

Default Feature Codes

SIP Settings

The SIP configurations require professional knowledge of SIP protocol, incorrect configuration may cause calling issues on the SIP extensions and SIP trunks.

Go to Settings > PBX > General > SIP to configure the SIP settings.

SIP General Settings

SIP Codec

A codec is a compression or decompression algorithm that used in the transmission of voice packets over a network or the Internet.Codec SelectionYeastar Cloud PBX supports G711 a-law, u-law, GSM, H261, H263, H263P, H264, SPEEX, G722, G726, ADPCM, G729A, MPEG4, opus and iLBC.Note:

• You need to choose at least one same code on the PBX and on your phones, or there may be a problem of the call.
• If you want to make video calls, you need to select H261, H263, H263P, H264 or MPEG4 codec on the PBX and on your phones.iLBC SettingsThe iLBC codec supports two modes: 20ms and 30ms frame length modes,To get better voice quality, you need to set the iLBC mode according to your SIP endpoints.Note: Linkus uses iLBC 20ms mode. When Linkus is enabled, this option is switched to 20ms mode automatically.

TLS Settings

Session Timer

A periodic refreshing of a SIP session that allows both the user agent and proxy to determine if the SIP session is still active.

Qos

QoS (Quality of Service) is a major issue in VoIP implementations. The issue is how to guarantee that packet traffic for a voice or other media connection will not be delayed or dropped due interference from other lower priority traffic.

When the network capacity is insufficient, QoS could provide priority to users by setting the value.

T.38

Adjust T.38 settings if T.38 Fax don't work.

Advanced SIP Settings

Security

Restrict International Calls to Specific Countries and Regions

By default, users can place calls to any countries and regions. Yeastar Cloud PBX allows you to restrict users from making international calls to specific countries and regions.

Scenario

A manufacturer has a factory in Mexico, and his target customers are in Argentina. The manufacturer wants to set up a rule to restrict employees from making international calls to other countries.

Procedure

1. Go to Settings > System > Security > Allowed Country Codes.
2. In the Operation section, enable international dialing protection, and set international dialing code.
3. Select the checkbox of Enable Allowed Country/Region Code Dialing Protection.Extension users can ONLY make international calls to the allowed countries or regions.
4. In the International Dialing Code field, enter the international call prefix according to your country. In the scenario, enter 00.When a user tries to call a number starting with 00, the PBX's outbound route will identify this call as an international call, and then check if the country/region code is allowed.Note: Make sure there is at least one outbound route that matches with the international dialing code to route the international calls.
5. Click Save.
6. In the Country/Region Code Dial Management section, set users can make international calls to which countries or regions.

1. In the search box, enter the desired countries or regions. In the scenario, enter Argentina.
2. In the Allow column, turn on the option.In the scenario, users can NOT make international calls to countries/regions except Argentina.Note: Some countries or regions share the same code (e.g. The country code for Canada and America is 1 ). If you allow international dialing to a country/region, users can also place calls to the countries/regions that share the same code.

ResultWhen a user dials a number, PBX's outbound route will check if the dialing is valid:

• If a user dials International Dialing Code + allowed Country/Region Code, the dial is considered as valid.
• If a user dials International Dialing Code + disallowed Country/Region Code, the dial is considered as invalid.
• If a user only dials Country/Region Code, the PBX will check if there is a matched outbound route to route the call out.

Blocked IP Address

The PBX will block an IP address for too many failed login attempts, too many failed registration attempts, or too many failed authentications for Auto Provisioning.

The blocked IP addresses would be listed in the Blocked IP Address table. If a trusted IP address was blocked by the PBX, you can go to Settings > System > Security > Access Control > Blocked IP Address to delete the IP address.

Service

All the PBX service statuses and ports are displayed on the security Service page.

Go to Settings > System > Security > Service to configure the service settings.

Database Grant

Yeastar Cloud PBX is based on MySQL database. A third-party software can access the database of PBX. Grant permissions to database before accessing the database of PBX.

PrerequisitesDatabase Grant is associated with SBC, version requirements are as follows:

• SBC version: 1.6.19 or later
• PBX version: 81.14.0.67 or later

If Database Grant feature is not available after upgrade, contact your PBX provider.

Applications

By accessing the database of PBX, you can get CDR and save it to the local database.

Capture data in database

1. Add database grant on PBX for the targeted device.
2. Log in to the PBX web interface, go to Settings > System > Security > Database Grant.
3. Select the checkbox of Enable Database Grant.
4. Configure the settings:

• Username: Enter the username that can be used by third party to access the database of PBX.
• Password: Enter the password that can be used by third party to access the database of PBX.
• Permitted IP/Subnet Mask: Enter the IP address or IP section that is allowed to access the database of PBX. The input format should be XXX.XXX.XXX.XXX.For example: 216.207.245.47 means that only the device with IP address 216.207.245.47 is allowed to access the database of PBX.

1. Click Save and Apply.

You will get the Database Address and Port for database connection.

Access the database of PBX.

The following takes Navicat for MySQL for example to introduce how to access the database of PBX.

1. Open Navicat for MySQL, click Connection, and select MySQL.
2. Configure Navicat for MySQL with the authentication information provided on PBX.

• Connection Name: Enter a connection name to help you identify it.
• Host: Enter the Database Address of PBX.
• Port: Enter the PBX port 12000.
• User Name: Enter the user name configured on Database Grant of PBX.
• Password: Enter the password configured on Database Grant of PBX.

1. Click Test Connection to make sure that the connection is successful, and then click OK.
2. Click cdr table, you can see existing cdr tables on PBX
3. Note: The database generates a cdr table every month.

CDR Parameters in Database

Descriptions for CDR parameters in the database of PBX.

Description of CDR Parameters

Asterisk Manager Interface (AMI)

The Asterisk Manager Interface (AMI) is a system monitoring and management interface provided by Asterisk. Yeastar Cloud PBX supports AMI that allows you to connect an AMI client to Yeastar Cloud PBX.

What is Asterisk Manager Interface (AMI)

Asterisk Manager Interface(AMI) is a standard management interface into Asterisk server. It is a client/server model over TCP that allows a client program to connect to an Asterisk server and issue commands or read events over a TCP/IP stream. With the manager interface, you can control the PBX, originate calls, check mailbox status, monitor extensions and so on.

Connect an AMI client to Yeastar Cloud PBX

1. Enable AMI on PBX.
2. Log in to the PBX web interface, go to Settings > System > Security > Service.
3. Select the checkbox of Enable AMI.
4. Configure the connection authentication.

• Username: Enter the username that can be used by third party to access the AMI of PBX.
• Password: Enter the password that can be used by third party to access the AMI of PBX.
• Permitted IP/Subnet Mask: Enter the IP address or IP section that is allowed to access the AMI of PBX. The input format should be XXX.XXX.XXX.XXX.

For example: 216.207.245.47 means that only the device with IP address 216.207.245.47 is allowed to access the AMI of PBX.

Click Save and Apply.

You will get the Service Address and Port for AMI connection.

1. Configure AMI client with the authentication information provided on PBX, and connect client to PBX.

User Permission

By default, the extension users can log in the system and check their own settings and CDR. You can set different permission to the users according to their roles and duty.

User Types on the PBXSuper Admin

Super Admin has the highest privilege. The super administrator can access all pages on S-Series Web and make all the configurations on the system.

• Username: admin

Administrator or Custom UserAdministrator or Custom User is created by the Super Admin. The Super Admin sets the privileges for those users according to their roles and duty.

• Username: The email address of the extension user.Note:
• Administrator and Custom User can have the same permission. The different between the two role type:
• Administrator: All permissions are enabled by default.
• Custom User: No permission is enabled by default.
• Administrator and Custom User do not have permission to configure User Permission.

Configure User Permission

To grand more privilege for a user or change the user's privilege, you need to configure the User Permission on PBX.

Scenarios

In the following scenarios, you may need to add permissions for the extension users according to their roles.

• For an HR, he/she may need the permission to add extension, configure extension's outbound route privilege when there are new staffs.
• For a supervisor, he/she will have permission to check the CDR and recordings, and have no permission to configure the system or other extensions.

Procedures

1. Log in the PBX web interface by the super admin account, go to Settings > System > User Permission, click Add.
2. On the configuration page, select the User.
3. Set the Set Privilege As.

• Administrator: All the permissions are enabled for the user by default.
• Custom User: No permission is enabled for the user by default.

1. Click the Settings, CDR and Recordings, Monitor, Application, Contacts, and Others tabs, and check or uncheck the relevant options for the user.
2. Click Save and Apply.Results: When the user logs in the PBX web interface by the extension user account, he/she can access the permitted configuration page.

Date and Time

To ensure that the time of logs and CDR is consistent with your local time , you need to adjust the date and time of the PBX.

On the Date & Time configuration page, you can see the current time of the PBX.

You can set the PBX time to be synchronized with a NTP server or set the time manually.

Change the PBX Time

1. Go to Settings > System > Date & Time.
2. Select your current and correct Time Zone.
3. Check the option Daylight Saving Time if you need it in your place.
4. Select Set Up Manually and set the Date and Time according to your local time.
5. Click Save.
6. Reboot the PBX to take effect.

Email

The system email can be used to reset password, send voicemail to email, send alert event emails, and send fax to email. To make these features work, you need to set up the PBX system email.

Set up System Email

1. Go to Settings > System > Email to set up the system email.

• Sender Email Address: Enter an available email address.
• Email Address or Username: If the email server supports for User Name, enter user name. If not,enter the email address.
• Password: Enter the login password of the email address.
• Outgoing Mail Server (SMTP): Enter the outgoing mail server and port according to the email server.
• Incoming Mail Server (POP3): Enter the incoming mail server and port according to the email server.
• Enable TLS: Enable or disable TLS during transferring/submitting your Email to another SMTP server.Note: For Gmail or Exchange server, you need to enable TLS.
• STARTTLS: If you enable TLS, the STARTTLS is enabled by default . If the mail server doesn't support STARTTLS, do not select this option.

1. Click Test to check if the email works.
2. Click Save to save the email settings.

Change Email Notification Language

Yeastar Cloud PBX supports two email notification languages: English and Chinese Simplified. This topic describes how to change email notification language.

Procedure

1. Log in to the PBX web interface, go to Settings > System > Email > Email Templates, click Notification Email Language。
2. In the Language drop-down list, select a desired language.

Result

All email templates will be changed to the specified language.

Auto Cleanup

Auto Cleanup is a feature that can auto clean your CDR, logs, voicemails, one-touch recordings periodically.

Event Center

Yeastar Cloud PBX can monitor system events and logs, then send notifications to the specified notification contacts.

Event types

Yeastar Cloud PBX events are divided into three major categories: operation, telephony, and system.

Event Settings

Go to Settings > Event Center > Event Settings to decide whether to record or monitor the events.

• Record

indicates that Record function is enabled. When the event occurs, the PBX will record the event in Event Log.

indicates that Record function is disabled.

• Notification

indicates that Notification function is enabled. When the event occurs, the PBX will send notification to the Notification Contacts.

indicates that Notification function is disabled.

• Edit NotificationClick

to edit the template of notification email.

Event Log

Event log records of what you select in Event Settings. With the event logs you can check all the event details easily.

You can filter the event logs by selecting an event type, event name, and specifying a certain time period.

Add Notification Contacts

You can set the PBX to send notifications when specific events or errors occur, notifying you via email, extensions, or mobile devices.

1. Go to Settings > Event Center > Notification Contacts, click Add.
2. On the configuration page, choose a contact and set the notification method.

• Choose Contact: Choose an extension user or choose Custom to add an external contact.
• Notification Method: Select how to notify the contact when the event occurs.
• Email: The PBX will send notifications to the email address of the contact.
• Call Extension: The PBX will call the extension number of the contact when the event occurs.
• Call Mobile: The PBX will call the mobile number of the contact when the event occurs.
• Email: If you choose Notification Mode to Email, you need to set the email address of the contact.
• Mobile Number: If you choose Notification Method to Call Mobile, you need to set the mobile number of the contact and set the Prefix according to the outbound route pattern on the PBX.

1. Click Save and Apply.

Remote Management

Yeastar Remote Management provides an affordable, low maintenance solution for easily deploying Yeastar VoIP PBX and VoIP gateways across multiple locations, reducing complexity and providing deep visibility and control.

Compatibility

The following Yeastar products supports Remote Management feature:

• Yeastar Cloud PBX: 81.4.0.X or later
• Yeastar S-Series VoIP PBX: 30.6.0.20 or later
• Yeastar TA1600/TA2400/TA3200 V3

Remote Management Guide

How to manage Yeastar products on the Remote Management platform, refer to the Remote Management Guide.

API

Yeastar Cloud PBX provides API interfaces for you to integrate a third-party software or device.

Compatibility

API feature is supported on Yeastar Cloud PBX v81.4.0.8 or later.

API Guide

For more information of API, refer to Yeastar Cloud PBX- API guide.

In the API guide, we introduces how to enable and configure API on Yeastar Cloud PBX, and provides API references.