telyzer

FreePBX / Asterisk

FreePBX / Asterisk: AMI Cdr events (port 5038).

Documentation menu
Note: Preview: built from the maker's documented record layout. Send us a few real lines from your PBX and we confirm them before your reports go live.

How to connect FreePBX / Asterisk (FreePBX, PBXact, Asterisk, Issabel, Zycoo, VitalPBX) to Telyzer Cloud and to a Telyzer Server.

Values in dashed boxes are this organization's own: the portal's How to connect panel shows them filled in, with copy buttons.

CDR database (Telyzer reads new rows)

Coming later — use AMI Cdr events or Master.csv for now.

Telyzer Cloud

  1. On the PBX create a read-only database user for asteriskcdrdb (MariaDB/MySQL), allowed from the relay PC's address the relay PC's address only: GRANT SELECT ON asteriskcdrdb.cdr TO 'telyzer'@'the relay PC's address' IDENTIFIED BY '…';
  2. In the Telyzer Relay choose "Read the CDR database" and enter the PBX's address your PBX's address, port 3306, the user and its password; the relay reads new rows every minute.

Telyzer Server

  1. Create a read-only user for asteriskcdrdb.cdr allowed from your Telyzer address, then on this connector choose "Read the CDR database" with the PBX's address your PBX's address, port 3306, the user and its password.
Enter on the PBXValue
PBX addressyour PBX's address
Database port3306
Check that it works: Make a short outside call and an internal call. Within a minute the connector shows "First call record received"; if it shows records that were not read, open the raw line and send it to support.

AMI Cdr events (port 5038)

Recommended for Telyzer Cloud and Telyzer Server.

Telyzer Cloud

  1. In FreePBX Settings > Asterisk Manager Users add a user with read permission "cdr" only, permitted from the relay PC's address/255.255.255.255, and make sure cdr_manager is enabled (cdr_manager.conf: enabled = yes).
  2. Install the Telyzer Relay on a Windows PC in the same network as the PBX. In the relay choose "Telyzer connects to the PBX" and enter the PBX's address your PBX's address and port your PBX's port; the relay keeps the connection open and sends the records to Telyzer over HTTPS (outbound only).
  3. On the relay PC (PowerShell as Administrator) that is: telyzer-relay add-collector --kind tcp_connect --host your PBX's address --port your PBX's port --protocol ami --user <AMI user> --password <secret>, then Restart-Service TelyzerRelay.

Telyzer Server

  1. Add an Asterisk Manager user with read permission "cdr" permitted from your Telyzer address, enable cdr_manager, then on this connector choose AMI with the PBX's address your PBX's address and port 5038.
Enter on the PBXValue
PBX addressyour PBX's address
PBX port5038
Check that it works: Make a short outside call and an internal call. Within a minute the connector shows "First call record received"; if it shows records that were not read, open the raw line and send it to support.

Master.csv file

Telyzer Cloud

  1. Let the relay collect /var/log/asterisk/cdr-csv/Master.csv by SFTP (a read-only Linux user), or copy it into the watched folder; new lines are sent as they are added.
  2. To collect it by SFTP and leave the file on the PBX, run on the relay PC (PowerShell as Administrator): telyzer-relay add-sftp --host your PBX's address --user <login> --password <password> --dir /var/log/asterisk/cdr-csv --pattern Master.csv --keep, then Restart-Service TelyzerRelay.
  3. To have the relay read the folder, run on the relay PC (PowerShell as Administrator): telyzer-relay watch-folder --dir the watched folder, then Restart-Service TelyzerRelay.

Telyzer Server

  1. Add an SFTP collection of /var/log/asterisk/cdr-csv/Master.csv on this connector, or copy it into the watched folder on the server.
Enter on the PBXValue
Folderthe watched folder
Check that it works: Make a short outside call and an internal call. Within a minute the connector shows "First call record received"; if it shows records that were not read, open the raw line and send it to support.

Check that it works

  1. Make an external test call and hang up. The phone system sends the record when the call ends, so it arrives a few seconds later.
  2. In Telyzer, Waiting for the first call record turns green when the first record is read. If it shows a problem instead — no connection yet, connections refused, or records that could not be read — it names the cause and shows the line received.

All phone systems