Cisco Unified Communications Manager Call Detail Records Administration Guide, Release 9.0(1)
Cisco call detail records field descriptions
Downloads: This chapterpdf (PDF - 1.32MB) The complete bookPDF (PDF - 4.91MB) | Feedback

Cisco call detail records field descriptions

Cisco call detail records field descriptions

This chapter defines all fields in the current CDRs in the order in which they appear in the CDR.

CDR field descriptions

The following table describes all fields in the current CDRs in the order in which they appear.

Table 1 CDR Field Descriptions

Field Name

Range of Values

Description

cdrRecordType

0, 1, 2

This field defines the type of record. The following valid values apply:

  • 0—Start call detail record (not used)
  • 1—End call detail record (CDR)
  • 2—CMR record

Default - For CDRs, this field always remains 1.

globalCallID_callManagerId

Positive Integer

This field designates a unique Cisco Unified Communications Manager identity.

The Global Call ID comprises two fields: globalCallID_callId globalCallID_callManagerId

All records that are associated with a standard call have the same Global Call ID in them.

Default - Ensure this field always is populated.

globalCallID_callId

Positive Integer

This field designates a unique call identity value that is assigned to each call. The system allocates this identifier independently on each call server. Values get chosen sequentially when a call begins. A value gets assigned for each call, successful or unsuccessful. When Cisco Unified Communications Manager restarts, it checks the file for the current globalCallID_callId number and assigns the next 1000th number to the next GlobalCallID_callId.

The Global Call ID consists of two fields: globalCallID_callId globalCallID_callManagerId

All records that are associated with a standard call have the same Global Call ID in them.

Note   

For Cisco Unified Communications Manager Release 5.x and later releases, the value in the GlobalCallId CDR field survives over Cisco Unified Communications Manager restarts. In Release 4.x and earlier releases, even though the GlobalCallId field is time-based, the field gets reused under conditions of heavy traffic. Because of this behavior, problems can occur with customer billing applications and the ability of CAR to correlate CMRs with CDRs and to correlate conference call CDRs. For Release 5.x and later releases, GlobalCallId redesign ensures the field retains a unique value, at least for a certain number of days. Now, the last used globalCallId_callId value gets written to disk periodically (for every x number of calls). The value gets retrieved after a Cisco Unified Communications Manager restart, and the new globalCallId_callId value begins with this number plus x.

Default - Ensure this field always is populated.

origLegCallIdentifier

Positive Integer

This field identifies the originating leg of a call. Be aware that this value is unique within a cluster. If the leg of a call persists across several sub-calls, and consequently several CDRs (as during a call transfer), this value remains constant.

Default - Ensure this field always is populated.

dateTimeOrigination

Integer

This field identifies the date and time when the user goes off hook or the date and time that the H.323 SETUP message is received for an incoming call. The time gets stored as UTC.

Default - Ensure this field always is populated.

origNodeId

Positive Integer

This field identifies the server, or node within a cluster, to which the originator of the call is registered at the time that the call is made.

Default - Ensure this field always is populated.

origSpan

0, Positive Integer

For calls that originate at a gateway, this field indicates the B-channel number of the T1, PRI, or BRI trunk where the call originates, or a zero value for FXS or FXO trunks.

For H.323 gateways, the span number remains unknown, and this field contains the call leg ID of the originator.

For calls that did not originate at a gateway, the value specifies zero.

Default - This field gets populated based on these rules.

origIpAddr

Integer

This field identifies the v4 IP address of the device that originates the call signaling.

For Cisco Unified IP Phones, this field specifies the v4 address of the phone.

For PSTN calls, this field specifies the v4 address of the H.323 gateway.

For intercluster calls, this field specifies the v4 address of the remote Cisco Unified Communications Manager.

Default - 0. If the v4 address does not exist for the originating device, this field equals 0. This field gets populated based on these rules.

callingPartyNumber

Text String

This field specifies a numeric string of up to 25 characters that indicates the calling party number if the calling party is identified with a directory number.

If the calling party uses a blended address in the identity headers, this field contains the directory number portion of the blended address.

For calls that originate at a Cisco Unified IP Phone, this field shows the extension number of the line that is used.

For incoming H.323 calls, this field specifies the value that is received in the Calling Party Number field in the Setup message. This field reflects any translations that are applied to the Calling Party Number before it arrives at the Cisco Unified Communications Manager (such as translations at the gateway).

For server calls, where Cisco Unified Communications Manager originates a half call without a calling party, this field may remain empty.

CallingPartyNumber could contain a SIP URI.

Default - This field gets populated based on these rules.

callingPartyUnicodeLoginUserID

Unicode – UTF_8

This field specifies the calling party login user ID. The format of this field specifies UTF_8.

Default - Empty string " ". If the user ID does not exist, this field stays empty.

origCause_location

0 to 15

For clearing causes that are received over ISDN signaling links, this field specifies the Location field that is indicated in the ISDN release message. See topics related to call termination cause codes for a list of the valid values per Q.850.

For clearing causes that are created internally by the Cisco Unified Communications Manager, this value specifies zero.

Default - 0

origCause_value

0 to 129

For calls that are cleared by the originating party, this field reflects the reason for clearance.

Cisco Unified Communications Manager currently uses the Q.850 codes and some Cisco Unified Communications Manager defined codes. See topics related to call termination cause codes for a listing.

For calls that are cleared by the terminating party, this field specifies zero.

In addition to the standard values that are described in Q.850, when a call is split by a feature (transfer/conference), the CDR terminates, and this field gets set to 393216. This represents a proprietary value for this field.

Default - 0

origPrecedenceLevel

0 to 4

For MLPP, each call leg includes a precedence level. This field represents the precedence level of the original leg.

  • Precedence 0 = FLASH OVERRIDE/ EXECUTIVE OVERRIDE
  • Precedence 1 = FLASH
  • Precedence 2 = IMMEDIATE
  • Precedence 3 = PRIORITY
  • Precedence 4 = ROUTINE

Default - 4

origMediaTransportAddress_IP

0, Integer

This field identifies the v4 IP address of the device that originates the media for the call.

For Cisco Unified IP Phones, this field specifies the v4 address of the phone.

For PSTN calls, this field specifies the v4 address of the H.323 gateway.

For intercluster calls, this field specifies the v4 address of the remote phone.

Default - 0. If media is not established or the address is not v4, this field equals 0.

origMediaTransportAddress_Port

0, Positive Integer

This field identifies the IP port number that is associated with the OrigMediaTransportAddress_IP field.

Default - 0. If media is not established, this field stays 0.

origMediaCap_payloadCapability

0, Positive Integer

This field identifies the codec type that the originator uses to transmit media.

Cisco Unified Communications Manager currently uses the following payload capability values: 0, 1-16, 18-20, 25, 32, 33, 81-86. See topics related to codec types for a listing of the valid values.

Default - 0. If media is not established, this field stays 0.

origMediaCap_maxFramesPerPacket

0, Positive Integer

This field identifies the number of milliseconds of data per packet that the originating party sends. This field normally gets set to 10, 20, or 30 for G.729 or G.711 codecs, but the field can store any nonzero value.

Default - 0. If media is not established, this field stays 0.

origMediaCap_g723BitRate

0

This field is not used in the current release of Cisco Unified Communications Manager.

Default - This field will remain 0.

origVideoCap_Codec

0,

100 = H.261,

101 = H.263,

103 = H.264

This field identifies the codec type that the originator uses to transmit video (H.261, H.263, or H.264.)

Default - 0. If media is not established, this field stays 0.

origVideoCap_Bandwidth

0, Positive Integer

This field identifies the bandwidth that is measured in units of kbps.

Default - 0. If media is not established, this field stays 0.

origVideoCap_Resolution

0,

1 = SQCIF,

2 = QCIF,

3 = CIF,

4 = CIF4,

5 = CIF16

6 = H263 custom resolution

7 = W360P

8 = VGA

9 = W448P

10 = HD720P

11 = HD1080P

12 = CIF2

This field indicates the transmitting resolution. In the case of H.264 codec or SIP device, this field refers to the max transmitting resolution the device can transmit for this call.

Default - 0. If media is not established, this field stays 0.

origVideoTransportAddress_IP

0, Integer

This field identifies the v4 IP address of the device that originates the call.

Default - 0. If media is not established or the address is not v4, this field stays 0.

origVideoTransportAddress_Port

0, Positive Integer

This field identifies the video RTP port that is associated with the origVideoTransportAddress_IP field.

Default - 0. If media is not established, this field stays 0.

origRSVPAudioStat

0 to 5

This field gives the status of the RSVP audio reservation from originator to terminator.

0 – No reservation.

1 – RSVP Reservation Failure condition at call setup or feature invocation.

2 – RSVP Reservation Success condition at call setup or feature invocation.

3 – RSVP Reservation No Response (RSVP Agent) condition at call setup or feature invocation.

4 – RSVP Mid Call Failure Preempted condition (preempted after call setup).

5 – RSVP Mid Call Failure Lost Bandwidth condition (includes all mid-call failures except MLPP preemption).

Default – 0

origRSVPVideoStat

0 to 5

This field gives the status of the RSVP video reservation from originator to terminator.

0 – No reservation.

1 – RSVP Reservation Failure condition at call setup or feature invocation.

2 – RSVP Reservation Success condition at call setup or feature invocation.

3 – RSVP Reservation No Response (RSVP Agent) condition at call setup or feature invocation.

4 – RSVP MID Call Failure Preempted condition (preempted after call setup).

5 – RSVP MID Call Failure Lost Bandwidth condition (includes all mid-call failures except MLPP preemption).

Default – 0

destLegCallIdentifier

0, Positive Integer

This field identifies the terminating leg of a call. This value remains unique within a cluster. If the leg of a call persists across several sub-calls and, consequently, several CDRs (as during a call transfer), this value remains constant.

Default - 0. If the destination cannot be reached, this field stays 0.

destNodeId

0, Positive Integer

This field identifies the location, or node within a cluster, to which the terminating party of the call is registered at the time that the call is made.

Default - 0. If the destination cannot be reached, this field stays 0.

destSpan

0, Positive integer

For calls that are received at a gateway, this field indicates the B channel number of the T1, PRI, or BRI trunk where the call is received, or a zero value for FXS or FXO trunks.

For H.323 gateways, the span number remains unknown, and this field contains the call leg ID of the destination.

For calls not terminating at a gateway, the value specifies zero.

Default - 0. If the destination cannot be reached, this field stays 0.

destIpAddr

0, Integer

This field identifies the v4 IP address of the device that terminates the call signaling.

For Cisco Unified IP Phones, this field specifies the v4 address of the phone.

For PSTN calls, this field specifies the v4 address of the H.323 gateway.

For intercluster calls, this field specifies the v4 address of the remote Cisco Unified Communications Manager.

Default - 0. If the destination cannot be reached, this field stays 0. If the v4 address does not exist for this device, the field equals 0.

originalCalledPartyNumber

Text String

This field specifies the number to which the original call was presented, prior to any call forwarding. If translation rules are configured, this number reflects the called number after the translations have been applied.

If a blended address is used for the called party, this field specifies the directory number portion of the blended address.

This field represents a numeric string of up to 48 characters that can be either digits or a SIP URL.

Default - Empty string " ". If destination cannot be reached, or if the called party number is a directory URI, this field stays empty.

finalCalledPartyNumber

Text String

This field specifies the phone number to which the call finally gets presented, until it is answered or rings out. If no forwarding occurs, this number shows the same number as the originalCalledPartyNumber.

If the call finally gets presented to a directory URI, the field remains empty.

If a blended address is used, this field specifies the directory number portion of the blended address

For calls to a conference bridge, this field contains the actual identifier of the conference bridge, which is an alphanumeric string (for example, b0019901001).

This field represents an alphanumeric string that can be either digits or a SIP URL.

Default - Empty string " ". If destination cannot be reached, this field stays empty.

finalCalledPartyUnicodeLoginUserID

Unicode – UTF_8

The final called party field specifies the login user ID. The format of this field specifies UTF_8.

Default - Empty string " ". If the user ID does not exist, this field stays empty.

destCause_location

0 to 15

For clearing causes that are received over ISDN signaling links, the ISDN release message indicates this location field. See topics related to call termination cause codes for a listing of the valid values per Q.850.

For clearing causes that Cisco Unified Communications Manager creates internally, this value equals zero.

Default - 0. If the destination cannot be reached, this field stays 0.

destCause_value

0 to 129

For calls that the destination party cleared, this field reflects the reason for the clearance. See topics related to call termination cause codes for a listing of the valid values per Q.850.

For calls that the originating party clears, this field stays zero.

In addition to the standard values that are described in Q.850, when a call gets split by a feature (transfer/conference), the CDR terminates, and this field gets set to 393216. This represents a proprietary value for this field.

Default - 0. If the destination cannot be reached, this field stays 0.

destPrecedenceLevel

0 to 4

For MLPP, each call leg has a precedence level. This field represents the destination legs precedence level.

  • Precedence 0 = FLASH OVERRIDE
  • Precedence 1 = FLASH
  • Precedence 2 = IMMEDIATE
  • Precedence 3 = PRIORITY
  • Precedence 4 = ROUTINE

Default - 4

destMediaTransportAddress_IP

0, Integer

This field identifies the v4 IP address of the device that terminates the media for the call.

For Cisco Unified IP Phones, this field designates the v4 address of the phone.

For PSTN calls, this field designates the v4 address of the H.323 gateway.

For intercluster calls, this field shows the v4 address of the remote phone.

Default - 0. If the destination cannot be reached or the IP address of the destination is not v4, this field stays 0.

destMediaTransportAddress_Port

0, Positive Integer

This field identifies the IP port number that is associated with the DestMediaTransportAddress_IP field.

Default - 0. If the destination cannot be reached, this field stays 0.

destMediaCap_payloadCapability

0, Positive Integer

This field identifies the codec type that the terminating party uses to transmit media.

Cisco Unified Communications Manager currently uses the following payload capability values: 0, 1-16, 18-20, 25, 32, 33, 81-86. See topics related to codec types for a listing of the valid values.

Default - 0. If the destination cannot be reached, this field stays 0.

destMediaCap_maxFramesPerPacket

0, Positive Integer

This field identifies the number of milliseconds of data per packet that the terminating party of the call sends. This field normally gets set to 10, 20, or 30 for G.729 or G.711 codecs but can store any nonzero value.

This field can specify zero if the media is never established.

Default - 0. If the destination cannot be reached, this field stays 0.

destMediaCap_g723BitRate

0

This field is not used in the current release of Cisco Unified Communications Manager.

Default - This field stays 0.

destVideoCap_Codec

0,

100 = H.261,

101 = H.263,

103 = H.264

This field identifies the codec type that the terminating party uses to transmit video (H.261, H.263, or H.264).

Default - 0. If the destination cannot be reached, this field stays 0.

destVideoCap_Bandwidth

0, Positive Integer

This field identifies the bandwidth, and is measured in units of kbps.

Default - 0. If the destination cannot be reached, this field stays 0.

destVideoCap_Resolution

0,

1 = SQCIF,

2 = QCIF,

3 = CIF,

4 = CIF4,

5 = CIF16

6 = H263 custom resolution

7 = W360P

8 = VGA

9 = W448P

10 = HD720P

11 = HD1080P

12 = CIF2

This field indicates the transmitting resolution. In the case of H.264 codec or SIP device, this field refers to the max transmitting resolution the device can transmit for this call.

Default - 0. If media is not established, this field stays 0.

destVideoTransportAddress _IP

0, Integer

This field identifies the v4 IP address of the device that receives the call.

Default - 0. If the destination cannot be reached or the IP address of the destination is not v4, this field stays 0.

destVideoTransportAddress_Port

0, Positive Integer

This field identifies the video RTP port that is associated with the destVideoTransportAddress_IP field.

Default - 0. If the destination cannot be reached, this field stays 0.

destRSVPAudioStat

0 - 5

This field designates the status of the RSVP audio reservation from terminator to originator.

0 – No reservation.

1 – RSVP Reservation Failure condition at call setup or feature invocation.

2 – RSVP Reservation Success condition at call setup or feature invocation.

3 – RSVP Reservation No Response (RSVP Agent) condition at call setup or feature invocation.

4 – RSVP Mid Call Failure Preempted condition (preempted after call setup).

5 – RSVP Mid Call Failure Lost Bandwidth condition (includes all mid call failures except MLPP preemption).

Default – 0

destRSVPVideoStat

0 - 5

This field designates the status of the RSVP video reservation from terminator to originator.

0 – No reservation.

1 – RSVP Reservation Failure condition at call setup or feature invocation.

2 – RSVP Reservation Success condition at call setup or feature invocation.

3 – RSVP Reservation No Response (RSVP Agent) condition at call setup or feature invocation.

4 – RSVP Mid Call Failure Preempted condition (preempted after call setup).

5 – RSVP Mid Call Failure Lost Bandwidth condition (includes all mid call failures except MLPP preemption).

Default – 0

dateTimeConnect

0, Integer

This field identifies the date and time that the call connects. The time gets stored as UTC. If the call is never answered, this value shows zero.

Default - 0. If the call is never connected, this field stays 0.

dateTimeDisconnect

Integer

This field identifies the date and time when the call is cleared. This field gets set even if the call never connects. The time gets stored as UTC.

Default - Ensure this field always is populated.

lastRedirectDn

Text String

This field specifies a numeric string of up to 25 characters. The numeric string can contain digits or a SIP URL.

For forwarded calls, this field specifies the phone number of the next to last hop before the call reaches its final destination. If only one hop occurs, this number matches the OriginalCalledPartyNumber.

If a blended address is used for call addressing, this field contains only the directory number portion of the blended address.

For calls that are not forwarded, this field matches the OriginalCalledPartyNumber and the FinalCalledPartyNumber.

For calls to a conference bridge, this field contains the actual identifier of the conference bridge, which is an alphanumeric string (for example, b0019901001).

Default - Empty string " ". If the call is never redirected, or if the next to last hop address is a directory URI, this field remains empty.

pkid

Text String

This field identifies a text string that the database uses internally to uniquely identify each row. This text string provides no meaning to the call itself.

Default - A unique ID should always populate this field.

originalCalledPartyNumberPartition

Text String

This field uniquely identifies the partition name that is associated with the OriginalCalledPartyNumber field because Cisco Unified Communications Manager supports multiple Cisco Unified IP Phones with the same extension number in different partitions.

For calls that egress through an H.323 gateway, this field uniquely specifies the partition name that is associated with the route pattern that points to the gateway.

Default - Empty string " ". If the original called party does not have a partition, this field remains empty.

callingPartyNumberPartition

Text String

This field uniquely identifies the partition name that is associated with the CallingPartyNumber field because Cisco Unified Communications Manager supports multiple Cisco Unified IP Phones with the same extension number in different partitions.

For calls that ingress through an H.323 gateway, this field remains blank.

Default - Empty string " ". If the original called party does not have a partition, this field remains empty.

finalCalledPartyNumberPartition

Text String

This field uniquely identifies the partition name that is associated with the FinalCalledPartyNumber field because Cisco Unified Communications Manager supports multiple Cisco Unified IP Phones with the same extension number in different partitions.

For calls that egress through an H.323 gateway, this field uniquely specifies the partition name that is associated with the route pattern that points to the gateway.

Default - Empty string " ". If the final called party does not have a partition, this field remains empty.

lastRedirectDnPartition

Text String

This field uniquely identifies the partition name that is associated with the LastRedirectDn field because Cisco Unified Communications Manager supports multiple Cisco Unified IP Phones with the same extension number in different partitions.

For calls that egress through an H.323 gateway, this field specifies the partition name that is associated with the route pattern that points to the gateway.

Default - Empty string " ". If the last redirecting Party does not have a partition or the call was never redirected, this field stays empty.

duration

0, Positive integer

This field identifies the difference between the Connect Time and Disconnect Time. This field specifies the time that the call remains connected, in seconds. This field remains zero if the call never connects or if it connects for less than 1 second.

Default - 0

origDeviceName

Text String

This field specifies the text string that identifies the name of the originating device.

Default - Ensure this field always is populated.

destDeviceName

Text String

This field specifies the text string that identifies the name of the destination device.

Default - Empty string" ". If the original device does not have a name, this field stays empty.

origCallTerminationOnBehalfOf

0, Positive Integer

This field specifies code that identifies why the originator was terminated.

For example, if the originator of the call hangs up the phone, the OnBehalfOf code shows "12" for Device. If the call terminates because of a transfer, the OnBehalfOf code shows "10" for Transfer.

See topics related to CDR field descriptions for a list of the codes. This release added new OnBehalfOf codes.

Default - 0

destCallTerminationOnBehalfOf

0, Positive Integer

This field specifies code that identifies why the destination was terminated.

For example, if the originator of the call hangs up the phone, the OnBehalfOf code shows "12" for Device. If the call terminates because of a transfer, the OnBehalfOf code shows "10" for Transfer.

See topics related to CDR field descriptions for a list of the codes. This release added new OnBehalfOf codes.

Default - 0

origCalledPartyRedirectOnBehalfOf

0, Positive Integer

This field specifies code that identifies the reason for redirection of the original called party.

For example, if the original called party was redirected because of a conference, the OnBehalfOf code specifies "4."

See topics related to CDR field descriptions for a list of the codes. This release added new OnBehalfOf codes.

Default - 0

lastRedirectRedirectOnBehalfOf

0, Integer

This field specifies code that identifies the reason for redirection of the last redirected party.

For example, if the last redirected party was redirected on behalf of a conference, the OnBehalfOf code specifies "4."

See topics related to CDR field descriptions for a list of the codes. This release added new OnBehalfOf codes.

Default - 0

origCalledPartyRedirectReason

0, Integer

This field identifies the reason for a redirect of the original called party.

See topics related to redirect reason codes for a complete list of the codes.

Default - 0

lastRedirectRedirectReason

0, Integer

This field identifies the last redirect reason for redirection.

See topics related to redirect reason codes for a complete list of the codes.

Default - 0

destConversationID

0, Integer

This field specifies a unique identifier that is used to identify the parties of a conference call.

For conference chaining scenarios, the origConversationID and destConversationID fields identify which conferences are chained together.

Default - 0

globalCallId_ClusterId

Text String

This field specifies a unique ID that identifies a cluster of Cisco Unified Communications Managers.

The field is generated at installation and is not used by Cisco Unified Communications Manager. The fields globalCallId_ClusterId + globalCallId_CMId + globalCallId_CallId make up this unique key.

Default - This field should always be populated.

joinOnBehalfOf

0, Integer

This field specifies code that identifies the reason for a join.

For example, if the join takes place on behalf of a transfer, the OnBehalfOf code specifies "10."

See topics related to CDR field descriptions for a list of the codes.

Default - 0

Comment

Text String

This field allows features to add text to the CDRs. This text can describe details about the call.

For example, the following field flags malicious calls:

Tag—CallFlag

Value—MALICIOUS

Default - Empty string " ".

authCodeDescription

Text String

This field provides a description of the FAC.

Default - Empty string " " or null.

authorizationLevel

0, Integer

This field displays the level of the FAC.

Default - 0

clientMatterCode

Text String

Before the system extends a call, the user enters a client matter code that can be used for assigning account or billing codes to calls. This field displays the client matter code.

Default - Empty string " " or null.

origDTMFMethod

0, Positive Integer

This field displays the DTMF method that the originator uses.

0 - No DTMF - Use ANY matched DTMF.

1 - OOB - Use OOB if endpoints behind SIPTrunk support it.

2 - 2833 - Use RFC2833 if endpoints behind SIPTrunk support it.

3 - OOB and 2833 - Use both KPML and RFC2833 if endpoints behind SIPTrunk can support both.

4 - Unknown

Default - 0 (No preference)

destDTMFMethod

0, Positive Integer

This field displays the DTMF method that the destination uses.

0 - No DTMF - Use ANY matched DTMF.1 - OOB - Use OOB if endpoints behind SIPTrunk support it.2 - 2833 - Use RFC2833 if endpoints behind SIPTrunk support it.3 - OOB and 2833 - Use both KPML and RFC2833 if endpoints behind SIPTrunk can support both.4 - Unknown.

Default - 0 (No preference)

callSecuredStatus

0, Positive Integer

This field displays the highest security status that is reached during a call. For example, if the call is originally unsecured, then later the call changes to secured, the CDR contains 1 for "Secured" even though different portions of the call have different status values.

0 - Non-secured

1 - Authenticated (not encrypted)

2 - Secured (encrypted)

Default - 0 (Non-secured)

origConversationID

Integer

This field identifies the conference ID that is associated with the originating leg of the call. In most cases, this field equals 0.

For conference chaining scenarios, the origConversationID and destConversationID fields identify which conferences are chained together.

Default - 0

origMediaCap_Bandwidth

0, Positive Integer

This field displays the media bandwidth that is used at the origination of the call.

Default - 0

destMediaCap_Bandwidth

0, Positive Integer

This field displays the media bandwidth that is used at the destination of the call.

Default - 0

authorizationCodeValue

Text String

This field displays the Forced Authorization Code (FAC) that is associated with the call.

Default - Empty string " " or null.

outpulsedCallingPartyNumber

Text String

This field comprises an alphanumeric string of up to 50 characters.

The calling party number gets outpulsed from the device. This field gets populated only when normalization or localization takes place at the device.

Default - Empty string " " or null.

outpulsedCalledPartyNumber

Text String

This field comprises an alphanumeric string of up to 50 characters.

The called party number gets outpulsed from the device. This field gets populated only when normalization or localization takes place at the device.

Default - Empty string " "or null.

origIpv4v6Addr

Text string

This field comprises an alphanumeric string of up to 64 characters.

This field identifies the IP address of the device that originates the call signalling. The field can be either IPv4 or IPv6 format depending on the type of IP address that gets used for the call.

For Cisco Unified IP Phones, this field is the address of the Cisco Unified IP Phone. For PSTN calls, this field is the address of the gateway. For intercluster calls, this field is the address of the remote Cisco Unified Communications Manager.

The IP address is either in dotted decimal format or in colon separated hexadecimal format.

Default - The IP address of the originating device as reported by the device or used for the call after media negotiation.

destIpv4v6Addr

Text string

This field comprises an alphanumeric string of up to 64 characters.

This field identifies the IP address of the device that terminates the call signalling. The field can be either in IPv4 or IPv6 format depending upon the type of IP address that gets used for the call.

For Cisco Unified IP Phones, this field is the address of the Cisco Unified IP Phone. For PSTN calls, this field is the address of the gateway. For intercluster calls, this field is the address of the remote Cisco Unified Communications Manager.

The IP address is either in dotted decimal format or in colon separated hexadecimal format.

Default - Empty String " " or null.  If the destination does not get reached, this field stays empty.

origVideoCap_Codec_Channel2

0,

100 = H.261,

101 = H.263,

103 = H.264,

This field identifies the codec type that the originator uses to transmit video (H.261, H.263, or H.264) for the second video channel.

Default - 0. If media does not get established, this field displays 0. Also, if H.239 and BFCP are not supported for this call, this field displays 0

origVideoCap_Bandwidth_Channel2

0, Positive integer

This field identifies the bandwidth measured in units of kbps for the second video channel.

Default - 0. If media does not get established, this field displays 0. Also, if H.239 and BFCP are not supported for this call, this field displays 0.

origVideoCap_Resolution_Channel2

0,

1 = SQCIF,

2 = QCIF,

3 = CIF,

4 = CIF4,

5 = CIF16

6 = H263 custom resolution

7 = W360P

8 = VGA

9 = W448P

10 = HD720P

11 = HD1080P

12 = CIF2

This field indicates the transmitting resolution for the second video channel. In the case of H.264 codec or SIP device, this field refers to the maximum transmitting resolution the device can transmit for this call.

Default - 0. If media is not established, this field stays 0. Also, if H.239 and BFCP are not supported for this call, this field displays 0.

origVideoTransportAddress_IP_Channel2

0, Integer

This field identifies the v4 IP address of the device that originates the call for the second video channel.

Default - 0. If media does not get established, this field displays 0. Also, if H.239 and BFCP are not supported for this call, this field displays 0.

origVideoTransportAddress_Port_Channel2

0, Positive integer

This field identifies the video RTP port associated with the origH239VideoTransportAddress_IP field for the second video channel.

Default - 0. If media does not get established, this field displays 0. Also, if H.239 and BFCP are not supported for this call, this field displays 0.

origVideoChannel_Role_Channel2

0 = Presentation role,

1 = Live role,

Positive integer

This field identifies the H.239 video channel role of the device that originates.

Default - 0. If media does not get established, this field displays 0. Also, if H.239 is not supported, this field displays 0.

destVideoCap_Codec_Channel2

0,

100 = H.261,

101 = H.263,

103 = H.264

This field identifies the codec type that the terminating party uses to transmit video (H.261, H.263, or H.264) for the second video channel.

Default - 0. If the destination cannot be reached, this field stays 0. Also, if H.239 and BFCP are not supported for this call, this field displays 0.

destVideoCap_Bandwidth_Channel2

0, Positive integer

This field identifies the bandwidth measured in units of kbps for the second video channel.

Default - 0. If media does not get established, this field displays 0. Also, if H.239 and BFCP are not supported for this call, this field displays 0.

destVideoCap_Resolution_Channel2

0,

1 = SQCIF,

2 = QCIF,

3 = CIF,

4 = CIF4,

5 = CIF16

6 = H263 custom resolution

7 = W360P

8 = VGA

9 = W448P

10 = HD720P

11 = HD1080P

12 = CIF2

This field indicates the transmitting resolution for the second video channel. In the case of H.264 codec or SIP device, this field refers to the maximum transmitting resolution the device can transmit for this call.

Default - 0. If media is not established, this field stays 0. Also, if H.239 and BFCP are not supported for this call, this field displays 0.

destVideoTransportAddress_IP_Channel2

0, Integer

This field identifies the v4 IP address of the device that receives the call.

Default - 0. If media does not get established, this field displays 0. Also, if H.239 and BFCP are not supported for this call, this field displays 0.

destVideoTransportAddress_Port_Channel2

0, Positive integer

This field identifies the video RTP port associated with the destH239VideoTransportAddress_IP field.

Default - 0. If media does not get established, this field displays 0. Also, if H.239 and BFCP are not supported for this call, this field displays 0.

destVideoChannel_Role_Channel2

0 = Presentation role,

1 = Live role,

Positive integer

This field identifies the H.239 video channel role of the device that receives the call.

Default - 0. If media does not get established, this field displays 0. Also, if H.239 is not supported, this field displays 0.

IncomingProtocolID

0 = Unknown,

1 = SIP,

2 = H323,

3 = CTI/JTAPI,

4 = Q931,

Integer

This field identifies the protocol (SIP, H.323, CTI/JTAPI, or Q.931) used between Cisco Unified CM and the upstream voice product in the call path.

IncomingProtocolCallRef

Varchar(32)

This field identifies the globally unique call reference identification for the protocol. The value is received from the upstream voice product. The value is alpha–numeric and truncated to 32 characters.

OutgoingProtocolID

0 = Unknown,

1 = SIP,

2 = H323,

3 = CTI/JTAPI,

4 = Q931,

Integer

This field identifies the protocol (SIP, H.323, CTI/JTAPI, or Q.931) used between Cisco Unified CM and the downstream voice product in the call path.

OutgoingProtocolCallRef

Varchar(32)

This field identifies the globally unique call reference identification for the protocol. The value is passed to the next downstream voiced product. The value is alpha–numeric and truncated to 32 characters.

currentRoutingReason

Positive Integer

This field, which is used with the external call control feature, displays the reason why the call was intercepted for the current call. See topics related to routing reason values for external call control for a list of reasons.

Default value is 0.

origRoutingReason

Positive Integer

This field, which is used with the external call control feature, displays the reason why the call was intercepted for the first time. See topics related to routing reason values for external call control for a list of reasons.

Default value is 0.

lastRedirectingRoutingReason

Positive Integer

This field, which is used with the external call control feature, displays why the call was intercepted for the last time. See topics related to routing reason values for external call control for a list of reasons.

Default - Empty string.

huntPilotDN

Text String

This field indicates the hunt pilot DN through which the call is routed.

Default - Empty string.

huntPilotPartition

Text String

This field indicates the partition for the hunt pilot DN.

Default - Empty string.

calledPartyPatternUsage

Positive Integer

This field indicates the pattern of the called party.

Default value specifies 5 (PATTERN_ROUTE).

  • If the huntPilotDN is populated, use the huntPilotDN field value as the hunt pilot.
  • If the huntPilotDN is not available, check the pattern usage (7 =PATTERN_HUNT_PILOT) in the CDR table to identify the call type. If this call is a hunt list call, use the finalCalledPartyNumber as the huntPilotDN.

wasCallQueued

Positive Integer

This field specifies whether the call has been put into a queue or not. A value of 0 means that the call is not put into any queue; 1 means the call has been put into a queue.

totalWaitTimeInQueue

Positive Integer

This field specifies how long a caller has been put into a queue. The value is specified in second. The value is 0 if the call is never put into any queue.

callingPartyNumber_uri

Text String

This field specifies an alphanumeric string of up to 254 characters that identifies the calling party if the calling party uses a directory URI for call addressing.

If the calling party uses a blended address in the identity headers, this field contains the directory URI portion of the blended address.

Default - Empty string " ". If the calling party does not use a directory URI, the field stays empty.

originalCalledPartyNumber_uri

Text String

This field specifies a string of up to 254 alphanumeric characters that specifies the directory URI to which the original call was addressed, prior to any call forwarding, provided the call was addressed to a directory URI.

If a blended address is used for the called party, this field specifies the directory URI portion of the blended address.

Default - Empty string " ". If destination cannot be reached, or if the called party is a directory number, this field stays empty.

finalCalledPartyNumber_uri

Text String

This field specifies an alphanumeric string of up to 254 characters that indicate the directory URI address to which the call finally gets presented, if the final address is a directory URI. If no forwarding occurs, this field shows the same directory URI as the originalCalledPartyNumber_uri field.

If a blended address is used for the called number, this field specifies the directory URI portion of the blended address

For calls to a conference bridge, this field contains the actual identifier of the conference bridge, which is an alphanumeric string (for example, b0019901001).

Default - Empty string " ". If destination cannot be reached, or if a directory number is used for called addressing, this field stays empty.

lastRedirectDn_uri

Text String

This field specifies an alphanumeric string of up to 254 characters.

For forwarded calls that use a directory URI for addressing, this field specifies the directory URI of the next to last hop before the call reaches its final destination. If only one hop occurs, this number matches the originalCalledPartyNumber_uri.

If a blended address is used, this field contains only the directory URI portion of the blended address.

For calls that are not forwarded, this field matches the originalCalledPartyNumber_uri and the finalCalledPartyNumber_uri.

For calls to a conference bridge, this field contains the actual identifier of the conference bridge, which is an alphanumeric string (for example, b0019901001).

Default - Empty string " ". If the call is never redirected, or if the address is a directory number, this field remains empty.

Routing reason values for external call control

Cisco Unified Communications Manager supports the external call control feature, which enables an adjunct route server to make call-routing decisions for Cisco Unified Communications Manager by using the Cisco Unified Routing Rules Interface. When you configure external call control, Cisco Unified Communications Manager issues a route request that contains the calling party and called party information to the adjunct route server. The adjunct route server receives the request, applies appropriate business logic, and returns a route response that instructs Cisco Unified Communications Manager on how the call should get routed, along with any additional call treatment that should get applied.

The adjunct route server can instruct Cisco Unified Communications Manager to allow, divert, or deny the call, modify calling and called party information, play announcements to callers, reset call history so adjunct voicemail and IVR servers can properly interpret calling/called party information, and log reason codes that indicate why calls were diverted or denied.

The following table includes the reasons that can display for the currentRoutingReason, origRoutingReason, or lastRedirectingRoutingReason fields.

Table 2 Routing Reason Values for External Call Control

Field Value

Reason

Description

0

PDPDecision_NONE

This value indicates that the route server did not return a routing directive to the Cisco Unified Communications Manager.

1

PDPDecision_Allow_Fulfilled

This value indicates that Cisco Unified Communications Manager allowed a call.

2

PDPDecision_Allow_Unfulfilled

This value indicates that Cisco Unified Communications Manager disallowed a call.

3

PDPDecision_Divert_Fulfilled

This value indicates that Cisco Unified Communications Manager diverted the call.

4

PDPDecision_Divert_Unfulfilled

This value indicates that Cisco Unified Communications Manager was not able to divert the call.

5

PDPDecision_Forward_Fulfilled

This value indicates that Cisco Unified Communications Manager forwarded the call.

6

PDPDecision_Forward_Unfulfilled

This value indicates that Cisco Unified Communications Manager was unable to forward the call.

7

PDPDecision_Reject_Fulfilled

This value indicates that Cisco Unified Communications Manager rejected the call.

8

PDPDecision_Reject_Unfulfilled

This value indicates that Cisco Unified Communications Manager was not able to reject the call.

Related References