background image

 

 

 

Sales Tel

: +86-592-5503309 

E-mail

: [email protected]

 

Support Tel

:+86-592-5503301 

E-mail

[email protected]

 

Web

: http://www.yeastar.com

 

 

Version

: 30.0.0.32 

Revised

: 2016.07.19 

 

 

S-Series VoIP PBX 

Administrator Guide 

Summary of Contents for S20

Page 1: ...les Tel 86 592 5503309 E mail sales yeastar com Support Tel 86 592 5503301 E mail support yeastar com Web http www yeastar com Version 30 0 0 32 Revised 2016 07 19 S Series VoIP PBX Administrator Guid...

Page 2: ...s and other relevant provisions of the CE FCC Warranty The information in this document is subject to change without notice Yeastar Information Technology Co Ltd makes no warranty of any kind with reg...

Page 3: ...00 6 LED Indicators and Ports 6 LED Indicators 6 Port Description 7 Getting Started 8 Accessing Web GUI 8 Web Configuration Desktop 9 Desktop 9 Taskbar 9 Main Menu 9 Options 10 Save and Apply Changes...

Page 4: ...1 T1 J1 Trunk 45 Call Control 52 Inbound Routes 52 Outbound Routes 54 Auto CLIP Routes 56 Time Conditions 57 Add Time Condition 57 Add a Holiday 58 Assigning Time Conditions to Inbound Routes 58 Assig...

Page 5: ...ral 79 Preference 79 Feature Code 80 Voicemail 82 Voicemail to Email Template 84 SIP 84 General 84 NAT 85 Codec 87 TLS 88 Session Timer 88 QOS 89 T 38 89 Advanced 90 IAX 90 Recording 91 Event Center 9...

Page 6: ...Reset and Reboot 106 System Log 107 Operation Log 107 Troubleshooting 108 Ethernet Capture Tool 108 DAHDI Monitor Tool 109 IP Ping 109 Traceroute 110 App Center 111 What App Center Offers 111 PBX Cen...

Page 7: ...ed Documents The following related documents are available on Yeastar website http www yeastar com Document Description Yeastar S Series Datasheet Datasheet for the Yeastar S Series Yeastar S20 Instal...

Page 8: ...endous time Everything can be managed from anywhere with Internet access Your Choice of Technologies and Features Embedded VoIP capability and analog phone connections Rich external lines options incl...

Page 9: ...ns supports up to 2 D30 Modules Expansion Board EX08 EX08 board supports up to 4 modules 8 ports Expansion Board EX30 EX30 board supports 1 E1 T1 port D30 Module D30 is a DSP module used to expand the...

Page 10: ...star S20 Yeastar S50 Front Panel Power Indicator System Status RJ11 Port Status WAN Status LAN Status Rear Panel Power RJ11 Port WAN LAN Reset Antenna Socket TF Slot Front Panel System Indicator Power...

Page 11: ...Rear Panel Power Switch Antenna Socket Power Inlet Protective Earth Front Panel 1 EX30 1 EX08 E1 T1 Port RJ11 Port RJ11 Port Status Rear Panel Antenna Socket SD Slot Console Power Switch Power LAN Pow...

Page 12: ...WAN status Static Green light Linked normally 10 100 Mbps Static Orange light Linked normally 1000 Mbps Blinking In communication Off Off line LAN LAN status Static Green light Linked normally 10 100...

Page 13: ...r of the ports corresponds to that of the Indicator lights in the front panel I e the LED lights in the front indicate the connection status of the corresponding ports at the front panel ANT Connect t...

Page 14: ...anage the device by logging in the Web interface Check the factory defaults below IP address https 192 168 5 150 8088 User Name admin Default Password password To log in S Series 1 Make sure your comp...

Page 15: ...ms Figure 2 3 Taskbar 1 Main Menu view and open applications installed on your S Series system Right click an application icon you can add the application to desktop 2 Open Application Click the icon...

Page 16: ...ns icon to logout change Web language or modify your account settings Figure 2 5 Options Language Select Language to change web language My Settings Click My Settings to modify your account settings H...

Page 17: ...ster an extension to the IP phone and make your first call through S Series system 1 Log in your S Series Web GUI go to Settings PBX Extensions 2 Click Add to create a new extension set the type as SI...

Page 18: ...interface will be used for uplink connection WAN port interface will be used as bridge for PC connection Dual the two Ethernet interfaces will use different IP addresses Assign two IP addresses in th...

Page 19: ...l Device Select the network device The client and server must use the same setting TUN a TUN device is a virtual point to point IP link TAP a TAP device is a virtual Ethernet adapter Username Specify...

Page 20: ...e password of you DDNS account Hash Enter your string of Hash as provided by freedns afraid org Domain Enter the domain name Static Route In computer networking a routing table is a data table stored...

Page 21: ...a route is calculated using what are called routing metric Routing metrics are assigned to routes by routing protocols to provide measurable values that can be used to judge how useful how cost a rou...

Page 22: ...ct the system from malicious attack Click Save icon to apply the changes Disable Ping Enable this item net ping from remote hosts will be dropped Click Save icon to apply the changes Drop All When you...

Page 23: ...uto defense rule configuration parameters below Table 3 6 IP Auto Defense Rule Configuration IP Auto Defense Rule Port Auto defense port for example 8022 Protocol Select auto defense protocol UDP TCP...

Page 24: ...he default port is 4569 SIP UDP The default port is 5060 SIP TCP The default port is 5060 SIP TLS The default port is 5061 DHCP Check the box Enable DHCP Server S Series will acts as a DHCP server Thi...

Page 25: ...me for the AMI user Password specify a password for the user to connect to AMI Permitted IP Subnet mask configure permitted IP address and subnet mask that would be allowed to authenticate as the AMI...

Page 26: ...y third party to access the database of PBX Permitted IP enter the permitted IP address User Permission The system has one default administrator account which has the highest privileges Here the admin...

Page 27: ...mpts Choose the user and privilege type then check the options to enable the privileges for the user Figure 3 9 Add New User Permission Once created the Super Admin can edit the users by clicking or d...

Page 28: ...te Time Time Zone select your current time zone Daylight Saving Time the option is disabled by default Enable it when necessary Synchronize With NTP Server if you choose this mode the system will adju...

Page 29: ...ter the POP3 server and port Example pop sina com 110 Enable TLS Use TLS to send secure message to server If the email sending server needs to authenticate the sender you need to select the checkbox N...

Page 30: ...fore network drive can be properly configured an SMB share folder accessible from Yeastar system must be set up on a Windows based machine Once that has been set up please follow the following instruc...

Page 31: ...Storage Locations Auto Cleanup Yeastar S Series supports auto clean for CDR logs voicemails one touch recordings and recordings Table 3 9 Auto Cleanup Settings CDR Auto Cleanup Max Number of CDR Set t...

Page 32: ...ing files should be retained The default is left blank Logs Auto Cleanup Logs Preservation Duration Set the maximum number of days that logs should be retained The default is 7 Max Number of Logs Set...

Page 33: ...ure the extensions Add New Extension Add Bulk Extensions Search and Edit Extension Extension Group Add New Extension Click to add a new extension you will see the pop up window appear as below Figure...

Page 34: ...r Information Name A character based name for this user For example Bob Jones User Password The password for this extension user to log in the system For example 12t3f6 Email Email address of this ext...

Page 35: ...r simultaneously Monitor Settings Allow Being Monitored Check this option to allow this user to be monitored Monitor Mode Decide how you will monitor another extension s current call None you will not...

Page 36: ...in different RTP packets than the audio signal Info DTMF will be carried in the SIP Info messages Inband DTMF will be carried in the audio signal Auto will use RFC4733 or Info automatically RFC4733 is...

Page 37: ...of PBX Set the value from 5 to 100 or choose Custom to define the RX gain below Rx Gain The gain of the voice sent from the analog phone to the FXS port of PBX Unit db The valid range is 30db to 6 0d...

Page 38: ...of extensions to be created Register Password Decide which type of registration password will be used There are 3 options Random generate a random password for each extension Fixed use the text fille...

Page 39: ...you to edit or delete in bulk Also you can edit or delete per extension by clicking or Figure 4 4 Extensions List Search Extension You can search extensions by entering the extension number name or ty...

Page 40: ...ent groups which helps you to better manage the configurations in the system For example you can create Support and Sales groups when configuring Outbound Route you can select a extension group instea...

Page 41: ...ameters below 1 Basic Settings Table 5 1 FXO Trunk Configuration Parameters Basic General Trunk Name Give this trunk a name to help you identify this trunk Rx Volume Set the receiving volume of FXO po...

Page 42: ...rectly Frequency Detection Decide whether to enable detecting the busy signal frequency or not Busy Frequency If Frequency Detection is enabled you must specify the local frequency The default is 480...

Page 43: ...e selected trunk the name will be displayed on the ringing phone BRI Trunk Basic Rate Interface BRI 2B D 2B1D is an Integrated Services Digital Network ISDN configuration intended primarily for use in...

Page 44: ...d B channels Set the internal to Never if you don t like the channel to restarts The default is Never PRI Indication Tells how PBX should indicate busy and congestion to the switch user The options ar...

Page 45: ...nal National Prefix Dialplan Remote Dialplan ISDN Remote Number Type national Local Prefix Dialplan Remote Dialplan ISDN Remote Number Type subscriber Private Prefix Dialplan Remote Dialplan private R...

Page 46: ...ode Enter the SIM card PIN code if the card has one Note if you failed to enter your correct PIN code 3 times in succession the SIM card will be permanently locked which means you would need a new car...

Page 47: ...name to help you identify this trunk Transport Set the transport method used by the trunk If Hostname IP Address is the PBX s Hostname and the port is 0 or blank NAPTR and SRV lookup will be executed...

Page 48: ...has no domain name fill in the IP address instead Table 5 10 IAX Register Trunk Configuration Parameters Basic IAX Register Trunk Protocol Set the trunk protocol IAX Trunk Type Choose the trunk type R...

Page 49: ...SIP Info messages Inband DTMF will be carried in the audio signal Auto will attempt to detect if the device supports RFC4733 DTMF If so it will choose RFC4733 if not it will choose Inband RFC4733 is t...

Page 50: ...al direct outward dialing number DOD Direct Outward Dialing is the caller ID displayed when dialing out Before configuring this please make sure the carrier supports this feature Add One DOD with Mult...

Page 51: ...ice provider Framing Choose the frame format for this trunk When the Interface Type is E1 the options are Enable CRC4 Disable CRC4 CRC4 is a method of checking for errors in data transmitted on E1 tru...

Page 52: ...ines When the Interface Type is T1 or J1 the options are ESF D4 Line Code Choose the line code for this trunk When the interface Type is E1 the options are HDB3 AMI When the Interface Type is T1 or J1...

Page 53: ...or J1 enter a channel number from 1 to 24 Variant Specify the SS7 Singalling variant The options are ITU 14 bits ANSI 24 bits China 24 bits Link set Define SS7 linkset numbers Network Indicator Specif...

Page 54: ...ls Set the interval to Never if you don t like the channel to restarts The default is Never PRI Indication Tells how PBX should indicate busy and congestion to the switch user The options are Inband P...

Page 55: ...unknown Table 5 18 MFC R2 Trunk Configuration Parameters Advanced MFC R2 Signaling Enable DNIS Dialed Number Identification Service is a telephone service that enables a company to identify which tel...

Page 56: ...ich trunk is passing the call DID Number This number is used to identify which line of the trunk is passing the call DNIS Name A name for this DNIS when a call reaches the selected trunk the name will...

Page 57: ...or Guide 51 Figure 5 6 Add One DOD with Multiple Extensions Bind Consecutive DOD Numbers to Multiple Extensions Enter the DOD number range and select the extensions Figure 5 7 Bind Consecutive DOD Num...

Page 58: ...s Only Peer to Peer Trunk BRI Trunk SIP Trunk need to configure this option In patterns the following characters have special meanings Table 6 1 DID Patterns Description Patterns X Refers to any digit...

Page 59: ...match the time periods will be routed to Other Time destination The system will assign each Time Condition with a feature code so you could use this code to force change the destination of a Time Cond...

Page 60: ...hat you have defined in your route 1 If matches it will initiate the call using the selected trunks If it does not it will compare the number with the pattern you have defined in route 2 and so on The...

Page 61: ...ber matches the patterns then this will be prepended before sending to the trunks For example if a trunk requires 10 digit dialing but users are more comfortable with 7 digit dialing this field could...

Page 62: ...last time and then use the next available trunk to call out 7 Time Condition This defines the time conditions to use this outbound route Auto CLIP Routes The system automatically stores information a...

Page 63: ...oCLIP List Time Conditions On Time Condition page you can create time groups A time group is a list of times against which incoming or outgoing calls are checked The rules specify a time range by the...

Page 64: ...you have defined your office time conditions you may need to create a holiday time groups For example you want to create a Holiday for Chinese National Day from October 1st to October 5th Click to ad...

Page 65: ...the callers can enter such as Welcome to XX press 1 for Sales and press 2 for Technical Support Go to Settings PBX Call Features IVR to configure IVR Click to add a new IVR Click to delete the select...

Page 66: ...the destination for each key pressing digits 0 9 Timeout and Invalid When the callers press the corresponding key the call will be routed to Extension Voicemail Ring Group IVR Conference Room Queues F...

Page 67: ...ds out the call to the logged in and available agents A number of configuration options on the queue help you to control how the incoming calls are routed to the agents and what callers hear and do wh...

Page 68: ...ding calls to members whose device are known to be in use Retry The number of seconds to wait before trying all the phones again If you wish to customize enter the value in the text box directly 2 Cal...

Page 69: ...7 5 Conference Configuration Parameters Options Description Number Use this number to dial into the conference room Name Give the conference a brief name to help you identify it Administrator Admin c...

Page 70: ...ence Users IVR Menu 1 Mute un mute yourself 4 Decrease the conference volume 6 Increase the conference volume 7 Decrease your volume 8 Exit the IVR menu 9 Increase your volume Pickup Group Call pickup...

Page 71: ...to call someone quickly without having to look up his her phone number You can by simply define a shortcut number Speed Dial feature is available on Yeastar S Series that allowing you to place a call...

Page 72: ...indow shown as below Figure 7 3 Import Speed Dial Number Click and select the file to start uploading The file must be a csv file Check the sample file below You can export a speed dial file from S Se...

Page 73: ...s who work out of the office using their own mobile phones Go to Settings PBX Call Features Callback to configure Callback Click to add a new callback Click to delete the selected callbacks Click to e...

Page 74: ...ore a callback number before the callback is placed Destination The destination which the callback will direct the caller to DISA DISA Direct Inward System Access allows someone calling in from outsid...

Page 75: ...oming outgoing call If the number of incoming or outgoing call is listed in the number blacklist the caller will hear the following prompt The number you have dialed is not in service Please check the...

Page 76: ...a blacklist whitelist file from S Series and use it as a sample to start with Figure 7 11 Blacklist Whitelist File The sample csv file will result in the following speed dial in Yeastar S Series Figur...

Page 77: ...called party does not need to pick up the handset It is can be achieved by pressing the feature code on your phone and it is a two way audio call The default Intercom feature code is 5 To make an ann...

Page 78: ...the group SMS Yeastar S Series supports SMS to Email and Email to SMS features To use these two features you must do the following 15 Install GSM CDMA 3G module on the device 16 Insert SIM card on the...

Page 79: ...delivered to the email addresses Email to SMS Email to SMS is a feature that allows users to send SMS to mobile phone number via email When users would like to send a SMS they just need to send an em...

Page 80: ...ber If you choose this format you don t need to set access code 2 Email Subject port Port Number Destination Phone Number If you choose this format you don t need to set access code 3 Email Subject 50...

Page 81: ...when the caller is put on hold during call forwarding The options are Music which will be the same with the one selected in Music on Hold Ringing Tone The default is to play Music Invalid Phone Numbe...

Page 82: ...ply in the S Series system or delete it Music on Hold Music on hold MOH is the business practice of playing recorded music to fill the silence that would be heard by callers who have been placed on ho...

Page 83: ...prompt to make it more meaningful and suitable for your case In this case you need to upload a custom prompt to the system or record a new prompt and apply it to the place you want to change Go to Set...

Page 84: ...S Series IP PBX Administrator Guide 78 Figure 8 6 Record New Custom Prompt Click the selected extension will ring pick up the call to start recording...

Page 85: ...ellular trunks the caller will hear the virtual ring back tone generated by the system before the callee answers the call Distinctive Caller ID When the incoming call is routed from Ring Group Queue o...

Page 86: ...t you for password The default feature code is 2 Voicemail for Extension You can leave a voicemail to other extensions by dialing feature code on their phone or forward an incoming call to an extensio...

Page 87: ...re code to restore call forwarding to the following default settings Always Forward disabled Busy Forward to Voicemail enabled No Answer Forward to Voicemail enabled Do Not Disturb disabled The defaul...

Page 88: ...on first Whisper Dial this feature code and the monitored extension number to initiate Whisper monitoring In this mode the monitor can listen to and talk with the monitored extension without being hea...

Page 89: ...gured destination by dialing 0 Destination This sets the breakout destination Greeting Options Busy Prompt Greeting played when the extension is busy Unavailable Prompt Greeting played when the extens...

Page 90: ...port should start from 10000 From port and To port should have a difference value between 100 and 10000 The default is 10000 12000 Register Timers Max Registration Subscription Time Maximum duration i...

Page 91: ...Host 1 STUN Figure 9 2 STUN Table 9 5 STUN Configuration Parameters Option Description STUN Address Choose a STUN address in the drop down list or customize with a STUN address and STUN port External...

Page 92: ...a NAT environment Local Network Identification Used to identify the local network using a network number subnet mask pair when the system is behind a NAT or firewall Some examples are as follows 192 1...

Page 93: ...ollows 192 168 0 0 255 255 0 0 10 0 0 0 255 0 0 0 and 172 16 0 0 12 NAT Mode Global NAT configuration for the system The options are as follows Yes use NAT and ignore the address information in the SI...

Page 94: ...r s CA certificate you can set this and it will connect without requiring TLS CA file The default is no TLS Verify Client If set to yes verify certificate when acting as server The default is no TLS I...

Page 95: ...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...

Page 96: ...ed from Invite header Send Remote Party ID Whether to send the Remote Party ID in SIP header or not The Default is no Send P Asserted Identify Whether to send the P Asserted Identify in SIP header or...

Page 97: ...ings In the storage settings you can configure where to store recording files Internal Call Being Recorded Prompt If the internal call has enabled call recording this prompt will notify the called par...

Page 98: ...ser Login Success User Login Failed User Locked Telephony Register SIP Trunk Failed Service Provider Unreachable Outgoing Call Failed System CPU Overload Memory Overload Concurrent Calls Overload Disk...

Page 99: ...ameters Option Description Choose Contact Choose a contact from the drop down menu The selected contact will receive alert emails SMS messages or calls Notification Method Select how to notify the con...

Page 100: ...vent Log Go to Settings Event Center Event Log to check the event log You can filter the event logs by selecting a event type event name and specifying a certain time period Click the matching results...

Page 101: ...ation Talk Duration Status Trunk Communication Type Account Code You can perform the following operations on the filtered call report Download Searched Result Click Download the Records to download th...

Page 102: ...s and Concurrent Call Go to PBX Monitor to check the real time status Extension Status Figure 13 1 Extension Status Table 13 1 Extension Status Description Status Description The extension is idle The...

Page 103: ...ble 13 2 FXO Trunk Status Description FXO Trunk Status The trunk is idle The trunk is busy in use No PSTN line plugged in FXO interface Malfunction in FXO interface please examine the relevant interfa...

Page 104: ...al layer configuration 3 Service provider did not activate the trunk 1 Incorrect protocol layer configuration 2 Service provider did not activate the trunk 1 Malfunction in interface module please exa...

Page 105: ...S Series IP PBX Administrator Guide 99 Concurrent Call Figure 13 3 Concurrent Call...

Page 106: ...CPU usage memory usage disk utilization and network flow Information On this page you can check the system information including Product SN Hardware version Software version etc Figure 14 1 System Inf...

Page 107: ...Administrator Guide 101 Performance Click on Performance tab to view the resource utilization data The information of the chart will be shown upon mouseover CPU Figure 14 3 CPU Status Memory Figure 14...

Page 108: ...S Series IP PBX Administrator Guide 102 LAN Figure 14 4 LAN Status Storage Usage Figure 14 5 Storage Usage...

Page 109: ...nfiguration to Factory Defaults is enabled the system will reset to factory default settings 2 When update the firmware please don t turn off the power Or the system will get damaged 3 If you are tryi...

Page 110: ...ing File Upgrade through HTTP 1 On the Firmware Upgrade page choose Download From HTTP Server 2 Enter the HTTP URL Note the HTTP URL should be a BIN file download link 3 Click to start downloading the...

Page 111: ...6 Fill in the name of firmware update It should be a BIN file name Figure 15 5 Upgrade Manually TFTP 7 Click Download to download the file and start to upgrade Backup and Restore Yeastar S Series prov...

Page 112: ...New Backup File Upload a Backup Click to upload a backup Figure 15 7 Upload a Backup File Restore To restore the configuration data select a backup and click Reboot the system to take effect Please no...

Page 113: ...m Log Settings You can set the debug level by checking unchecking the options Info Notice Warning Error and Debug click Save and Apply to save the changes Figure 15 9 System Log Settings 2 System Log...

Page 114: ...e Web GUI for you to do troubleshooting Go to Maintenance Troubleshooting to check the tools Ethernet Capture Tool Figure 15 12 Ethernet Capture Tool 1 Fill in the target IP address and port 2 Click S...

Page 115: ...nk Figure 15 13 DAHDI Monitor Tool 1 Choose a trunk from the drop down menu 2 Click Start to start capturing logs 3 Click Stop to stop capturing 4 Click Download to download the file to your local PC...

Page 116: ...ries IP PBX Administrator Guide 110 Traceroute 1 Enter the target IP address or hostname 2 Click Start to start capturing logs The output result will display in the window as below Figure 15 15 Tracer...

Page 117: ...nter Offers Go to App Center to find out what App Center has to offer Figure 16 1 App Center PBX Center The PBX Center separately manages all the functionalities under PBX CDR Recording and PBX Monito...

Page 118: ...n Install Apps Click All tab find the application you d like to install and click Install Once the App is installed it should appear in the Main Menu You can also check the installed App in App Center...

Page 119: ...of the system it cannot be uninstalled You can only upgrade the App To update App do any of the following Click on Installed tab choose one App and click Upgrade to update the App Figure 16 4 Update A...

Page 120: ...tion Enable to enable LDAP server 2 Default LDAP server settings as below Base DN dc pbx dc com PBX DN ou pbx dc pbx dc com User Name cn admin dc pbx dc com Password password Figure 17 1 LDAP Server S...

Page 121: ...e 17 2 Add Phonebook 2 Choose the phone book click to edit it Figure 17 3 LDAP Phone Book 3 Fill in the contact information on the page click to add the contact in the phone book Add other contacts in...

Page 122: ...u can export a phone book file from S Series and use it as a sample to start with Figure 17 6 Phonebook File To export a phone book Select the checkbox of the phone book click the selected phone book...

Page 123: ...me Last name or family name dn dn distinguishedName Unique identifier for each entry dc Domain component telephoneNumber Office phone number homePhone Mobile Phone mobile Mobile or cellular phone numb...

Page 124: ...ssword the password you have set on Yeastar S Series Max Hits 50 LDAP Name Attributes cn sn displayName LDAP Number Attributes telephoneNumber homePhone mobile mail departmentNumber LDAP Display Name...

Page 125: ...e NOTE To use PnP method you need to enable PnP feature on your IP Phones DHCP Use DHCP method you should set your SIP phone or VoIP gateway as a DHCP client and enable Yeastar S Series DHCP server to...

Page 126: ...cal network Click to add one device choose the device model and fill in the device MAC address on the pop up window Click to add bulk devices choose the devices model and fill in their MAC addresses T...

Page 127: ...4 Click to save the changes a pop up window appears as below Click and the configured phones will start to reboot to apply changes Upload Files Users could upload phone configuration file to S Series...

Page 128: ...uld not call in the IP phone Figure 18 5 Auto Provisioning Add Contact Upload Phonebook Click to upload a phonebook to S Series The file format should be xml NOTE All the existing phonebooks of the IP...

Page 129: ...es IP PBX Administrator Guide 123 Click to upload the phone firmware file to S Series Check the box Enable Download Firmware then the phone firmware will be updated during the phone provisioning proce...

Reviews: