Extension Overview
An extension is a short internal number. Extensions allow users to make and receive calls. You can assign extensions to every employee in your organization.
Extension types
SIP Extension
A SIP extension is based on SIP protocol.
To use a SIP extension, you need to enter the extension credentials on an IP phone or a softphone. After the extension is registered on a phone, you can make and receive calls.
Extension format
Yeastar Cloud PBX supports 1-digit to 7-digit extension format. The default extension format is 4-digit number.
Before you create extensions, you can go to
to change the extension format and range.
Extension Creation Overview
Yeastar Cloud PBX supports SIP forking, which enables an extension number to register on multiple SIP phones simultaneously.
SIP Forking
Yeastar Cloud PBX supports SIP forking, which enables an extension number to be registered by multiple SIP phones. When a call reaches the extension, all registered phones will ring simultaneously, and you can take the call from any device easily.
You can configure SIP Forking on the extension configuration page. The value of Concurrent Registrations limits how many SIP phones the extension can be registered on.
Note:
- The limit of concurrent registrations is 4.
- By default, if one SIP phone is busy, other SIP phones still can receive calls when calls reach the extension. To restrict other phones from receiving calls when the extension is busy, you can enable All Busy Mode for SIP Forking ( ).
Create an Extension
Before registering a SIP account on phones, you need to create a SIP account.
Bulk Create Extensions
Yeastar Cloud PBX supports to add SIP extensions in bulk.
Register a SIP Extension
To make calls and receive calls from a SIP extension, you need to register the SIP extension on an IP phone or soft phone.
1.Gather information of extension registration
For most SIP phones, the following items are needed for the SIP phone to register with Yeastar Cloud PBX.
- Domain name of PBX
- SIP registration port: The default port is 5060 on Yeastar Cloud PBX.
- Extension information
- Extension Number
- Registration Name
- Registration Password
- Caller ID Name
- Transport
2.Register the extension on a phone
Log in the phone web interface, fill in and save the required items to register the SIP extension.
3.Confirm registration status
You can do one of the followings to check if the extension is registered.
-
On the phone web interface, check if the status indicates that the extension is registered.
- Log in PBX web interface, go to
.
to check if the status shows
Manage Extensions
Change Extension Range
The default extension range is from 1000 to 5999. Before you create extensions, you can change the extension range according to your needs.
- Log in PBX web interface, go to .
- Change the range of User Extensions.
- Click Save and Apply.
Edit Extensions
After creating extensions, you may need to change extension settings. You can edit an extension, or edit extensions in bulk.
Edit an Extension
- Log in PBX web interface, go to .
- On Extensions page, click
beside the extension that you want to edit.
- Change extension settings according to your needs.
- Click Save and Apply.
Bulk Edit Extensions
- Log in PBX web interface, go to .
- On Extensions tab, select the checkbox of desired extensions, and click Edit.
- Change extension settings according to your needs.
- Click Save and Apply.
Bulk Edit Extension Names and Emails
To bulk edit the extension names and emails, you need to export the extensions from Yeastar Cloud PBX first, edit the extension names and email addresses in the CSV file, then import the file to the PBX.
Delete Extensions
When an employee leaves or an extension is no longer needed, you can delete the extension from the Yeastar Cloud PBX.
Delete an Extension
- Log in PBX web interface, go to .
- On Extensions page, click
beside the extension that you want to delete.
- Click Save and Apply.
Bulk Delete Extensions
- Log in PBX web interface, go to .
- On Extensions page, select the checkbox of desired extensions, and click Delete.
- Click Save and Apply.
Import/Export Extensions
The extensions configured on Yeastar Cloud PBX can be exported and saved as a template. You can fill in desired extension information and import the CSV file to PBX again.
Export Extensions
- Log in PBX web interface, go to .
- Click Export to export the extensions to a CSV file.
Import Extensions
- Log in PBX web interface, go to .
- Click Import.
- On the Import Extension page, click Browse to select your CSV file.
- Click Import.
Send Extension Information
After finishing the extension configurations, you can send the extension information to the extension users’ emails. The extension users can get their extension registration information, Linkus login information, PBX login information in the email.
Edit ‘Welcome Email’ Template
Yeastar Cloud PBX has a default template of the welcome email. You can change the email subject and email contents according to your needs.
Manage Extension Group
Create an Extension Group
You can assign and categorize extensions in different groups. Extension groups simplify the configuration process.
Manage Extension Groups
Edit extension groups
You can edit the group name, add more extensions to the group or remove extensions from the group.
- Go to
.
, search and find the desired extension group, click - Edit the group as you need.
- Click Save and Apply.
Delete extension group
- Go to
.
, search and find the desired extension group, click - Click Yes to confirm the deletion.
Extension Groups Application
You can use the extension groups when you need to assign extensions for outbound routes, ring groups, queues, etc.
For example, you need to set an outbound route and only allow the Support group members to make outbound calls through this route. You can simply assign the Support extension group instead of assigning an extension member one by one. It simplifies the configuration process.
Extension Presence Overview
This topic introduces what is presence and how the presence status can benefit the user’s work.
What is Presence
Extension Presence indicates the availability status of an extension. Presence settings are linked to the Call Forwarding rules and Linkus ring strategy. Different call forwarding rules and ring strategy can be set for each presence status.
Yeastar Cloud PBX provides five presence statuses:
- Available: The user is online and ready for communication.
- Away: The user is currently away from your office.
- DND: The user doesn’t want to be disturb, and you won’t receive any calls.
- Lunch Break: The user is currently on lunch break.
- On a Business Trip: The user is currently on a business trip.
How does Presence benefit the user’s work?
Presence status and information that are displayed on Linkus clients allows the user to see the presence of your colleague and instantly know whether the colleague is available, busy, or away.
Change Presence status to quickly route incoming calls. For example, if the user is at a meeting and do not want to miss calls, set the status to Away and forward the call to voicemail. Once the user is ready to receive calls again, switch back to Available.
How to change Presence status?
3 ways to change an extension presence.
- On the Linkus client, extension users can change their own presence status.
- On the Extension Web Portal, Linkus users can change their own presence status.
- On the PBX Web Portal, you can change all extensions presence.
Set Call Forwarding Rules & Presence Status
Set call forwarding rules for each presence status. The call forwarding rules allows the user to automatically forward an incoming call to voicemail, another extension, or mobile depending on the extension status.
- Go to
.
, search and find the desired extension, click - Click the Presence tab.
- In the Presence drop-down list, select a status to configure.
- In the Presence Information field, enter the a custom status message to display on Linkus.
The Linkus users can see whether you are available to communicate.
- Set call forwarding rules for the Presence status.
- Select the Call Forwarding conditions:
- Always: All the incoming calls will be forward to the destination.
- No Answer: Only the unanswered calls will be forwarded to the destination.
- When Busy: Only the calls that come in while you are talking on the phone will be forwarded.
- Beside the selected forwarding condition, select the forwarding destination.
- Select the Call Forwarding conditions:
- Set the ring strategy for the Presence status.
- Ring First: When a call reaches the extension, which terminal will ring first.
- Ring Secondly: If the incoming call is not answered on the terminals that are selected as Ring First, the terminals that are selected as Ring Secondly will ring.
- Click Save and Apply.
Set Call Forwarding Prompt
By default, when the PBX is forwarding an incoming call to another number, the PBX will play the call forwarding prompt “please hold when I try to locate the person you are calling”, and then play the MoH music when the caller is waiting. You can disable the call forwarding prompt and change the MoH music to a normal ring tone. In this way, the caller will not realize that the call is forwarded.
Activate/Deactivate Call Forwarding
Extension users can dial the Call Forwarding feature codes on their phones to activate or deactivate Call Forwarding function.
Below are the default call forwarding feature codes and the description of how to use the feature codes.
Code | Action | Example |
---|---|---|
*71 | Activate call forwarding ALWAYS |
|
*071 | Deactivate call forwarding ALWAYS |
|
*72 | Activate call forwarding WHEN BUSY |
|
*072 | Deactivate call forwarding WHEN BUSY |
|
*73 | Activate call forwarding NO ANSWER |
|
*073 | Deactivate call forwarding NO ANSWER |
|
Voicemail Overview
Yeastar Cloud PBX integrates a free voicemail system. Voicemail is a modern kind of answering machine that allows the callers to leave audio messages in case of unavailability.
Enable/Disable Voicemail Function
By default, the voicemail is enabled for all extension users. You can disable the Voicemail function if the user doesn’t need it.
Change Voicemail PIN/Password
Extension users can dial voicemail feature code (default *2) on their phones to access their voicemails. To enhance the extension security, you can change the voicemail PIN on PBX web interface.
- Go to .
- Search and find the desired extension, click
.
- Click the Presence tab.
- In the Voicemial Access PIN field, enter a numeric PIN/password.
- Click Save and Apply.
Configure Voicemail to Email
The Voicemail to Email feature of Yeastar Cloud PBX allows extension users to receive voicemail audio files as email attachments and quicken response time when they are out of office.
Enable Voicemail to Email
Voicemail to Email function is disabled by default. If an extension user would like to check voicemail messages via email, you need to enable Voicemail to Email for his/her extension.
- Go to
.
, select the desired extension, click - Click the Features tab.
- In the Send Voicemail to Email drop-down list, select an email type.
- Send to user’s email: Send voicemail to the extension user’s email address.
- Send to custom email: Send voicemail to a custom email address.
- Click Save and Apply.
Email template of ‘Voicemail to Email’
The PBX has a default email template for Voicemail to Email. You can edit the template according to your needs.
- Go to
beside Voicemail to Email.
, click - Edit the email subject and email contents.
- Click Save and Apply.
Check Voicemail Messages
Extension users have multiple ways to check their voicemail messages.
Check Voicemail on Linkus
Log in Linkus, go to
to check your voicemail.Check Voicemail on a Phone
- Dial feature code *2 on a phone
A user can dial *2 on his own phone to check voicemail.
- Dial feature code *02 on a phone
A user can dial *02 on other user’s phone to enter the voicemail main menu, then enter his/her extension number and voicemail PIN to check voicemail.
Check Voicemail on Web Page
Extension users can log in the PBX web page to check their own voicemails.
- User name: The extension user’s email address.
- Password: The extension’s User Password.
Check Voicemail via Email
If voicemail to email is enabled for an extension user, the user can check voicemails in his/her email box.
Check Voicemail via IVR
If you check the option Dial to Check Voicemail for an IVR; users can access the IVR to check their voicemails. This solution is for the users who are outside the office to check their voicemails.
Change Voicemail Greetings
You can change the global voicemail greetings for all the extension users or change voicemail greeting for a specific extension.
Components of a Voicemail Greeting
When an extension user is unavailable, the voicemail greeting consists of 3 audio clips: Unavailable Prompt + Voicemail Prompt + “Di”.
When an extension is busy on a phone, the voicemail greeting consists of 3 audio clips: Busy Prompt + Voicemail Prompt + “Di”
- Default Unavailable Prompt: The person at the extension XXXX is unavailable.
- Default Busy Prompt: The person at the extension XXXX is busy.
- Default Voicemail Prompt: Please leave your message after the tone, when done hang up or press the pound key (#).”
Change global voicemail greetings
- Prepare your custom prompt files, and upload to the PBX.
- Go to .
- Change the global voicemail greetings.
- Busy Prompt: Select the prompt that will be played when the extension is busy.
- Unavailable Prompt: Select the prompt that will be played when the extension is unavailable.
- Voicemail Prompt: Select the prompt that will be played after Busy or Unavailable prompt.
- Click Save and Apply.
Change voicemail greetings for a specific extension
By default, the global busy prompt and global unavailable prompt are applied to all extensions. If an extension user wants to use her/his personal greetings, you can change the prompts for the extension.
Note: The greeting prompt file format should be “.wav”, “.WAV” or “.gsm” file.
The file size must not be larger than 8MB.
Supported Format: PCM: 8K, 16bit, 128kbps; A-law(g.711): 8k, 8bit, 64kbps; u-law (g.711): 8k, 8bit, 64kbps; gsm: 6.10, 8k, 13kbps.
- Go to
.
, search and find the desired extension, click - Click the Features tab.
- Click Browse to upload a prompt file.
- Click Save and Apply.
Manage Voicemail Messages Centrally
In Yeastar Cloud PBX, you have two options to manage voicemail messages centrally and efficiently: subscribe BLF keys on a phone to monitor multiple extensions’ voicemail status and receive multiple extensions’ voicemail messages from one mailbox.
Monitor voicemail status by BLF keys
By default, an extension’s voicemail status cannot be monitored by other users. To monitor an extension’s voicemail status, you need to enable Share Voicemail Status on the extension.
We take Yealink T27G v69.82.0.20 as an example below to introduce how to monitor voicemail status of extension 4000 by extension 1000.
- Enable voicemail status sharing feature of extension 4000.
- Log in the PBX web interface, go to , edit the extension 4000.
- On the extension Features page, enable Share Voicemail Status.
- Click Save and Apply.
- Set BLF key to monitor the voicemail status.
- Log in the IP phone where extension 1000 is registered, go to Dsskey.
- Set a BLF key to monitor voicemail status of extension 4000.
- Type: Select BLF.
- Value: Enter *2{ext_num}. In this example, enter *24000.
- Line: Select the line where extension 1000 is registered on.
- Click Confirm.
Result:
- Green BLF LED: The extension 4000 has NO unread voicemail messages.
- Red BLF LED: The extension 4000 has unread voicemail messages.
Receive voicemail from a mailbox
To receive multiple extensions’ voicemail messages from one mailbox, you can configure sending voicemail to a same custom email address for these extensions.
For example, to receive multiple extensions’ voicemail messages from the mailbox voicemial@yeastar.com. Set Send Voicemail to Email to the same custom email address voicemial@yeastar.com for these extensions.
Global Voicemail Settings
You can change the global voicemail message settings, voicemail playback settings according to your needs.
The global voicemail settings will be applied to all the extensions.
Navigation path:
.Setting | Description |
---|---|
Message Options | |
Max Messages per Folder | Each extension user has a Read voicemail folder and an Unread folder. You can set the maximum number of messages per folder. |
Max Message Time | Set the maximum time of one message. |
Min Message Time | Set the minimum time of one message. |
Delete Voicemail | This function will work if you enable Send Voicemail to Email. If the voicemail is forwarded to the user’s email, PBX will delete voicemails from the user’s voicemail folder. |
Ask Caller to Dial 5 | By default, when the caller accesses a user’s voicemail, PBX starts to record message automatically. If you want to prompt the caller first, you can enable this option. The caller needs to dial 5 first, then starts to record message. |
Operator Breakout from Voicemail | If enabled, the users can dial 0 to exit the voicemail destination of an IVR. |
Greeting Options | |
Busy Prompt | Select the greeting that will be played when the extension is busy.
Note: To use a custom prompt, you need to upload your audio file to the Custom Prompt page first.
|
Unavailable Prompt | Select the greeting that will be played when the extension is unavailable.
Note: To use a custom prompt, you need to upload your audio file to the Custom Prompt page first.
|
Voicemail Prompt | Select the greeting that will be played before the caller leave a message.
Note: To use a custom prompt, you need to upload your audio file to the Custom Prompt page first.
|
Playback Options | |
Announce Message Caller ID | If enabled, the PBX will announce who left the message. |
Announce Message Duration | If enabled, the PBX will announce the message duration. |
Announce Message Arrival Time | If enabled, the PBX will announce when the message was received. |
Allow Users to Review Messages | If enabled, the users can review their recorded message, and then send the messages. |
Voicemail Menu
You can dial *2 on your phone to access the voicemail menu. Below is the detailed voicemail menu.
Call Monitoring Overview
Call Monitoring allows authorized users to monitor another extension user’s call in real time. The supervisor can dial “feature code” + “extension number” to monitor the extension user’s call.
Go to Feature Code tab.
, clickIn the Call Monitor section, you can enable or disable monitor modes, and modify corresponding feature codes.
Yeastar Cloud PBX supports the following monitor modes:
- Listen (Default code: *90)
Listen mode allows supervisor to listen to a call in real time.
The supervisor can not talk with the monitored extension users.
- Whisper (Default code: *91)
Whisper mode allows supervisor to listen to a call in real time, and talk with the monitored extension user privately.
The other party can not hear the supervisor’s voice.
- Barge-in (Default code: *92)
Barge-in mode allows the supervisor to listen to a call in real time and talk with both parties.
Configure Call Monitoring
To monitor an extension, you need to set monitor settings for both the supervisors and the monitored extension users.
- Enable and select a monitor mode for the supervisor.
- Set the extension which will be monitored.
Call Permission
Set Call Permission of an Extension
On the Extension configuration page, you can set the outbound call permissions for the extension user.
- Go to
beside the desired extension.
, click - On the Extension configuration page, click Call Permission tab.
- Select outbound routes for the extension from Available box to Selected box.
Outbound Routes Permission
Select outbound routes to the Selected box, the extension user will have the permission to make outbound calls through the selected outbound routes.
Outbound Restriction
- Prohibit Outbound Calls
Select the Outbound Restriction option to prohibit this extension from making outbound calls.
On the Extensions page, the extension will be locked and the extension status will show
.
Note: If the extension user makes outbound calls over the limit of Outbound Restriction rule, the extension will also be locked. -
Cancel Restriction for Outbound Calls
Double click the icon
or unselect the checkbox of Outbound Restriction to allow this extension to make outbound calls.
SIP Extension Settings
This reference describes all settings on a SIP extension.
Basic Settings
Navigation path: Basic tab.
, edit a SIP extension on theGeneral Settings
Settings | Descriptions |
---|---|
Extension | Enter the extension number. |
Caller ID | If you set the caller ID number, the called party will see this caller ID number when the extension user makes an outgoing call. |
Registration Name | The name used to register a SIP extension. |
Caller ID name | If you set the caller ID name, the called party will see this caller ID name when the extension user makes an outgoing call. |
Concurrent Registrations | Yeastar Cloud PBX supports to register one extension number on multiple phones. When a call reaches the extension number, all phones will ring. |
Registration Password | The password is used to register a SIP extension. The password is generated randomly by default. |
User Information Settings
Settings | Descriptions |
---|---|
Enter the email address. Extension user can reset his/her login password, receive voice mails, faxes, or PBX notifications via this email address. | |
User Password | The password is used to log in the PBX or log in Linkus mobile client. The password is generated randomly by default. |
Prompt Language | The language of voice prompts. The default prompt language is the same as the system language. If the extension user speaks foreign language, you can set a specific system prompt. |
Mobile Number | Enter the mobile number. Extension user can receive the PBX notifications or forwarded calls on this mobile number. |
Presence Settings
Extension Presence indicates the availability status of a SIP extension. Presence settings are linked to the Call Forwarding rules and Linkus ring strategy. You can set different call forwarding rules and ring strategy for each presence status.
Navigation path: Presence tab.
, edit a SIP extension under thePresence Settings
Settings | Description |
---|---|
Presence | Set presence status.
Yeastar Cloud PBX provides five presence statuses.
|
Presence Information | Add details about your current status. |
Call Forwarding Settings
You can forward calls to a specific destination or a specific extension user to avoid missing calls. Depending on the presence status and your preferences, you can set the PBX to forward calls to voicemail, extension, mobile number, queue, etc.
Settings | Description |
---|---|
Always | Forward all calls to the designated destination. |
No Answer | Only forward the unanswered calls to the designated destination. |
When Busy | Only forward the calls that come in while you are talking on the phone. |
Ring Strategy Settings
You can set ring strategy for the following terminals that the SIP extension registered to.
- Extension
- Linkus Mobile Client
- Linkus Desktop Client
Settings | Description |
---|---|
Ring First | Set which terminal will ring first. |
Ring Secondly | Set which terminal will ring secondly. |
Features Settings
You can configure voicemail, mobility extension, call monitoring, and other settings under the Features tab.
Navigation path: Features tab.
, edit a SIP extension under theVoicemail Settings
Settings | Description |
---|---|
Enable Voicemail | Enable voicemail feature. |
Voicemail Access PIN | Password used to access voicemail. |
Share Voicemail Status | Enable this option to share voicemail status of this extension with other extensions. |
Send Voicemail to Email | Whether to send voicemail to the designated Email address or not.
|
Busy Prompt | Set the prompt that will be played when the extension user is busy in a call. |
Unavailable Prompt | Set the prompt that will be played when the extension user is unavailable. |
Mobility Extension
Yeastar Mobility Extension allows you to stay in contact with colleagues and clients using either office phone or mobile phone with the same extension number.
Settings | Description |
---|---|
Ring Simultaneously | Enable this option to allow both extension and associated mobile number ring simultaneously when anyone calls in the extension number. |
Enable Mobility Extension | Enable this option to allow your mobile number have the same permission as the office phone when you use associated mobile number to call in the PBX. |
Mobility Extension |
|
Monitor Settings
Call Monitoring allows authorized users to monitor another extension user’s call in real time.
Settings | Description |
---|---|
Allow Being Monitored | Enable this option to allow anyone to monitor the extension user’s ongoing call. |
Monitor Mode | Decide how you monitor other extension users’ ongoing call.
|
Other Settings
Settings | Description |
---|---|
Ring Timeout (s) | Set the timeout in seconds. Phone will stop ringing after timeout. |
Max Call Duration (s) | Set the maximum call duration in seconds for every call of this extension.
Note: The precedence of Max Call Duration(s) (Global v.s. Extension):
|
Send email notification when extension user password is changed | Enable this option to send email notification when extension user password is changed. |
Advanced Settings
The advanced settings of SIP extension require professional knowledge of SIP protocol. Incorrect configurations may cause calling issues. It is wise to retain the default settings provided on the SIP extension page. However, for a few fields, you need to change them to suit your situation.
Navigation path: Advanced tab.
, edit an extension under theVoIP Settings
Settings | Description |
---|---|
Qualify | Enable this option to send SIP OPTION packet to SIP device to check if the device is up. |
Enable SRTP | Enable SRTP for voice encryption. |
T.38 Support | Enable or disable T.38 fax for the extension. |
DTMF Mode | Set the default mode for sending DTMF tones.
|
Transport | Set the transport protocol.
|
Enable User Agent Registration Authorization
Settings | Description |
---|---|
Enable User Agent Registration Authorization | Whether to restrict user agents from registering to the extension. |
User Agent | Enter the name of user agent. If the prefix of the user agent does not match the value, the registration will fail. |
IP Restriction
Settings | Description |
---|---|
Enable IP Restriction | This option is used for IP access control. Only the IP address or IP section that matches the settings can register the extension number. |
Permitted IP/Subnet mask | Enter the IP address and subnet mask.
|
Call Permission Settings
You can set the outbound call permissions for the SIP extension.
Navigation path: Call Permission tab.
, edit a SIP extension under theSettings | Description |
---|---|
Outbound Routes | Set outbound routes for the extension. |
Outbound Restriction | Enable this option to prohibit this extension from making outbound calls. |