Top

Call Detail Record (CDR)

Call detail record (CDR) in VoIP contains information about recent system usage such as:

  • the identities of sources (points of origin)
  • the identities of destinations (endpoints)
  • the duration of each call
  • the total usage time in the billing period
  • etc.
Top

Starting the CDR Service

Before you begin
By default, this service is not activated.
Steps
  1. Go to System/Services.
  2. From the User Service table, on the Call Detail Record (CDR) line, click .
  3. Click Apply.
Result
In the User Service table, the Status of the CDR service is Started.
Top

Configuring the CDR

Before you begin
The CDR service must be started. Refer to Starting the CDR Service.
Steps
  1. Go to Telephony/Misc.
  2. In the Syslog Remote Host field, enter the host name and optional port number of the server that archives the CDR log entries, using the following format: hostname[:port].
    Note: For an example of format, refer to the Formal Protocol Syntax Description.
    Note: Specifying no port (or port 0) sends notifications to port 514.
  3. In the Syslog Format enter your format. You must use one of the supported macros displayed in the Show Help. You cannot create new macros because they will not be supported.
    Note: Field separators can be done with a coma (,), a semicolon (;), a colon (:), or/and space. The maximum number of characters allowed in the Format field is 1024.
    Note: For an example of record, refer to Call Detail Record Example.
  4. In the Syslog Facility field, select the one used to route the Call Detail Record messages.
  5. Click Apply.
Top

Examples

Formal Protocol Syntax Description

Syntax elements:
  • Macro=%[Width]|[.Precision]|MacroId
  • Width=DIGIT
  • Precision=DIGIT
Examples for: sipid=SipUser001
  • CDR Log : %sipid --> CDR Log : SipUser001
  • CDR Log : %15sipid --> CDR Log : SipUser001
  • CDR Log : %15.5sipid --> CDR Log : SipUs
  • CDR Log : %.5sipid --> CDR Log : SipUs
Top

Call Detail Record Macros and Control Characters

Control characters
  • %% : %
  • \n : Split message
Call detail record macros :
  • %id : CDR ID. The CDR ID is unique. The ID is incremented by one each time it is represented in a CDR record.
  • %sipid : SIP call ID. Blank if no SIP interface was used during the call.
  • %ocgnum : Original calling number. Calling number as received by the unit.
  • %cgnum : Calling number. Calling number after manipulation by the call router.
  • %ocdnum : Original called number. Called number as received by the unit.
  • %cdnum : Called number. Called number after manipulation by the call router.
  • %oiname : Origin interface name. Interface on which the call was received. Ex. isdn-Slot2/Pri1.
  • %diname : Destination interface name. Interface on which the call was relayed. Ex. SIP-Default.
  • %chan : Channel number. Blank if no PRI/BRI interface was used during the call. If 2 PRI/BRI interfaces were involved, display the originating interface.
  • %sipla : SIP local IP address.
  • %sipra : SIP remote IP address or FQDN (next hop).
  • %siprp : SIP remote port (next hop).
  • %mra : Media remote IP address. Source IP address of the incoming media stream. If the stream was modified during the call, display the last stream.
  • %mrsp : Media remote source port. Source port of the incoming media stream. If the stream was modified during the call, display the last stream.
  • %mrp : Media remote port. Destination port of the outgoing media stream. If the stream was modified during the call, display the last stream.
  • %tz : Local time zone
  • %cd : Call duration (in seconds) (connect/disconnect).
  • %sd : Call duration (in seconds) (setup/connect).
  • %pdd : Post dial delay (in seconds) (setup/progress).
  • %css : Call setup second (local time)
  • %csm : Call setup minute (local time)
  • %csh : Call setup hour (local time)
  • %csd : Call setup day (local time)
  • %csmm : Call setup month (local time)
  • %csy : Call setup year (local time)
  • %ccs : Call connect second (local time)
  • %ccm : Call connect minute (local time)
  • %cch : Call connect hour (local time)
  • %ccd : Call connect day (local time)
  • %ccmm : Call connect month (local time)
  • %ccy : Call connect year (local time)
  • %cds : Call disconnect second (local time)
  • %cdm : Call disconnect minute (local time)
  • %cdh : Call disconnect hour (local time)
  • %cdd : Call disconnect day (local time)
  • %cdmm : Call disconnect month (local time)
  • %cdy : Call disconnect year (local time)
  • %miptxc : IP Media last transmitted codec
  • %miptxp : IP Media last transmitted p-time
  • %dr : Call disconnect reason, expressed as a Q.850 cause. The Q.850 codes are used to represent the disconnect cause no matter what type of interface initiated the disconnect (SIP, FXS, ISDN, ...). A value of 0 means that no cause code is available.
  • %rxp : Received media packets. Excluding T.38.
  • %txp : Transmitted media packets. Excluding T.38.
  • %rxpl : Received media packets lost. Excluding T.38.
  • %rxmd : Received packets mean playout delay (ms, 2 decimals). Excluding T.38.
  • %rxaj : Received packets average jitter (ms, 2 decimals). Excluding T.38.
  • %sipdr : SIP status code of the received SIP response that caused the disconnect or rejection. A value of 0 means that no status code is available.
Top

Call Detail Record Example



Syslog message: LOCAL0.INFO: 1;1141399338;1140175242;37;16;200;2017;07;07;15;00;20
  • 1:CDR ID (internal)
  • 1141399338: calling number (before being transformed by the Call Router)
  • 1140175242: called number (before being transformed by the Call Router)
  • 37: call duration (seconds)
  • 16: reason for ISDN disconnection
  • 200: reason for SIP disconnection
  • 2017: year
  • 07: month
  • 07: day
  • 15: hour
  • 00: minute
  • 20: second
Top

Online Help

If you are not familiar with the meaning of the fields and buttons, click Show Help, located at the upper right corner of the Web page. When activated, the fields and buttons that offer online help will change to green and if you hover over them, the description will bedisplayed.

Top

DGW Documentation

Mediatrix devices are supplied with an exhaustive set of documentation.

Mediatrix user documentation is available on the Media5 Documentation Portal.

Several types of documents were created to clearly present the information you are looking for. Our documentation includes:
  • Release notes: Generated at each GA release, this document includes the known and solved issues of the software. It also outlines the changes and the new features the release includes.
  • Configuration notes: These documents are created to facilitate the configuration of a specific use case. They address a configuration aspect we consider that most users will need to perform. However, in some cases, a configuration note is created after receiving a question from a customer. They provide standard step-by-step procedures detailing the values of the parameters to use. They provide a means of validation and present some conceptual information. The configuration notes are specifically created to guide the user through an aspect of the configuration.
  • Technical bulletins: These documents are created to facilitate the configuration of a specific technical action, such as performing a firmware upgrade.
  • Hardware installation guide: They provide the detailed procedure on how to safely and adequately install the unit. It provides information on card installation, cable connections, and how to access for the first time the Management interface.
  • User guide: The user guide explains how to customise to your needs the configuration of the unit. Although this document is task oriented, it provides conceptual information to help the user understand the purpose and impact of each task. The User Guide will provide information such as where and how TR-069 can be configured in the Management Interface, how to set firewalls, or how to use the CLI to configure parameters that are not available in the Management Interface.
  • Reference guide: This exhaustive document has been created for advanced users. It includes a description of all the parameters used by all the services of the Mediatrix units. You will find, for example, scripts to configure a specific parameter, notification messages sent by a service, or an action description used to create Rulesets. This document includes reference information such as a dictionary, and it does not include any step-by-step procedures.
Top

Copyright Notice

Copyright © 2023 Media5 Corporation.

This document contains information that is proprietary to Media5 Corporation.

Media5 Corporation reserves all rights to this document as well as to the Intellectual Property of the document and the technology and know-how that it includes and represents.

This publication cannot be reproduced, neither in whole nor in part, in any form whatsoever, without written prior approval by Media5 Corporation.

Media5 Corporation reserves the right to revise this publication and make changes at any time and without the obligation to notify any person and/or entity of such revisions and/or changes.