Current Publication | x
Close

Call Detail Records

The Polycom RealPresence DMA system generates call detail records (CDRs) for all calls and conferences, which you can download.

After you unzip the download file, you can open the two CSV files it contains (one for calls and one for conferences) with Microsoft Excel or another spreadsheet application. The CSV files contain a line for each call or conference that ended during the selected time frame.

The ZIP file also includes a text file that contains a single line specifying:

The number of calls in the call CDR file.

The number conferences in the conference CDR file.

The clusters whose calls and conferences are included in the CDR file.

The clusters whose calls and conferences are excluded from the CDR file because those clusters were not reachable when the CDR export was generated.

 

Caution: Only one CDR should be generated at a time. If you run a client application that issues API calls to automatically generate and download CDRs at the same time that you manually attempt to generate and download a CDR, you or the client application may receive errors.

Export CDR Data

From the Call History or Conference History page, you can use the Export CDR Data command to download call detail records for the time period you specify.

To export CDRs:

1 Go to Reports > Call History (or Conference History).

2 Under Actions, click Export CDR Data.

3 In the Export Time Frame dialog, set the Calls and conferences ending after date and time and the Calls and conferences ending before date and time as the parameters for your CDR data query.

The defaults provide all CDR data for the current day. Times and dates are in the time zone of your browser.

4 Click OK.

The system displays the progress as it gathers the information needed to construct the CDR data files.

5 When the Exporting CDR Data dialog displays Data has been prepared and is ready to be downloaded, click Download to select a location for the downloaded file. The default filename is cdrExport.zip, but you can rename it.

6 Choose a path and filename for the CDR file and click Save.

The Exporting CDR Data dialog shows the progress.

7 When the download is complete, click Close.

Call Record Layouts

Times and dates in the CDR file are expressed in the time zone of the RealPresence DMA system that created the CDR export, with the GMT offset shown at the end. Note that if a conference spans a daylight savings time change, the offset for endTime will be different from the offset for startTime.

The following table describes the fields in the call detail records.

Field

Description

version
Changes each time the format of CDRs changes.
type
CALL
callType
One of the following:

PT-PT

VMR

VEQ

VSC-hunt group

VSC-[uncond fwd | fwd busy | fwd no answer]

VMR-subscribe only

VMR-Lync AVMCU

callUuid
Unique identifier for the call.
dialin
If this is point-to-point or a VMR dial-in call, TRUE. Otherwise, FALSE.
startTime
YYYY-MM-DDTHH:MM:SS.FFF[+|-|Z][HH:MM]
(ISO 8601 syntax, where FFF is milliseconds and Z is zero offset)
This is when call signaling reached the RealPresence DMA system, not when media started. If multiple call records, the start of this segment of the call.
endTime
YYYY-MM-DDTHH:MM:SS.FFF[+|-|Z][HH:MM]
(ISO 8601 syntax, where FFF is milliseconds and Z is zero offset)
This is when the RealPresence DMA system’s involvement with the call ended, not when media ended. If multiple call records, the end of this segment of the call.
origEndpoint
The originating endpoint’s display name, name, alias, or IP address (in that order of preference), depending on what it provided in the call signaling. If the originator is an MCU, the MCU name.
dialString
Initial dial string as supplied by the originator. If multiple call records, this value is the same across all segments of the call.
destEndpoint
The destination endpoint’s display name, name, alias, or IP address (in that order of preference), depending on what it provided in the call signaling. If the destination is an MCU, the MCU name; if a VSC, the VSC value (not including the VSC character).
origSignalType
One of the following:

h323

sip

destSignalType
One of the following:

h323

sip

refConfUUID
If VMR call, confUUID of the associated conference.
lastForwardEndpoint
If call forwarding, endpoint that forwarded call to the final destination endpoint.
cause
Cause value for call termination or termination of this CDR. This may not be the end of the call.
causeSource
Source of the termination of the call record. Indicates which participant requested call disconnect:

originator

destination

callserver

bitRate
Bit rate for call, in kbps. If the bit rate changes during the call, this is a list of bit rate values separated by plus signs (+). For instance:

1024+768+384 

classOfService
Class of service for the call:

Gold

Silver

Bronze

ingressCluster
The RealPresence DMA cluster of the originating endpoint or entry point from a neighbor or SBC.
egressCluster
The RealPresence DMA cluster of the destination endpoint or exit point to a neighbor or SBC.
VMRCluster
The RealPresence DMA cluster handling the VMR, or blank if not a VMR call.
VEQCluster
The RealPresence DMA cluster handling the VEQ, or blank if no VEQ.
userRole
If VMR call, the role of the caller in conference:

PARTICIPANT

CHAIRPERSON (entered passcode)

Null if not VMR call.
userDataA
The value from the User pass-through to CDR field of the user associated with the endpoint. For point-to-point calls, this is the user associated with the endpoint that started this call.
userDataB
For VMR calls, the value from the Conference room pass-through to CDR field of the conference room (VMR) to which the call connected.
For point-to-point calls, the value from the User pass-through to CDR field of the user associated with the endpoint that received this call.
userDataC
For VMR calls, the dial-out participant pass-through value provided via the API, if any.
For point-to-point calls, not currently used.
userDataD
Not currently used.
userDataE
Not currently used.
failureSignalingCode
For SIP calls, the SIP code and reason, separated by a colon, that the call was disconnected. For instance:

486:BUSY HERE 

origModel
The hardware model of the originating device, if available from the device’s registration or other signaling.
origVersion
The software version of the originating device, if available from the device’s registration or other signaling.
destModel
The hardware model of the destination device, if available from the device’s registration or other signaling.
destVersion
The software version of the destination device, if available from the device’s registration or other signaling.
displays
For an immersive telepresence room, the number of screens the room has. For a Polycom SIP ITP call, this is determined from the system name; for a Polycom or Cisco TIP call, it’s the x-cisco-multiple-screen parameter value.
For all other calls, the value is 1.
Note: If a Polycom ITP room doesn’t follow the ITP naming convention, this field may contain inaccurate information.
minVideoResolution
The minimum vertical resolution used on the video channel, followed by the minimum frame rate while at the minimum resolution, as reported by the MCU at the end of the call. For instance:

480p15 

Zero (0) if the call was audio only.
Available only for AVC calls using SIP or TIP signaling to a version 8.1 or newer hardware-based Polycom MCU with MPMx cards. Otherwise, blank.
maxVideoResolution
The maximum vertical resolution used on the video channel, followed by the maximum frame rate while at the maximum resolution, as reported by the MCU at the end of the call. For instance:

720p30 

Zero (0) if the call was audio only.
Available only for AVC calls using SIP or TIP signaling to a version 8.1 or newer hardware-based Polycom MCU with MPMx cards. Otherwise, blank.
videoPeakJitter
The peak jitter (in milliseconds) on the video channel. Zero (0) if the call was audio only.
Available only for AVC calls using SIP or TIP signaling to a version 8.1 or newer hardware-based Polycom MCU with MPMx cards. Otherwise, blank.
videoTotalPackets
The total number of packets sent on the video channel. Zero (0) if the call was audio only.
Available only for AVC calls using SIP or TIP signaling to a version 8.1 or newer hardware-based Polycom MCU with MPMx cards. Otherwise, blank.
videoTotalLostPackets
The number of packets lost on the video channel. Zero (0) if the call was audio only.
Available only for AVC calls using SIP or TIP signaling to a version 8.1 or newer hardware-based Polycom MCU with MPMx cards. Otherwise, blank.
minContentResolution
The minimum vertical resolution used on the content channel, followed by the minimum frame rate while at the minimum resolution, as reported by the MCU at the end of the call. Zero (0) if content was not shared.
Available only for AVC calls using SIP or TIP signaling to a version 8.1 or newer hardware-based Polycom MCU with MPMx cards. Otherwise, blank.
maxContentResolution
The maximum vertical resolution used on the content channel, followed by the maximum frame rate while at the maximum resolution, as reported by the MCU at the end of the call. Zero (0) if content was not shared.
Available only for AVC calls using SIP or TIP signaling to a version 8.1 or newer hardware-based Polycom MCU with MPMx cards. Otherwise, blank.
contentPeakJitter
The peak jitter (in milliseconds) on the content channel. Zero (0) if content was not shared.
Available only for AVC calls using SIP or TIP signaling to a version 8.1 or newer hardware-based Polycom MCU with MPMx cards. Otherwise, blank.
contentTotalPackets
The total number of packets sent on the content channel. Zero (0) if content was not shared.
Available only for AVC calls using SIP or TIP signaling to a version 8.1 or newer hardware-based Polycom MCU with MPMx cards. Otherwise, blank.
contentTotalLostPackets 
The number of packets lost on the content channel. Zero (0) if content was not shared.
Available only for AVC calls using SIP or TIP signaling to a version 8.1 or newer hardware-based Polycom MCU with MPMx cards. Otherwise, blank.
origSignalingId
For SIP point-to-point or VMR calls (dialin=TRUE), the complete From header of the INVITE received from the endpoint.
For VMR SIP dial-outs (dialin=FALSE), the To header sent by the RealPresence DMA system to the MCU. Otherwise, blank.
origCallId
The SIP or H.323 call ID of the call between the originating endpoint and the RealPresence DMA system. For VMR dial-outs, the call ID of the call between the RealPresence DMA system and the MCU.
destCallId
The SIP or H.323 call ID of the call between the destination endpoint and the RealPresence DMA system. For calls to a VMR, the call ID of the call between the RealPresence DMA system and the MCU.
chairPasscode
The configured chairperson passcode for the conference room. Blank if no passcode was configured at the time of the conference.
confRequiresChair
TRUE if the conference template used for the conference has the Conference requires chairperson flag enabled. Otherwise, FALSE.
termConfAfterChairDrops
TRUE if the conference template used for the conference has the Terminate conference after chairperson drops flag enabled. Otherwise, FALSE.
charJoinTime
The time the first chairperson joined the conference. If no chairperson joined the conference, blank.

Conference Record Layouts

Times and dates in the CDR file are expressed in the time zone of the RealPresence DMA cluster that created the CDR export, with the GMT offset shown at the end. Note that if a conference spans a daylight savings time change, the offset for endTime will be different from the offset for startTime.

The following table describes the fields in the conference records.

Field

Description

version
Changes each time the format of CDRs changes.
type
CONF
confType
One of the following:

PCO — for Polycom Conferencing for Outlook (calendared) conferences

LYNC — for Lync conferences

AD-HOC — for all other conferences

cluster
The RealPresence DMA cluster serving the VMR.
confUUID
Unique identifier for the conference.
startTime
YYYY-MM-DDTHH:MM:SS.FFF[+|-|Z][HH:MM]
(ISO 8601 syntax, where FFF is milliseconds and Z is zero offset)
This is when the first participant joined the conference.
endTime
YYYY-MM-DDTHH:MM:SS.FFF[+|-|Z][HH:MM]
(ISO 8601 syntax, where FFF is milliseconds and Z is zero offset)
This is when the last participant left the conference.
userID
Conference room (VMR) owner, shown as:

domain\user

Domain is LOCAL for non-AD users.
If this is a Lync conference, this field is empty.
roomID
Conference room (VMR) number or Lync conference ID.
partCount
Maximum number of concurrent calls in the conference (high water mark).
Doesn’t include audio-only IVR dial-outs or participants dialed directly into or out from the MCU without going through the RealPresence DMA system.
The following are counted as a single participant:

A Polycom or Cisco immersive telepresence room using Cisco TIP signaling.

A Polycom ITP room using SIP signaling and the prescribed naming convention. 

classOfService
Class of service for the call:

Gold

Silver

Bronze

userDataA
The value from the User pass-through to CDR field of the user associated with the conference room (VMR).
userDataB
The value from the Conference room pass-through to CDR field of the conference room (VMR).
userDataC
The conference ID provided via the API, if any.
maxResourcesUsed
The maximum number of video and voice ports used for the conference, reported as follows:

video: <video port count> voice: <voice port count>

Available only for conferences on a RealPresence Collaboration Server or RMX MCU that provides this information.
Note: Voice calls may use video ports if voice ports aren’t available.
Note: The RealPresence DMA system reports port numbers based on resource usage for CIF calls. Version 8.1 and later Polycom MCUs report port numbers based on resource usage for HD720p30 calls. In general, 3 CIF = 1 HD720p30, but it varies depending on bridge/card type and other factors.
See your Polycom RealPresence Collaboration Server or RMX system documentation for more detailed information about resource usage.
mcuNameList
The MCU(s) used by the conference. If there is more than one (due to cascading or an MCU failover), this is a comma-separated list enclosed in quotes.
If the conference was cascaded, the hub MCU is listed first. If there was a failover, the original MCU is listed first.
confDisplayNameList
The conference display name of the conference as it appears on the MCU. If there is more than one MCU (due to cascading or an MCU failover), this is a comma-separated list enclosed in quotes.
If the conference was cascaded, the display name from the hub MCU is listed first. If there was a failover, the display name from the original MCU is listed first.
This information is included to support the correlation of RealPresence DMA CDRs with CDRs on the MCU. Polycom MCUs use the conference display name as part of the name of the CDR file for a conference.
chairPasscode
The configured chairperson passcode for the conference room. Blank if no passcode was configured at the time of the conference.
confRequiresChair
TRUE if the conference template used for the conference has the Conference requires chairperson check box enabled. Otherwise, FALSE.
termConfAfterChairDrops
TRUE if the conference template used for the conference has the Terminate conference after chairperson drops check box enabled. Otherwise, FALSE.
charJoinTime
The time that the first chairperson joined the conference. If no chairperson joined the conference, blank.

Related Topics

Machine Translation

You are cautioned that the translation of this document is generated by a machine; therefore, the translated document may have errors and be inconsistent with the original English language version of the document.

The English language version of this document shall be considered the governing document related to the Polycom product.

If there is any contradiction between the English language version of the document and the translated version of the document, the English language version of the document shall take precedence.

The translation is provided for your convenience only. Neither Google nor Polycom shall be responsible for translated content or for the performance of the translation tool. If you require further assistance on non-translation issues, please contact Polycom support.

Translated documents are not available in PDF format.