3CX Phone System - v20
From VoIP.ms Wiki
3CX offers a complete Unified Communications solution out of the box.
As an open standards software PBX, installation and management of your phone system have never been easier.
Contents |
Pre-requisites
Latest 3CX V20 Update
- - Ensure you have the latest update of 3CX V20 installed.
Sub-Account Setup
Before proceeding, create a sub-account with the following settings:
- - Authentication type: (x) User/Password Authentication
- - Device type: (x) Asterisk, IP PBX, Gateway or VoIP Switch
- - CallerID Number: (x) I use a system capable of passing its own CallerID
- - Allowed Codecs: Only select G722 for HD voice
- - rInstance Parameter: Set to "Yes"
Trunk Configuration
If you do not already have set a VoIP.ms trunk in your instance, you will need to create one.
- [1] Log into your 3CX web interface.
- [2] Click the "Admin" icon located at the bottom left corner.
- [3] In the left menu, select "Voice & Chat".
- [4] Click the "[+ Add Trunk]" button.
General Tab
Before completing the fields, load the VoIP.ms Trunk template:
- [1] Under "General" tab, find the "SIP Trunk Details" section.
- [2] Country: Select "CA".
- [3] Trunk: Select "VoIP.ms".
Now configure the trunk:
- [1] Name: Customize as needed.
- [2] Default Route: Leave it as "End calls".
- [3] Limit To: Choose the user group to limit trunk access, default is "DEFAULT".
- [4] Outbound Rules: Check "[x] Create an outbound rules for this SIP Trunk" if no outbound route is created yet.
- [5] Registrar/Server: Enter the POP server matching your DID settings.
- [6] Main Trunk Number: Enter the default DID for this trunk.
- [7] Simultaneous Calls: Set trunk limit based on your 3CX license.
- [8] Authentication ID (SIP User ID): Enter sub-account username: eg: #####_SubAccount.
- [9] Authentication Password: Enter sub-account password.
DID Numbers Tab
If using multiple DIDs:
- [1] Go to the "DID Numbers" tab.
- [2] Click "[+ Add]" button.
- [3] Type VoIP.ms DID without hyphen, dot, or parentheses.
- [4] Press Enter.
Options Tab
If setting up outbound caller ID Name:
- [1] Go to the "Options" tab.
- [2] Click "Caller ID Control".
- [3] Enter your Caller ID Name by following the requirements below.
IMPORTANT - Caller ID Name
- Entering outbound Caller ID Name, it must be in CAPITAL LETTERS. This will appears more clearly/visible on some devices.
- You must NOT use any special characters. They will not be displayed and it prevents potential outbound call issues.
- Do NOT exceed 15 characters. Traditional canadian providers will not show more than 15 characters. We suggest shrinking or adapt the name.
- Spaces are allowed in a caller ID name but count as a characters. (do not exceed 15 chars. in total).
Click "[SAVE]" button at the top.
SMS Tab
Service Limitations
🏗️ Temporary Limitation
- ➜ Temporarily the current integration supports a maximum of 160 characters per sent message. We are currently working on a way to permit more than 160 characters and will be available soon.
- ➜ Messages longer than 160 characters will result in an error, noticeable by a ❌ where your message. The error can be retrieved in your 3CX Admin console under Event Log.
⚠️ LIMITATIONS
- ➜ VoIP.ms supports Application-to-Person (A2P) delivery for business text messaging. However, requirements and fees vary due to industry regulations. The default limit is 100 SMS per day, which can be raised upon request. Contact us at [email protected] to start your verification process.
- ➜ The limit of sending SMS/MMS using the Bearer token is limited to the same limit as our SOAP and REST/JSON API which is 100 per day. For any modification to the limit, please contact our support team through the live chat or open a ticket via the customer portal.
- ➜ The SMS/MMS service is only available for US and Canadian DID and Toll-Free Numbers marked with the distinctive SMS/MMS Icon.
- ➜ The SMS/MMS service can only be used to send SMS/MMS Messages to Canadian and US 10 digit numbers at this time.
- ➜ We cannot guarantee that accents or special characters including non-Latin letters will be properly delivered.
- ➜ Public URL shorteners such as bit.ly, tinyurl.com etc, are widely restricted by mobile providers as a response from the industry to combat SPAM campaigns and protect the consumer. Including this type of links into your messages may result in a blocked or undelivered message.
- ➜ VoIP.ms reserves the right, at its sole discretion, to limit or disable the SMS/MMS service from any account that may present marketing patterns/automation patterns/bulk sending or receiving.
💬 NOTE
- When there is an error while sending a message, you will notice a ❌ where your message. You can retrieve the error details in your 3CX Admin console under Event Log.
Generate a Bearer Token
If you do not already have a "Bearer Token" generated that you have copied somewhere, click on "Generate New Token" to obtain one. You will need to generate a new one.
- 1) Go to your VoIP.ms client portal "Main Menu" > "SOAP and REST/JSON API"
- 2) Click on "Enable" the API if its not already made.
- 3) Where Bearer Token click on Generate New Token
🔐 ATTENTION: Store your generated token securely! ⚠️
- When you generate a Bearer Token, be sure to copy and store it in a secure place, as it won't be visible again after generation.
- It will only be available to be copied once it being generated. If you lost your Bearer Token, you need to regenerate a new one.
Add your Bearer Token to your 3CX trunk
Once the trunk is created and configured
- 1) Go to the "SMS" tab.
- 2) Enable SMS: [x] Enable the service by checking the checkbox.
- 3) In the "API Key" field, paste your VoIP.ms generated Bearer Token.
- 4) Then, copy the Webhook URL, you can click on the copy 📋 icon .
Set the 3CX trunk Webhook URL to your VoIP.ms DID
- 1) Go to your VoIP.ms client portal and navigate to "DID Number" tab > "Manage DID" >
- 2) click the yellow Edit button of your DID you wish to use for SMS.
- 3) Scroll down to the SMS section until you see the Message Service (SMS/MMS) section.
- 4) Message Service (SMS/MMS): [x] Enable
- 5) In the "SMS/MMS Webhook URL (3CX)" field, paste the Webhook URL from the new 3CX trunk.
- 6) Dialing Mode for SMS (3CX): Select NANPA
Done! Simply associate the DID to your Queue or your extension.
