This guide covers the basic registration steps, how to configure routes, and how to set up SMS with SIPTRUNK for 3CX Version 20. You should already have SMS-enabled numbers with a completed 10DLC, an active Campaign, and an active billing plan prior to beginning this guide. The “My Messaging” tab should be visible in the Customer Portal to indicate SMS is enabled on the account. Please note this guide is for new installs of 3CX. Screenshots are included throughout to demonstrate the process.
There is no longer a separate Admin Console for 3CX. Access the Admin panel from the Web Client by clicking on the cog in the lower left corner.
Trunk Configuration and Registration
The trunk setup process is different for SMS-enabled DIDs. To match the standard SIPTRUNK inbound parameters, a custom template must be set up using the Generic Provider option. It is necessary to create a new trunk for this. Begin by downloading the XML file edit attached at the end of this guide.
In the 3CX Admin panel, navigate to Advanced > Templates > Provider Templates and choose “Import Provider”. Upload the SIPTrunkGeneric XML file and confirm the import. It will automatically configure a new generic Trunk.
Name the Trunk and assign a User. Next, go to our Customer Portal under the SIP Trunking menu and view the trunk to get the number and password. Enter your trunk number in the “Main Trunk Number” and “Authentication ID” fields and the password in the “Password” field.
The gateways should already be configured from the template and read “gw.siptrunk.com” in the “Registrar/Server” field and “gw1.siptrunk.com” in the “Outbound Proxy” field. Check the “Auto discovery” option for both. Lastly, navigate to the “Options” tab for the Trunk and confirm “gw2.siptrunk.com” is in the Alternate Proxy field. “Save” the Trunk changes.
If you want to check that the registration was successful, return to the Voice and Chat main menu to see if the trunk status light turns green after several moments. You can also check in the SIP Trunk Customer Portal in the SIP Trunking menu by clicking the “View Registration Status” button for the Trunk.
Inbound Calling
Now go back into the trunk settings again to add the SMS-enabled numbers under the “DID Numbers” tab for the inbound routing. Add your DIDs in either of the following formats based upon your requirements (both will work):
- DIDs will be formatted as *1NXXXXXXXX
- DIDs will be formatted as +1NXXXXXXXX (a 1 followed by the number in a 10-digit format)
When adding a number, be sure to click the SAVE icon next to the field or press Enter. The number now needs to be assigned to a User. First, SAVE the trunk changes before navigating away to the User panel. Otherwise, you will lose everything you just set up.
The DID number will appear Unassigned by default and still needs to have an assigned User to route inbound calls. Navigate to the “Users” menu and select the User you want to associate to the DID you just created. Find the DID in the “Assigned DID number(s) drop down to assign it to that User. Save the changes. You’ll now see the DID is assigned to the User in the trunk settings. Configure the rest of the User profile based upon your setup and needs.
You should now be able to call the User at the number you just created and assigned.
Outbound Calling
Next is how to set up outbound calling. We will create several rules to support different types of calls including domestic (11 digits), 3-digit, and international. Remember to SAVE all of your settings for each rule.
Click on the Outbound Routes tab and click “Add Rule”.
Name the first rule 11-digit dialing, because we require you to send 11 digits outbound for domestic calling. Enter 11 in the field “Calls to numbers with a length of”. If you dial 10 digits, calls will fail. Create another rule for 10 digits and prepend a 1 if your client only wishes to dial 10 digits.
Click on the Route and set the trunk for each rule. You can also add your CID in the “Outbound caller ID” field.
11-Digit Dialing
10-Digit Dialing
3-Digit Dialing
We support 911, 933, and 988 regarding 3-digit dialing. Name and then set the rule to apply to calls with a length of three digits. Assign the Trunk in the Route field.
Enter a caller ID in the “Outbound caller ID field”. If you plan to use the rule for dialing to 911, enter your Enhanced number for the caller ID here.
International Dialing
For International dialing, enter 011 into the “Calls to numbers starting with prefix” field and then set the “Strip digits” to 3. This will tell the PBX when you dial 011 to ignore any other rule no matter the number of digits dialed. The strip will remove the 011 so you only send us the international phone number you’re dialing.
NOTE: Remember to select the Trunk and set the CID.
Complete SMS Configuration
Navigate to the SIP Trunk Customer Portal and enter the “My Messaging” tab to view SMS-enabled numbers and configuration options. You should see your DID with a green icon indicating it is enabled.
The API Key needs to be generated next. Click the “API Keys” button and then “Create New API Key”. Save the generated credentials for later, because you will not be able to recover this information from our Portal again and will then need to generate a new API Key.
Return to the 3CX Admin Console and edit the Generic SIP trunk you created earlier and navigate to the SMS tab. Toggle the “Enable SMS” button on and enter your “3CX API Token” from the SIPTRUNK Customer Portal into the “API Key” field and enter https://messaging.siptrunk.com/3cx/ into the “Provider URL” field. Remember to save the changes to the trunk.
Copy the Webhook URL from the Trunk in 3CX and navigate back to the SIP Trunk Customer Portal and click the “Webhooks” button. Click “Create New Webhook” and paste the URL into the “Description” field, name your webhook, and then submit it. Your webhook will be created and you can then assign it to your DID number via the dropdown.
Your number is now configured for SMS and you can place test messages via the “Chat” menu in 3CX. Please open a ticket with SIPTRUNK Support if you need assistance with the configuration process.
Comments