Asterisk VoIP Center For WHMCS

From ModulesGarden Wiki
Jump to: navigation, search


About Asterisk VoIP Center For WHMCS

Asterisk VoIP Center For WHMCS will allow you to integrate Asterisk server with your own WHMCS to remotely monitor, replay and originate all the VoIP calls.

The module offers connection owing to which you will be able to view detailed listing of calls and filter them, configure extensions and call in/out pop-up templates, and much more.
What is more, with Asterisk VoIP Center For WHMCS will have a possibility to originate calls between any destination number and original extension.

  • Admin Area Features:
✔ View Call Logs With Detailed Information
✔ Playback Call Records
✔ Filter Call Logs
✔ Create Notes For Each Call Record
✔ Display Pop-ups For Incoming And Outgoing Calls
✔ Originate Call From Addon Module Pop-up
✔ Originate Call From Widget
✔ Originate Call With One Click From Clients Profile Or Custom Field At Client's Product
✔ Set Up Custom Field To Be Used As Phone Number
✔ Assign Extensions To Admin Accounts
✔ Configure Internal Extensions
✔ Access Control List To The Module Settings
✔ Edit Incoming And Outgoing Calls Pop-up Templates
✔ Access Call Logs Tab At Clients Profile
✔ Add New Call Record In Call Log Tab At Clients Profile
  • General Info:
✔ Integrated With SMS Center For WHMCS - Receive SMS Notifications About Missed Calls (read more)
✔ Multi-Language Support
✔ Supports PHP 5.4 Up To PHP 7
✔ Supports WHMCS V6 and V7

Installation and Configuration

This tutorial will show you how to successfully install and configure Asterisk VoIP Center For WHMCS.

We will guide you step by step through the whole installation and configuration process.


1. Log in to your client area and download Asterisk VoIP Center For WHMCS.
AVC 1.png
2. Upload and extract the module into the main WHMCS directory.

Files in your WHMCS directory should look like this.

AVC 2.png
3. When you install Asterisk VoIP Center for the first time you have to rename 'license_RENAME.php' file.

File is located in 'modules/addons/AsteriskVoipCenter/license_RENAME.php' . Rename it from 'license_RENAME.php' to 'license.php' .

AVC 3.png
4. In order to configure your license key, you have to edit a previously renamed 'license.php' file.

Enter your license key between quotation marks as presented on the following screen. You can find your license key at your client area → 'My Products' .

AVC 4.png

Addon Configuration

5. Now you have to activate the module in your WHMCS system.

Log in to your WHMCS admin area. Go to the 'Setup' 'Addon Modules' . Afterwards, find 'Asterisk VoIP Center' and press 'Activate' button.

AVC 5.png
6. In the next step you need to permit access to this module.

To do so click on 'Configure' button, tick 'Access Control' near desired admin role groups and press 'Save Changes' .

AVC 6.png
7. Now, set up a cron job (each 5 minutes suggested).

Remember to replace 'your_whmcs' with your WHMCS root directory.

 'php -q /you_whmcs/modules/addons/asteriskVoipCenter/cronjob.php' .
8. Proceed to the 'Addons' 'Asterisk VoIP Center ' 'Base Settings' .
9. Now, fill out 'Server Settings' panel to configure connection with Asterisk server.

The credentials that must be used here are Asterisk Manager User Details.
You can find the necessary details if you log in to your Asterisk Manager:

  1. Log into your FreePBX UI.
  2. Find 'Settings' on the the top menu
  3. Finally, click 'Asterisk Managers' in a dropdown menu

In addition to filling in server configuration, generate 'Call Recording API Key' , which afterwards will be used to allow replay call records.
Note: 'Server Hostname' field may be filled either with hostname or IP address of Asterisk server.

AVC 7.png
10. Proceed to 'Base Settings' panel to define additional configuration.
  • Checking Frequency - how often module looks if there is any new calls.
  • All Internal Extensions List - fill in here list of all extensions existing on your server.
  • Phone Custom Field - custom client field containing client's phone number.
  • Call Logs Per Site - number of call logs show in 'Call Logs' page.
AVC 7 1.png
11. 'Access Control List' allows you to define who (besides Full Administrators) can access 'General Settings' page.

You can allow access for a specific admins or admin roles.

AVC 7 2.png
12. Last step of configuration is editing templates used as call in/out pop-up templates.

As you can see on the following screen, default pop-up templates are installed automatically during activation of the module.
All the templates are editable, use available variables to insert into the templates. You will the list of variables in Tips section.

AVC 7 3.png
11. Screen below presents pop-ups which are using default templates.
AVC 8 1.png

FreePBX Server Configuration

This section describes additional configuration allowing you to replay recorded calls from WHMCS system.

12. Upload 'getrecord.php' file located in the Asterisk VoIP Center package into root public folder of your Asterisk server.

AVC 8 2.png
13. Edit previously uploaded file, fill in your WHMCS server IP and previously generated 'Call Recording API Key'.
AVC 8 3.png
14. Afterwards, force call recording, to do so proceed to 'Applications' 'Extensions' and edit extension you wish to enable call recording for.

Force call recording for each extension as shown on the following screen.

AVC 8 4.png
12. You have just successfully installed Asterisk VoIP Center For WHMCS!


At this section we will show you possibilities of Asterisk VoIP Center For WHMCS.

Our module allows you to view log of all calls with their details and originate new calls both with client and custom numbers.
In addition to that you are able to view calls which just started owing to pop-ups and easily modify templates used by those pop-ups.

Call Logs

At the 'Call Logs' tab you can find list of all calls made through your Asterisk server.

You can find there a lot of useful information such as caller, destination, call duration and time.
Therefore you are able to easily view and filter all those calls in order to view traffic depending of time, caller, connected line or client.
Additionally, you can add a note to each call where you can store important information, remove call record from a list and view even more details of the call.

AVC 9.png
Press 'Call Details' as shown on the following screen to view more information about a call.
AVC 10.png
The pop-up with detailed information about the call will show up. You can also playback the call record at any time here.
AVC 11.png

Configure Extensions

This tab allows you to assign extension to each administrator account existing on your WHMCS server.
AVC 12.png

Originate Call

This feature extends possibilities of your Asterisk server.

At the 'Originate Call' tab you are able to originate a call between two numbers.
In order to successfully originate a call, at least one of those numbers have to be extension on your Asterisk server.
That means you can call any number, it does not matter if it is another extension or even a mobile phone.
In this way you can easily start a call between one of your administrator (via his extension) and client (using his mobile phone number).

AVC 13.png

Test Call

Test call allows you to view extended information about call origination.
AVC 17.png

Asterisk Manager Call Out Widget

Along with our module you will receive 'Asterisk Manager Call Out Widget' .

This widget allows you and any of yours administrators to easily create new call from your WHMCS system.

AVC 13 1.png

Client Profile Integration

As soon as you install your Asterisk VoIP Center For WHMCS, new functionality will appear at the admin area → Client Profile.

Owing to our module you are now able to originate a call with your client through one click as shown on the following screen.
Note: In order to successfully originate a call between you and client, your extension has to be assigned to your admin account at the 'Configure Extensions' tab of our module.

AVC 14.png
Please note that a 'Phone Number' field on 'Products/Services' page is only for the client op keep data.
AVC 15.png

Call Logs

You can easily access call logs of a client and view all details of a call.

Furthermore, you can add here calls which was made outside of your system.

AVC 16.png

SMS Center For WHMCS Integration

If you have SMS Center For WHMCS in your system, you can configure it to send unanswered call notification to an administrator who missed a call.

Firstly, create an e-mail template to send such notification. Then move to SMS Center addon, configure the equivalent text message and enable it.

Secondly, go to Asterisk VoIP Center → 'Base Settings' page.

Proceed to panel 'SMS Center integration' and choose a previously created SMS template from 'Unanswered Call SMS Template'.

AVC 18.png


1. List of variables supported by templates. 'Addon' → 'Base Settings' → 'Templates'.
<%= id %>		-Id of log in the database
<%= channel %>		- connection channel (
<%= extension %>	- extension in Asterisk
<%= callerid %>         - Id number of the caller
<%= callername %>	 - username of the caller
<%= connectedlinename %> - name of the channel line
<%= connectedlinenum %>  - number of the channel line
<%= uniqueid %>         - ID of a single action saved in Asterisk
<%= linkedid %>         - linking action ID
<%= destuniqueid %> 	- id of a receiving side of the call
<%= timestamp %>	- time the call was logged
<%= hangupstamp %>	- time the call was interrupted
<%= hangupcause %>	- the reason the call was interrupted
<%= notes %>		- any notes made by admin
<%= clientid %>         - id of a client is such has been found on the basis of the number 
<%= clientname %>	- username of a client is such has been found on the basis of the number 
<%= isCallOut %>	- defines if the call is of a call-out type

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
Personal tools

WHMCS Modules
cPanel Modules
Magento Extensions
Magento Themes
PrestaShop Modules
Blesta Extensions
Asterisk VoIP Center For WHMCS