Yeastar P-Series
From VoIP.ms Wiki
Designed for SMBs, Yeastar P-Series VoIP PBX and Yeastar Cloud PBX deliver enterprise-grade communications features along with advanced UC capabilities, bringing a solid, reliable and affordable on-premises and hosted business voice solution.
Contents |
Configuring your PBX
Assuming that your VoIP.ms account is active and your DID has been chosen, you may follow the steps below:
- 1) Go to Settings > PBX > Trunks, click Add.
- 2) In the new window, select Canada/United States from the Select Country drop-down list, select VoIP.ms from the ITSP menu and follow the information below:
- Name: Give this SIP trunk a name to help you identify it.
- Protocol: SIP
- Trunk Type: Register Trunk.
- Transport: UDP
- Username: Your VoIP.ms account username.
- Authentication Name: Same as the username.
- From User: Same as the username.
- Password: Your VoIP.ms Account password.
- Caller ID Number: Your VoIP.ms Account DID number.
- 3) Click Save and Apply. Go to PBX Monitor to check if the SIP trunk is connected successfully as the screenshot below shows.
- 4) Set the registration time to 300 by going into Settings > PBX > General > SIP > General and adjust the Default Registration Time to 300.
Set up Outgoing Calls
- 1) To make outbound calls via the newly created SIP trunk, you need to configure an outbound route for the trunk. Go to Settings > PBX > Call Control > Outbound Routes, click Add.
- 2) The system compares the number with the pattern that you have defined in your route 1. If it 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 a higher position will be matched firstly.
- Route Name: Give this outbound route a name to help you identify it.
- Dial Patterns: Set the dial patterns. As the settings below, to make calls via the SIP trunk, you need to precede the number to be dialed with the prefix 8.
- Dial Pattern: 8
- Strip: 1
- Member Extensions: Select the extensions that are allowed to make calls through the outbound route.
- Member Trunks: Select the VoIP.ms trunk.
- 3) Now you can make outbound calls through the VoIP.ms trunk. As the dial patterns configured above, you need to dial “8” before the destination number. For example, to call the number “101234567”, you need to dial “8101234567” on your phone.
Set up Incoming Calls
- 1) To specify how calls from the VoIP.ms trunk should be routed, you need to configure an inbound route for the SIP trunk. Go to Settings > PBX > Call Control > Inbound Routes, click Add.
- 2) Configure the Inbound Route.
- Name: Give this inbound route a name to help you identify it.
- Member Trunks: Choose the VoIP.ms trunk.
- Destination: Select the destination where the incoming calls will be routed.
- 3) Click Save and Apply. When you call in the SIP trunk, the call will be routed to the destination configured on the inbound route.
Whitelisting VoIP.ms IPs in Yeastar
With Yeastar, it is quite easy. Simply proceed into PBX, head into Settings, Security, Access Control, IP Allowlist and then click add. From there, you can whitelist VoIP.ms points of presence IPs.
For more information on the IPs related to our servers, click here
For more information on the Yeastar setting, click here
SMS Configuration
You can also make use of VoIP.ms's SMS with your Yeastar P-Series. The process is very simple, all you have to do is add a Message Channel to allow Yeastar to send and receive SMS messages, activate your VoIP.ms API and finally, configure the DID number(s) that you'd like to use with this feature.
Next, we explain this process step by step.
We also recommend you check our SMS-MMS Wiki Article for more details about VoIP.ms's SMS.
Enabling the VoIP.ms API and generating a Bearer Token
- 1) In your VoIP.ms customer portal head into Main Menu' >> SOAP and REST/JSON API.
- 2) On the field API Password, set the password you will define for the API and confirm it.
- 3) On Enable API click on Enable/Disable API and make sure this says Enabled afterwards.
- 4) On Enable IP address make sure to add the IP address of your Yeastar P-Series or, you can use 0.0.0.0 to allow any IP (Not recommended).
- 5) On Bearer Token click on Generate New Token and save this somewhere safely because you will need it on the next section.
Adding the Message Channel
- 6) In the Access Management Portal of your Yeastar P-Series, on the left click on the Messaging option of the left navigation menu and then on Message Channel.
- 7) Click on the button + Add and then on SMS.
- 8) A form will open. Fill in the following fields:
- Name: Any name for the channel
- ITSP: Select General
- API Key: Enter the Bearer token generated in the Step #5.
- API Address for Sending Messages: Enter the following URL. This value is fixed and must not be changed: https://voip.ms/yeastar/sendmessage.php
Adding a DID number
A DID (Direct Inward Dialing number) is the phone number used to send and receive SMS messages. To add one of the DIDs on your VoIP.ms account, follow these steps.
🚨 Important
- * The DID must exist and be active in your VoIP.ms account.
- * SMS must be available for the DID.
- 9) Still in the Messaging Channel config, click on the Messaging Settings tab.
- 10) Click on the button + Add.
- 11) A form will open. Fill in the following fields:
- Number: Enter the phone number in E.164 format. Example: +12052550000
- Destination for Inbound Messaging: Select Extension, since inbound messages will be sent to a user.
- Extension: Select the extension to which this number will be assigned.
- Extensions Allowed to Create Messaging Sessions: Select the users allowed to create messaging sessions. By default, choose the same extension (or caller ID) being configured, so messages remain associated with the same user.
- 12) Save the DID number when done.
- Save the Message Channel configuration once all the steps are completed.
At this point you should be able to send outbound messages from your Yeastar P-Series. You can test it using the Message Campaign option.
DID Number configuration in VoIP.ms
Next, you need to enable the SMS service of your DID number and add Yealink's Webhook URL.
- 13) In your VoIP.ms Customer Portal go to DID Numbers >> Manage DIDs and click on the Edit option (the pencil icon) of your DID number..
- 14) In the Edit DID Settings page, scroll down until you see the section Message Service (SMS/MMS).
- 15) Check the box of the option Message Service (SMS/MMS).
- 16) Check the box of the option SMS/MMS Webhook URL and paste there the Webhook URL in your Yeastar's Message Channel.
- 17) Change the option Dialing Mode for SMS (API) to E164.
- Apply changes and your setup will be completed.
- After this, you can start sending and receiving messages from your Yeastar P-Series using the option at Chat >> External Chat.
Note: You can confirm the messages are being sent and receive with your VoIP.ms account by checking the messages are in your VoIP.ms portal's SMS/MMS Message Center https://voip.ms/m/communications.php
Guide links
In the event where you need the guides directly from Yeastar, you may find the admin guides below:
