<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2023"><meta name="DC.rights.owner" content="(C) Copyright 2023"><meta name="DC.type" content="concept"><meta name="description" content="Call detail record (CDR) in VoIP contains information about recent system usage such as:"><meta name="prodname" content="All Mediatrix Products"><meta name="version" content="DGW 49.12.28842941"><meta name="platform" content="All"><meta name="DC.date.modified" content="2023-0308-2809"><meta name="DC.date.issued" content="2023-0308-2809"><meta name="DC.date.available" content="2023-0308-2809"><meta name="ChapterNumbering" content="no"><meta name="DC.format" content="HTML5"><meta name="DC.identifier" content="concept_m3p_g4p_rz"><link href="https://fonts.googleapis.com/css?family=Open+Sans" rel="stylesheet"><link rel="stylesheet" type="text/css" href="https://documentation.media5corp.com/download/attachments/62825785/commonltr.css"><link rel="stylesheet" type="text/css" href="https://documentation.media5corp.com/download/attachments/62825785/custom.css"><title>Call Detail Record</title></head><body><header role="banner"><div class="topicmeta title">Call Detail Record</div><div class="topicmeta date">2023-0308-28<09</div><div class="topicmeta product">All Mediatrix Products</div><div class="topicmeta version">DGW 49.12.2884<2941</div><div class="topicmeta pdf"><a href="https://documentation.media5corp.com/download/attachments/62825785/Call%20Detail%20Record.pdf" rel="nofollow">Download PDF Document</a></div><hr><span style="float: inline-end;"></span></header><nav role="toc"><ul><li><a href="#concept_m3p_g4p_rz">Call Detail Record (CDR)</a><ul><li><a href="#task_yqv_m5p_rz">Starting the CDR Service</a></li><li><a href="#task_umn_ycq_rz">Configuring the CDR</a></li></ul></li><li><a href="#topic_title_Examples_d1e18">Examples</a><ul><li><a href="#reference_dlx_1v5_q1b">Formal Protocol Syntax Description</a></li><li><a href="#reference_omh_nlj_xlb">Call Detail Record Macros and Control Characters</a></li><li><a href="#reference_scd_wv5_q1b">Call Detail Record Example</a></li></ul></li><li><a href="#reference_j4g_nbv_gfb">Online Help</a></li><li><a href="#concept_v4k_q3h_1r">DGW Documentation</a></li><li><a href="#concept_fqm_rv4_k4">Copyright Notice</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1"><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="nested0" aria-labelledby="ariaid-title1" id="concept_m3p_g4p_rz">
<h1 class="title topictitle1" id="ariaid-title1">Call Detail Record (CDR)</h1>
<div class="body conbody"><p class="shortdesc">Call detail record (CDR) in VoIP contains information about recent system usage such as: </p>
<div class="p">
<ul class="ul" id="concept_m3p_g4p_rz__ul_b1s_sqv_q1b">
<li class="li">the identities of sources (points of origin)</li>
<li class="li">the identities of destinations (endpoints)</li>
<li class="li">the duration of each call</li>
<li class="li">the total usage time in the billing period</li>
<li class="li">etc.</li>
</ul>
</div>
</div>
<hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic task nested1" aria-labelledby="ariaid-title2" id="task_yqv_m5p_rz">
<h2 class="title topictitle2" id="ariaid-title2">Starting the CDR Service</h2>
<div class="body taskbody">
<section class="section prereq"><div class="tasklabel"><strong class="sectiontitle tasklabel">Before you begin</strong></div>By default, this service is not activated.</section>
<section><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps"><li class="li step">
<span class="ph cmd">Go to <span class="keyword wintitle">System</span>/<span class="keyword wintitle">Services</span>.</span>
</li><li class="li step">
<span class="ph cmd">From the <span class="keyword wintitle">User Service</span>
table, on the <span class="keyword wintitle">Call Detail Record (CDR)</span>
line, click <img class="image" id="task_yqv_m5p_rz__image_p5g_lzp_rz" src="https://documentation.media5corp.com/download/attachments/62825785/fleche.jpg" width="18">.</span>
</li><li class="li step">
<span class="ph cmd">Click <span class="keyword wintitle">Apply</span>.</span>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div>In the <span class="keyword wintitle">User Service</span> table,
the <span class="keyword wintitle">Status</span> of the CDR service
is <span class="keyword wintitle">Started</span>.</section>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic task nested1" aria-labelledby="ariaid-title3" id="task_umn_ycq_rz">
<h2 class="title topictitle2" id="ariaid-title3">Configuring the CDR</h2>
<div class="body taskbody">
<section class="section prereq"><div class="tasklabel"><strong class="sectiontitle tasklabel">Before you begin</strong></div>The CDR service must be started. Refer to <a class="xref" href="#task_yqv_m5p_rz">Starting the CDR Service</a>.</section>
<section><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps"><li class="li step stepexpand">
<span class="ph cmd">Go to <span class="keyword wintitle">Telephony</span>/<span class="keyword wintitle">Misc</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Syslog Remote Host</span> field, enter the host name and optional port number of the server that
archives the CDR log entries, using the following format: hostname[:port].</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> For an example of format, refer to the <a class="xref" href="#reference_dlx_1v5_q1b">Formal Protocol Syntax Description</a>.</div>
</div>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> Specifying no port (or port 0) sends notifications to port 514.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Syslog Format</span>
enter your format. You must use one of the supported macros displayed in the
<span class="keyword wintitle">Show Help</span>. You
cannot create new macros because they will not be supported.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> Field separators can be done with a coma (,), a semicolon (;), a colon
(:), or/and space. The maximum number of characters allowed in the <span class="keyword wintitle">Format</span> field is
1024.</div>
</div>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> For an example of record, refer to <a class="xref" href="#reference_scd_wv5_q1b">Call Detail Record Example</a>. </div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Syslog Facility</span>
field, select the one used to route the Call Detail Record messages.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Apply</span>.</span>
</li></ol></section>
</div>
</article></article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic nested0 nobody" aria-labelledby="ariaid-title4" id="topic_title_Examples_d1e18">
<h1 class="title topictitle1" id="ariaid-title4">Examples</h1>
<article class="topic reference nested1" aria-labelledby="ariaid-title5" id="reference_dlx_1v5_q1b">
<h2 class="title topictitle2" id="ariaid-title5">Formal Protocol Syntax Description</h2>
<div class="body refbody">
<section class="section">Syntax elements:<ul class="ul" id="reference_dlx_1v5_q1b__ul_ypc_d3b_h1b">
<li class="li">Macro=%[Width]|[.Precision]|MacroId</li>
<li class="li">Width=DIGIT</li>
<li class="li">Precision=DIGIT</li>
</ul>Examples for: sipid=SipUser001<ul class="ul" id="reference_dlx_1v5_q1b__ul_jzd_gdb_h1b">
<li class="li">CDR Log : %sipid --> CDR Log : SipUser001</li>
<li class="li">CDR Log : %15sipid --> CDR Log : SipUser001</li>
<li class="li">CDR Log : %15.5sipid --> CDR Log : SipUs</li>
<li class="li">CDR Log : %.5sipid --> CDR Log : SipUs</li>
</ul></section>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic reference nested1" aria-labelledby="ariaid-title6" id="reference_omh_nlj_xlb">
<h2 class="title topictitle2" id="ariaid-title6">Call Detail Record Macros and Control Characters</h2>
<div class="body refbody">
<section class="section">Control characters<ul class="ul">
<li class="li">%% : %</li>
<li class="li">\n : Split message</li>
</ul></section>
<section class="section">Call detail record macros :<ul class="ul">
<li class="li">%id : CDR ID. The CDR ID is unique. The ID is incremented by one each time it is
represented in a CDR record.</li>
<li class="li">%sipid : SIP call ID. Blank if no SIP interface was used during the call.</li>
<li class="li">%ocgnum : Original calling number. Calling number as received by the unit.</li>
<li class="li">%cgnum : Calling number. Calling number after manipulation by the call router.</li>
<li class="li">%ocdnum : Original called number. Called number as received by the unit.</li>
<li class="li">%cdnum : Called number. Called number after manipulation by the call router.</li>
<li class="li">%oiname : Origin interface name. Interface on which the call was received. Ex.
isdn-Slot2/Pri1.</li>
<li class="li">%diname : Destination interface name. Interface on which the call was relayed. Ex.
SIP-Default.</li>
<li class="li">%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.</li>
<li class="li">%sipla : SIP local IP address.</li>
<li class="li">%sipra : SIP remote IP address or FQDN (next hop).</li>
<li class="li">%siprp : SIP remote port (next hop). </li>
<li class="li">%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.</li>
<li class="li">%mrsp : Media remote source port. Source port of the incoming media stream. If the
stream was modified during the call, display the last stream.</li>
<li class="li">%mrp : Media remote port. Destination port of the outgoing media stream. If the stream
was modified during the call, display the last stream.</li>
<li class="li">%tz : Local time zone</li>
<li class="li">%cd : Call duration (in seconds) (connect/disconnect).</li>
<li class="li">%sd : Call duration (in seconds) (setup/connect).</li>
<li class="li">%pdd : Post dial delay (in seconds) (setup/progress).</li>
<li class="li">%css : Call setup second (local time)</li>
<li class="li">%csm : Call setup minute (local time)</li>
<li class="li">%csh : Call setup hour (local time)</li>
<li class="li">%csd : Call setup day (local time)</li>
<li class="li">%csmm : Call setup month (local time)</li>
<li class="li">%csy : Call setup year (local time)</li>
<li class="li">%ccs : Call connect second (local time)</li>
<li class="li">%ccm : Call connect minute (local time)</li>
<li class="li">%cch : Call connect hour (local time)</li>
<li class="li">%ccd : Call connect day (local time)</li>
<li class="li">%ccmm : Call connect month (local time)</li>
<li class="li">%ccy : Call connect year (local time)</li>
<li class="li">%cds : Call disconnect second (local time)</li>
<li class="li">%cdm : Call disconnect minute (local time)</li>
<li class="li">%cdh : Call disconnect hour (local time)</li>
<li class="li">%cdd : Call disconnect day (local time)</li>
<li class="li">%cdmm : Call disconnect month (local time)</li>
<li class="li">%cdy : Call disconnect year (local time)</li>
<li class="li">%miptxc : IP Media last transmitted codec</li>
<li class="li">%miptxp : IP Media last transmitted p-time</li>
<li class="li">%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.</li>
<li class="li">%rxp : Received media packets. Excluding T.38.</li>
<li class="li">%txp : Transmitted media packets. Excluding T.38.</li>
<li class="li">%rxpl : Received media packets lost. Excluding T.38.</li>
<li class="li">%rxmd : Received packets mean playout delay (ms, 2 decimals). Excluding T.38.</li>
<li class="li">%rxaj : Received packets average jitter (ms, 2 decimals). Excluding T.38.</li>
<li class="li">%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.</li>
</ul>
</section>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic reference nested1" aria-labelledby="ariaid-title7" id="reference_scd_wv5_q1b">
<h2 class="title topictitle2" id="ariaid-title7">Call Detail Record Example</h2>
<div class="body refbody">
<section class="section"><br><img class="image" id="reference_scd_wv5_q1b__image_rkh_nn5_q1b" src="https://documentation.media5corp.com/download/attachments/62825785/CDR_Format_example.png" width="800"><br>Syslog message: LOCAL0.INFO:
1;1141399338;1140175242;37;16;200;2017;07;07;15;00;20<ul class="ul" id="reference_scd_wv5_q1b__ul_llc_tn5_q1b">
<li class="li">1:CDR ID (internal)</li>
<li class="li">1141399338: calling number (before being transformed by the Call Router)</li>
<li class="li">1140175242: called number (before being transformed by the Call Router)</li>
<li class="li">37: call duration (seconds)</li>
<li class="li">16: reason for ISDN disconnection</li>
<li class="li">200: reason for SIP disconnection</li>
<li class="li">2017: year</li>
<li class="li">07: month</li>
<li class="li">07: day</li>
<li class="li">15: hour</li>
<li class="li">00: minute</li>
<li class="li">20: second</li>
</ul></section>
</div>
</article></article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic reference nested0" aria-labelledby="ariaid-title8" id="reference_j4g_nbv_gfb">
<h1 class="title topictitle1" id="ariaid-title8">Online Help</h1>
<p class="shortdesc"><span class="ph">If you are not familiar with the meaning of the fields and
buttons, click <span class="keyword wintitle">Show Help</span>, 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.</span></p>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic concept nested0" aria-labelledby="ariaid-title9" id="concept_v4k_q3h_1r">
<h1 class="title topictitle1" id="ariaid-title9">DGW Documentation</h1>
<div class="body conbody"><p class="shortdesc">Mediatrix devices are supplied with an exhaustive set of documentation. </p>
<p class="p">Mediatrix user documentation is available on the <a class="xref" href="http://documentation.media5corp.com" target="_blank">Media5 Documentation
Portal</a>.</p>
<div class="p">Several types of documents were created to clearly present the information you are looking for.
Our documentation includes:<ul class="ul" id="concept_v4k_q3h_1r__ul_bqy_cjh_1r">
<li class="li"><strong class="ph b">Release notes</strong>: 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.</li>
<li class="li"><strong class="ph b">Configuration notes</strong>: 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. </li>
<li class="li"><strong class="ph b">Technical bulletins</strong>: These documents are created to facilitate the configuration of a
specific technical action, such as performing a firmware upgrade.</li>
<li class="li"><strong class="ph b">Hardware installation guide</strong>: 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.</li>
<li class="li"><strong class="ph b">User guide</strong>: 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.</li>
<li class="li"><strong class="ph b">Reference guide</strong>: 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. </li>
</ul></div>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic concept nested0" aria-labelledby="ariaid-title10" id="concept_fqm_rv4_k4">
<h1 class="title topictitle1" id="ariaid-title10">Copyright Notice</h1>
<div class="body conbody"><p class="shortdesc">Copyright © 2023 Media5 Corporation.</p>
<p class="p">This document contains information that is proprietary to Media5 Corporation.</p>
<p class="p">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.</p>
<p class="p">This publication cannot be reproduced, neither in whole nor in part, in any form whatsoever,
without written prior approval by Media5 Corporation.</p>
<p class="p">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.</p>
</div>
</article></article></main></body></html> | 