Yeastar Technology S-Series, Administrator'S Manual

Page 1: ...l 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 06 27 S Series VoIP PBX Administrator Guide https arttel ru https artt...

Page 2: ...ons 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 regard to this guide including...

Page 3: ...s 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 11 Make Your First Call 11 S...

Page 4: ...l 51 Inbound Routes 51 Outbound Routes 53 Auto CLIP Routes 55 Time Conditions 56 Add Time Condition 56 Add a Holiday 57 Assigning Time Conditions to Inbound Routes 57 Assigning Time Conditions to Outb...

Page 5: ...e Code 79 Voicemail 81 Voicemail to Email Template 83 SIP 83 General 83 NAT 84 Codec 86 TLS 87 Session Timer 87 QOS 88 T 38 88 Advanced 89 IAX 89 Recording 90 Event Center 91 Event Settings 91 Notific...

Page 6: ...Log 106 Operation Log 106 Troubleshooting 107 Ethernet Capture Tool 107 DAHDI Monitor Tool 108 IP Ping 108 Traceroute 109 App Center 110 What App Center Offers 110 PBX Center 110 LDAP Server 110 Auto...

Page 7: ...elated documents are available on Yeastar website http www yeastar com Document Description Yeastar S Series Datasheet Datasheet for the Yeastar S Series Yeastar S20 Installation Guide Yeastar S50 Ins...

Page 8: ...e managed from anywhere with Internet access Your Choice of Technologies and Features Embedded VoIP capability and analog phone connections Rich external lines options include SIP PSTN ISDN BRI E1 T1...

Page 9: ...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 capacity of PBX With p...

Page 10: ...anel 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 Indicator RJ11 Port Reset W...

Page 11: ...nna 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 Power Inlet System WAN Protecti...

Page 12: ...port connection LAN LAN status Blinking Stable LAN port connection Off No LAN port connection RJ11 Port Status FXS Green light Static The port is idle Blinking There is an ongoing call on the port GS...

Page 13: ...ate the connection status of the corresponding ports at the front panel ANT Connect to GSM CDMA 3G Antenna E1 T1 Connect to E1 line or the E1 port of traditional PBX Console Connect to the RS 232 Cabl...

Page 14: ...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 computer is connected to the sam...

Page 15: ...ing items Figure 2 3 Taskbar 1 Main Menu view and open applications installed on your S Series system 2 Open Application Click the icon of an application to show or hide its window on the desktop Righ...

Page 16: ...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 Here you can change the login...

Page 17: ...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 SIP You will need the Registra...

Page 18: ...plink 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 this mode Default Interface In...

Page 19: ...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 the username Password Specif...

Page 20: ...nt 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 in a router or a networked d...

Page 21: ...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 route will be Interface Select...

Page 22: ...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 enable Drop All feature the...

Page 23: ...on 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 The Number of IP Packets The...

Page 24: ...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 This feature is used when you d...

Page 25: ...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 user If you do not set this...

Page 26: ...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 administrator is referred as Supe...

Page 27: ...vilege 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 delete the users by clicking...

Page 28: ...r 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 adjust its internal clock to a c...

Page 29: ...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 Note if you use Gmail or Exch...

Page 30: ...operly 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 instructions to configure network d...

Page 31: ...up 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 the maximum number of CDR tha...

Page 32: ...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 the maximum number of logs t...

Page 33: ...xtensions 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 4 1 Add N...

Page 34: ...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 extension user Th...

Page 35: ...ings the mobile number 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 c...

Page 36: ...n 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 RFC2833 or Info automatically RFC2833 is the default mode IP Restric...

Page 37: ...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 0db Tx Volume The volume of th...

Page 38: ...atch of extensions to be added Create Number The number of extensions to be created Register Password Type Decide which type of registration password will be used There are 3 options Random generate a...

Page 39: ...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 type Edit an E...

Page 40: ...o 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 instead of each extension This fea...

Page 41: ...XO 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 port or choose Custom to define the RX gain...

Page 42: ...y signal frequency or not Busy Frequency If Frequency Detection is enabled you must specify the local frequency The default is 480 620 If you wish to customize enter the value in the text box directly...

Page 43: ...is an Integrated Services Digital Network ISDN configuration intended primarily for use in subscriber lines similar to those that have long been used for plain old telephone service The BRI configura...

Page 44: ...busy and congestion to the switch user The options are Inband PBX plays indication tones without answering not available on all PRI BRI subscription lines Out of Band PBX disconnects with busy congest...

Page 45: ...ber Private Prefix Dialplan Remote Dialplan private Remote Number Type subscriber Unknown Prefix Dialplan Remote Dialplan ISDN Remote Number Type unknown 3 DOD DOD Direct Outward Dialing means the cal...

Page 46: ...l be permanently locked which means you would need a new card Rx Volume Set the receiving volume of GSM port or choose Custom to define the RX gain below RX Gain db The RX Gain for the receiving chann...

Page 47: ...main VoIP provider s server domain name If the provider has no domain name fill in the IP address instead User Name The username used to register to the trunk from the VoIP provider Password The passw...

Page 48: ...sword The password to register to the trunk from the VoIP provider Table 5 11 IAX Peer to peer Trunk Configuration Parameters Basic IAX Peer to peer Trunk Protocol Set the trunk protocol IAX Trunk Typ...

Page 49: ...ation Service is a telephone service that enables a company to identify which telephone number was dialed Users could configure DNIS to allow the IP phones to display which trunk is passing the call D...

Page 50: ...extensions Figure 5 5 Bind Consecutive DOD Numbers to Multiple Extensions E1 T1 J1 Trunk Yeastar S100 supports expanding up to 2 digital trunks S300 supports expanding up to 3 digital trunks Go to Set...

Page 51: ...T1 or J1 the options are B8ZS AMI Codec Choose the codec for this trunk Echo Cancellation This option enables or disables echo cancellation The default is checked D Channel Set the channel used to ca...

Page 52: ...party MAX DNIS Select max amount of DNIS to ask for If you wish to customize enter the value in the text box directly MAX ANI Max amount of ANI to ask for If you wish to customize enter the value in t...

Page 53: ...Code OPC Specify the Originating Point Code This is generally assigned by your carrier DPC Specify the Destination Point Code This is generally assigned by your carrier Table 5 16 E M Trunk Configurat...

Page 54: ...e caller The default is Out of Band Enable DNIS Dialed Number Identification Service is a telephone service that enables a company to identify which telephone number was dialed Users could configure D...

Page 55: ...accept collect calls or not MF Back Timeout MFC R2 value in milliseconds for the MF timeout The default is None Metering Pulse Timeout MFC R2 value in milliseconds for the metering pulse timeout Enter...

Page 56: ...ct 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 Multiple Ex...

Page 57: ...I 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 between 0 and 9 Z Refers to...

Page 58: ...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 Condition and restore to its ori...

Page 59: ...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 outbound route which is in...

Page 60: ...n 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 be used to prepend a 3 digit...

Page 61: ...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 about outgoing calls to the A...

Page 62: ...n 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 time day of the week day of...

Page 63: ...e 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 add a holiday Figure 6 8 Add H...

Page 64: ...ch 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 selected IVR Click to edit one...

Page 65: ...rresponding key the call will be routed to Extension Voicemail Ring Group IVR Conference Room Queues Faxes Dial by Name Hangup Ring Group A ring group helps you to ring a group of extensions in a vari...

Page 66: ...uration options on the queue help you to control how the incoming calls are routed to the agents and what callers hear and do while waiting in the line Go to Settings PBX Call Features Queue to config...

Page 67: ...Music On Hold Select the Music on Hold playlist for this Queue Caller Max Wait Time Select the maximum number of seconds a caller can wait in a queue before being pulled out If you wish to customize e...

Page 68: ...min can kick the users out and lock the conference Also you can set none PIN You can require callers to enter a password before they can enter this conference This setting is optional Join a Conferenc...

Page 69: ...ference volume 6 Increase the conference volume 7 Decrease your volume 8 Exit the IVR menu 9 Increase your volume Pickup Group Call pickup allows one to answer someone else s call You can add pickup g...

Page 70: ...ou can by simply define a shortcut number Speed Dial feature is available on Yeastar S Series that allowing you to place a call by pressing a reduced number of keys 1 Add Speed Dial Click to add a spe...

Page 71: ...file Check the sample file below You can export a speed dial file from S Series and use it as a sample to start with Figure 7 4 Speed Dial File The sample csv file will result in the following speed d...

Page 72: ...Features Callback to configure Callback Click to add a new callback Click to delete the selected callbacks Click to edit one callback Click to delete one callback To use callback feature you need to...

Page 73: ...the callback will direct the caller to DISA DISA Direct Inward System Access allows someone calling in from outside Yeastar S Series to obtain an internal system dial tone and make calls as if they we...

Page 74: ...number blacklist the caller will hear the following prompt The number you have dialed is not in service Please check the number and try again The system will then disconnect the call Whitelist is used...

Page 75: ...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 Figure 7 12 Blacklist Whitelist...

Page 76: ...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 announcement to a specific exte...

Page 77: ...es supports SMS to Email and Email to SMS features To use these two features you must do the following Install GSM CDMA 3G module on the device Insert SIM card on the GSM CDMA 3G module Check the trun...

Page 78: ...o the Yeastar system s email address with the destination mobile phone number as the email subject The system will then receive the email and forward the email to the GSM CDMA 3G port so that the emai...

Page 79: ...S Series IP PBX Administrator Guide 73 Figure 7 17 Enable SMS To Email https arttel ru https arttel ru shop ip ats yeastar s50...

Page 80: ...old 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 Number Prompt The prompt to play...

Page 81: ...r 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 hold Users could configure Mus...

Page 82: ...ngful 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 Settings PBX Voice Prompts Cust...

Page 83: ...eries IP PBX Administrator Guide 77 Figure 8 6 Record New Custom Prompt Click the selected extension will ring pick up the call to start recording https arttel ru https arttel ru shop ip ats yeastar s...

Page 84: ...rtual 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 or IVR the Caller ID would display where it...

Page 85: ...cemail The system will prompt 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...

Page 86: ...ension Call Forwarding Reset to Defaults Dial this feature code to restore call forwarding to the following default settings Always Forward disabled Busy Forward to Voicemail enabled No Answer Forward...

Page 87: ...or this extension 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 wi...

Page 88: ...0 Destination This sets the breakout destination Greeting Options Busy Prompt Greeting played when the extension is busy Unavailable Prompt Greeting played when the extension is unavailable Leave a M...

Page 89: ...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 in seconds of incoming regist...

Page 90: ...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 Refresh Interval If an exte...

Page 91: ...ironment 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 168 0 0 25...

Page 92: ...lows 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 SIP...

Page 93: ...et 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 Ignore Common Name If set to...

Page 94: ...ns 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 i...

Page 95: ...Remote Party ID in SIP header or not The Default is no DNS SRV Look Up Enable DNS SRV lookups on inbound and outbound calls Send P Asserted Identify Whether to send the P Asserted Identify in SIP head...

Page 96: ...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 party that the call will be rec...

Page 97: ...Failed User Locked Telephony Register SIP Trunk Failed Service Provider Unreachable Outgoing Call Failed System CPU Overload Memory Overload Concurrent Calls Overload Disk Failure Storage Space Full...

Page 98: ...hoose 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 contact when the event occurs E...

Page 99: ...t 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 will be displayed Figure 11...

Page 100: ...runk Communication Type Account Code You can perform the following operations on the filtered call report Download Searched Result Click Download the Records to download the searched records Edit List...

Page 101: ...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 extension is ringing The ex...

Page 102: ...scription 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 interface and module Table 13 3 GSM...

Page 103: ...vice 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 examine the relevant interface...

Page 104: ...S Series IP PBX Administrator Guide 98 Concurrent Call Figure 13 3 Concurrent Call https arttel ru https arttel ru shop ip ats yeastar s50...

Page 105: ...tilization 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 Information Network Click on Net...

Page 106: ...ormance 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 4 Memory Status https artte...

Page 107: ...S Series IP PBX Administrator Guide 101 LAN Figure 14 4 LAN Status Storage Usage Figure 14 5 Storage Usage https arttel ru https arttel ru shop ip ats yeastar s50...

Page 108: ...s 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 trying to upgrade through HTTP please...

Page 109: ...mware 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 file from Yeastar HTTP server Figure 15 3...

Page 110: ...re 15 5 Upgrade Manually TFTP 7 Click Download to download the file and start to upgrade Backup and Restore Yeastar S Series provides Backup and Restore feature which allows you to create a complete b...

Page 111: ...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 note the current configura...

Page 112: ...he 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 Click to download the file t...

Page 113: ...bleshooting 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 Start to start capturing logs...

Page 114: ...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 and analysis it The ou...

Page 115: ...ide 109 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 Traceroute https arttel ru https a...

Page 116: ...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 Monitor It delivers a quick update...

Page 117: ...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 Installed Figure 16 2 Insta...

Page 118: ...ninstalled 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 App Click on Settings tab con...

Page 119: ...erver 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 Settings 2 Edit Add Phone Boo...

Page 120: ...e 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 the same way Figure 17 4 Ed...

Page 121: ...le 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 will be exported to your loc...

Page 122: ...dn dn distinguishedName Unique identifier for each entry dc Domain component telephoneNumber Office phone number homePhone Mobile Phone mobile Mobile or cellular phone number mail Email address depart...

Page 123: ...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 cn Protocol Version 3 Search...

Page 124: ...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 set it as a DHCP server 1 T...

Page 125: ...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 To do auto provisioning 1 Che...

Page 126: ...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 system and apply the configu...

Page 127: ...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 phone would be deleted auto...

Page 128: ...e 122 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 process END https arttel ru https...