bg

Allworx SMDR setup and CDR format

This page shows how to get call records out of the Allworx into Advanced PBX Data Logger: the connection settings, the parser to select and the 22 fields the logger extracts for reports or a database. The settings apply to our logger; other call accounting software may expect a different configuration.

Quick facts

ItemAllworx
InterfaceLAN. The PBX accepts a connection on TCP port 16366; the logger connects to the PBX IP address.
Port16366
Parser to selectAllworx
Fields extracted22

Allworx 24x/Allworx 6x

Advanced PBX Data Logger connects to the Allworx 24x/6x using the following the TCP client mode. Follow these step-by-step instructions to properly configure your Allworx 24x/6x:

1. Open the Allworx Administrator web interface (<Allworx system IP>:8080 in your browser).

2. Go to Home > Reports > Call Details > Call Details Settings.

3. Verify that your Allworx is configured to store live & completed calls, stream live & completed calls and that the "Call Detail Streaming Port" is set to "16366"

Call details

If necessary, click on the modify link on the top of the page to edit your configuration. Set the "Call Detail Storage and Call Detail Streaming" to "Live and Completed Calls". Also make sure that the "Call Detail Streaming Port" is set to "16366". When you are finished, click the "Update" button to save your changes.

Call details modify

Settings from the manufacturer's documentation

Taken from Allworx - Streaming CDRs to External Devices. Values are those stated in the documentation; confirm them against your firmware release.

Record format notes

  • CDR records are delimited by CRLF new-line characters; fields within a record are delimited by commas, and any comma occurring inside a field's own data is replaced by a space.
  • Blank string fields are represented by two consecutive commas; blank integer fields contain a zero.
  • A CDR is streamed to connected clients twice per call leg: once when the leg connects (IsLive=1, start) and once when it terminates (IsLive=0, end); a call that rings unanswered produces no CDR at all.
  • The documented layout has 19 ordered, named fields (Call-ID through DNIS Number); any fields after the last one are reserved for future use and should be ignored by the client.

Configuring PBX Data Logger as a TCP client

Our software should work in the TCP client mode. It means that our software will initiate connection with the PBX and the PBX will work as a server. Add one or several PBX IP addresses here (the IP address of the Allworx System). The port number should match the port that you have defined within the PBX (16366 in the example below).

1. Add a new configuration with the TCP data source (if you didn't it before).

TCP/IP Data Interface

2. Configure the TCP settings as shown below.

TCP Client Mode - Allworx System

192.168.1.220

16366

192.168.1.220:16366

Selecting the correct parser for Allworx

Parser Selection For PBX Data Logger

Allworx

Allworx

Data items

DescriptionData typeColumn name
Call IDstringFLAG4
Call leg IDstringFLAG5
Is liveintegerFLAG6
TerminatorintegerFLAG7
Call typeintegerCALL_TYPE
Call timedatetimeCALL_TIME
Call duration (s)integerCALL_DURATION_S
Call durationdatetimeCALL_DURATION
Source devicestringSOURCE_DEVICE
Source device namestringSOURCE_DEVICE_NAME
Destination devicestringDEST_DEVICE
Destination device namestringDEST_DEVICE_NAME
DirectionstringDIRECTION
Caller namestringFLAG1
Called namestringFLAG2
TrunkstringTRUNK
Caller numberstringCALLER_PHONE
ExtensionstringEXT
Called namestringCALLED_NAME
Dialed numberstringDIALED_PHONE
PinstringACC
DNISstringDNIS

Sample record

As delivered by the system; phone numbers, names and public addresses are masked.

<201xxxxxxxxxxx.714>400xxxxxx,13167,1,136xxxxxxx,0,Chan:01,TW -PRI - 01,,215xxxxxxx,Port:05,Name Fax Line,858-xxx-xxxx,7231,,,0,2,,858xxxxxxx
<201xxxxxxxxxxx.350>400xxxxxx,13167,0,136xxxxxxx,40,Chan:01,TW -PRI - 01,,215xxxxxxx,Port:05,Name Fax Line,858-xxx-xxxx,7231,,,2,2,,858xxxxxxx
<201xxxxxxxxxxx.215>400xxxxxx,13168,1,136xxxxxxx,0,Chan:01,TW -PRI - 01,,904xxxxxxx,,CA [Name       ],Name Surname   ,6408,,,0,2,,858xxxxxxx
<201xxxxxxxxxxx.510>400xxxxxx,13168,0,136xxxxxxx,4,Chan:01,TW -PRI - 01,,904xxxxxxx,,CA [Name       ],Name Surname   ,6408,,,1,2,,858xxxxxxx
<201xxxxxxxxxxx.383>400xxxxxx,13169,1,136xxxxxxx,0,MAC:00-0A-DD-86-83-80,A Person   ,,6437,Chan:23,TW -PRI - 23,,,,131xxxxxxxx,0,2,TW -PRI - 23,
<201xxxxxxxxxxx.619>400xxxxxx,13169,0,136xxxxxxx,53,MAC:00-0A-DD-86-83-80,A Person   ,,6437,Chan:23,TW -PRI - 23,,,,131xxxxxxxx,1,2,TW -PRI - 23,
<201xxxxxxxxxxx.119>400xxxxxx,13170,1,136xxxxxxx,0,Chan:01,TW -PRI - 01,,651xxxxxxx,Chan:23,TW -PRI - 23,,6412,,185xxxxxxxx,0,2,TW -PRI - 23,858xxxxxxx
<201xxxxxxxxxxx.622>400xxxxxx,13170,0,136xxxxxxx,4,Chan:01,TW -PRI - 01,,651xxxxxxx,Chan:23,TW -PRI - 23,,6412,,185xxxxxxxx,1,2,TW -PRI - 23,858xxxxxxx
<201xxxxxxxxxxx.939>400xxxxxx,13171,1,136xxxxxxx,0,MAC:00-0A-DD-86-83-80,A Person   ,,6437,Chan:23,TW -PRI - 23,,,,177xxxxxxxx,0,2,TW -PRI - 23,
<201xxxxxxxxxxx.468>400xxxxxx,13172,1,136xxxxxxx,0,Chan:01,TW -PRI - 01,,810xxxxxxx,,CA [Name  ],A Person   ,6437,,,0,2,,858xxxxxxx
<201xxxxxxxxxxx.947>400xxxxxx,13171,0,136xxxxxxx,127,MAC:00-0A-DD-86-83-80,A Person   ,,6437,Chan:23,TW -PRI - 23,,,,177xxxxxxxx,1,2,TW -PRI - 23,
<201xxxxxxxxxxx.969>400xxxxxx,13172,0,136xxxxxxx,52,Chan:01,TW -PRI - 01,,810xxxxxxx,,CA [Name  ],A Person   ,6437,,,1,2,,858xxxxxxx
<201xxxxxxxxxxx.806>400xxxxxx,13173,1,136xxxxxxx,0,MAC:00-0A-DD-86-83-80,A Person   ,,6437,,VM [404],,,,,0,1,,
<201xxxxxxxxxxx.418>400xxxxxx,13174,1,136xxxxxxx,0,Chan:01,TW -PRI - 01,,810xxxxxxx,,CA [Name  ],A Person   ,6437,,,0,2,,858xxxxxxx
<201xxxxxxxxxxx.447>400xxxxxx,13173,0,136xxxxxxx,31,MAC:00-0A-DD-86-83-80,A Person   ,,6437,,VM [404],,,,,1,1,,
<201xxxxxxxxxxx.320>400xxxxxx,13174,0,136xxxxxxx,65,Chan:01,TW -PRI - 01,,810xxxxxxx,,CA [Name  ],A Person   ,6437,,,1,2,,858xxxxxxx
<201xxxxxxxxxxx.765>400xxxxxx,13175,1,136xxxxxxx,0,MAC:00-0A-DD-86-83-80,A Person   ,,6437,,VM [404],,,,,0,1,,
<201xxxxxxxxxxx.839>400xxxxxx,13175,0,136xxxxxxx,91,MAC:00-0A-DD-86-83-80,A Person   ,,6437,,VM [404],,,,,1,1,,
<201xxxxxxxxxxx.037>400xxxxxx,13176,1,136xxxxxxx,0,MAC:00-0A-DD-86-79-
...

Reports and a database

Once records arrive, the logger writes them to a text file or to any ODBC database in real time, or hands them to the PBX Reports utility for manual, scheduled and e-mailed reports with a built-in web server. See exporting call log data to a database for the database setup.

Related Allworx systems

Alcatel OmniPCX Office
Alcatel OmniPCX Office (OHL Driver XML)
Altigen
Aristel AV38 (DD MM)
All supported PBX systems

Note: Products and companies mentioned here are used only for definition and identification purposes and can be trademarks and/or registered trademarks of the respective companies.