The following table lists the
SBC may insert non-ASCII characters in CDRs when messages are parsed in the initial INVITE.
This record indicates that the call has been successfully established/connected and session has successfully started.
This record indicates that a previously established successful session has now terminated.
This record indicates that a call/session failure scenario where a call/session could not be successfully established.
The ATTEMPT record is generated for every INVITE attempt, if the flag attemptRecordGeneration
flag is enabled.
This record captures any changes to signaling/call details during the session. For scenarios where the call duration is long, this record is also generated periodically to indicate session progress.
This record indicates a node reboot occurred.
This record indicates that the node experienced a switchover that is, standby mode went to active due to a switchover initiated from the cli or as a result of a problem on the active node.
This record indicates an LSWU change:
Gateway Name field (up to 23 characters).
If parameter loading is turned on, then the previously configured node name will appear in the REBOOT and SWITCHOVER records.
If parameter loading is turned off or Node Name object is never configured, this value is "None" in the REBOOT and SWITCHOVER records.
Accounting ID (64 bits in HEX format).
This identifier occurs in each record, and combined with the Gateway Name field uniquely identifies the call accounting information on a network basis for an extended period of time. In a REBOOT record, this is the accounting ID of the first call attempted on the GSX.
Shelf Number | Boot Count | Call ID |
The Boot Count is incremented for each shelf reboot or switch-over.
Start time in System Ticks (system tick = 10 ms) - the timestamp of when Setup Request was received (Decimal number 0 - 4294967295).
Node Time Zone (up to 23 characters).
This field can include any of the strings shown in the Time Zone section
This page lists some GMT-based time zones, but it is possible to have any of the time zones shown in the Time Zone
Start Date (mm/dd/yyyy) - GMT date stamp when Setup Request was received. This value is provided by NTP.
In the REBOOT record, this is the date the
This field is combined with the Start Time Field for stream-based CDR logging.
Start Time (hh:mm:ss.d) (d=deci-seconds) - GMT timestamp when Setup Request was received, for example 16:20:38.6. This value is provided by NTP.
In the REBOOT record, this is the time that the
This field is combined with the Start Date Field for stream-based CDR logging.
The Old Software Version field represents the
The New Software Version field represents the GSX/
[START (8) | STOP (8) | ATTEMPT (8) | INTERMEDIATE (8)]
Time Elapsed from Receipt of Setup Message to the first Policy Server/
Time Elapsed from Receipt of Setup Message to Receipt of Alerting/Proc/Prog in 10 millisecond ticks (Decimal number 0 - 4294967295).
Time Elapsed from Receipt of Setup Message to Service Established (Receipt of Answer and Completion of Cut-through) in 10 millisecond ticks (Decimal number 0 - 4294967295).
Intermediate Date (mm/dd/yyyy) - GMT datestamp when Intermediate Accounting Timer expired, for example 02/06/1999.
This field is combined with the Intermediate Time Field when stream-based CDR logging is used.
Intermediate Time (hh:mm:ss.d) (d=deci-seconds) - GMT timestamp when Intermediate Accounting Timer expired, for example 16:20:38.6.
Disconnect Date (mm/dd/yyyy) - GMT date stamp when Disconnect Request was received.
The Disconnect Date field is not set by reading NTP time. Instead, the disconnect date stamp is calculated by adding the elapsed time between the Setup and Disconnect Messages to the Start date stamp. This indirect method ensures the difference between the Start and Disconnect Dates reflects the true duration of the call, even if the NTP server adjusted time of day during the call. See "Disconnect Time (Time)" below for an explanation and example of this method.
Disconnect Time (hh:mm:ss.d) (d=deci-seconds) - GMT time stamp when Disconnect Request was received, for example 16:20:38.6.
The Disconnect Time field is not set by reading NTP time. Instead, the disconnect time stamp is calculated by adding the elapsed time between the Setup and Disconnect Messages to the Start time stamp. This indirect method ensures the difference between the Start and Disconnect Times reflects the true duration of the call, even if the NTP server adjusted time of day during the call.
For example: assume a Setup Message is received at 01:00:00.0 GMT (NTP Time). Then over the next hour the NTP server rolls back NTP time by one minute. Also after exactly one hour (360000 ten-millisecond ticks) a Disconnect message is received, terminating the call. The new NTP time when this disconnect is received is 01:59:00.0 GMT (but would have been 02:00:00.0 GMT if NTP adjustment did not occur). In reality the caller spent 60 minutes on the phone, not 59. Because of the indirect disconnect time calculation described above, the GSX/
The elapsed time between the Setup and Disconnect Messages can be calculated by adding the "Time Elapsed from Receipt of Setup Message to Service5 Established" and "Call Service Duration" fields. The latter field measures time elapsed from service established to receipt of disconnect message.
This field is combined with the Disconnect Date Field when using stream-based CDR logging.
Time Elapsed from Disconnect receipt to Call Termination completion in 10 millisecond ticks (Decimal number 0 - 4294967295).
Call Service Duration in 10 millisecond ticks. This count is initiated when the answer message is received and continues to increment until one leg of the call is released (Decimal number 0 - 4294967295).
Call Disconnect Reason (0 - 255).
The Call Termination Reason Codes are taken from the Q.931 Standard for all codes less than 128.
Codes equal to or greater than 128 are
The Ribbon Reason Codes appear in the system event logs to give specific information about the call failure. These codes may expand in the future.
CAS SSP configuration allows the administrator to specify the disconnect reason codes when errors are encountered during CAS call establishment. Therefore, any of the error codes below could be returned from a CAS call.
If the
For example, cause value 14 (PORTED NUMBER) may be represented as 000 1110, which is Class 000. Cause value 52 (OUTGOING CALLS BARRED) is represented as 011 0100, which is class 011. Hence, from "Mapping by Cause Code Class" table, cause value 14 is mapped to cause value 31 (NORMAL_UNSPECIFIED) and cause value 52 is mapped to cause value 63 (SERVICE_OR_OPTION_NOT_AVAILABLE_UNSPECIFIED).
When a mapped Disconnect Code is sent to the preceding switch by the GSX/
The Call Disconnect Reason Code Mapping table provides a "single source" reference that, for each ISUP Disconnect Code received, shows the mapped Disconnect Code that is stored in the CDR that is generated by the ISUP, ISDN, H.323, and SIP services respectively. This table also shows the standard(s) that define a particular ISUP Disconnect Code.
When SIP rejection responses must be signaled to the PSTN, the mappings shown in the SIP to ISUP Disconnect Code Mapping table are recommended by RFC 3398 and implemented by Ribbon. If the SIP rejection message contains an encapsulated REL message, then the Cause Indicator (CAI) parameter in the generated REL gets set to the value of the CAI parameter received in the encapsulated REL.
Whenever a Reason Header is encountered in any SIP message (such as BYE, CANCEL, 4xx, or 5xx), the GSX/
If the Reason Header is absent from the message, the ISUP Multipurpose Internet Mail Extension (Mime) cause value, if available, is used for the Disconnect Code. Otherwise stated, the GSX/
This conforms to RFC 3398 recommendations. You may configure the PSX IP PROFILE object to reverse this mapping behavior, thus conforming to the Q.1912.5 recommendation.
This field identifies the service delivered for VoIP/Circuit Switched Voice (up to 22 characters).
The format of this field is an enumeration when using stream-based CDR logging.
This field (up to 12 characters) defines the call direction, such as:
The first stage of a two stage call is either PSTN-TO-TERM or IP-TO-TERM. The second stage of a two stage call is either TERM-TO-PSTN or TERM-TO-IP.
This field conveys the signaling scenario for the call, including whether ingress is a PSTN signaling/IP signaling, and whether egress is PSTN signaling/IP signaling. For example, a call that has ingress signaling as ISUP and egress signaling as ISUP, Call Direction = "PSTN-TO-PSTN". For a call that has ingress signaling as H.323, and egress signaling as ISDN, Call Direction = "IP-TO-PSTN". For a call that has ingress signaling as CAS, and egress signaling as GSX/
When an ATTEMPT record is generated by a blocking script, this field is set to UNKNOWN (since the call is not established, Call Direction is undefined or UNKNOWN).
When an ATTEMPT record is generated after the GSX/
When a START, STOP, or INTERMEDIATE record is generated by a successfully established call, this field is populated with a valid value.
The format of this field is an enumeration when using stream-based CDR logging.
This field (up to 23 characters) is populated with the route partition ID the PSX used for routing a call.
This ISUP signaling parameter field (string up to four characters, for example 0288) is populated using either the information received in the IAM (if ingress signaling is ISUP) or information returned by the PSX in a policy response. The PSX obtains information from configuration tables. If the ingress signaling group and the PSX do not provide a value for this field, this field is empty.
The Calling Number Address Digits are sent out on the egress signaling side, and is the end result of any digit manipulations and address translation performed by the PSX during the policy request processing on the calling number received from ingress signaling.
The Called Number Address Digits are sent out on the egress signaling side, and is the end result of any digit manipulations and address translation performed by the PSX during the policy request processing on the called number received from ingress signaling.
This field is a string not used in routing the call, and is received via Overlap Address Messages such as SAM. This field is significant when the ingress signaling protocol supports overlap addressing (for example, SAM messages in ISUP, INFO messages in ISDN), and contains any digits obtained by the GSX/
For example, if GSX/
This field defines the number of called number translations performed on the node (length: decimal 0-2).
This and the following fields carry information about TollFree/LNP translation performed by the PSX.
For example the called number received by the GSX/
In this case, the following applies:
Called Number = 781-123-1000
Number of Called Num Translations Done by This Node = 2
Called Number Before Translation #1 = 1-800-123-1234
Translation Type 1 = 2
Called Number Before Translation #2 = 617-123-1234
Translation Type 2 = 1
In another example, if the called number in the incoming IAM was 617-123-1234, and the PSX performs an LNP translation, the result is 781-123-1000. Consequently, the accounting records contains:
Called Number = 781-123-1000
Number of Called Num Translations Done by This Node = 1
Called Number Before Translation #1 = 617-123-1234
Translation Type 1 = 1
Called Number Before Translation #2 – Empty
Translation Type 2 - 0
Although the Called Number Before Translation #1 field is the called number before any address translations are performed., it also represents the called number after any digit manipulations performed by the PSX. To see the called number received from ingress signaling (the called number before any digit manipulation is performed by the PSX), see "Dialed Number" . This field is populated in an ATTEMPT record in the absence of a PSX query response if the preceding switch performs the translation and the call is torn down before the PSX response is received. The presence of the M bit in the received ISUP Initial Address Message (IAM) External Furnish Charging Info (FCI) message indicates the preceding switch performed the translation.
This field contains the called number before the first translation is performed, and carries information about TollFree/LNP translation performed by the PSX.
This field is empty ("") if no translations are performed, and occurs when the Translation Type 1 field is "0" (CPC_ADDR_TRANS_NONE) See "Translation Type 1" for details.
This field is also empty ("") when all of the following conditions are true:
This field is populated in an ATTEMPT record in the absence of a PSX query response if the preceding switch performs the translation and call is torn down before PSX response is received. The presence of the M bit in the received ISUP Initial Address Message (IAM) External Furnish Charging Info (FCI) message indicates that the preceding switch has performed the translation.
This field carries information about the first translation performed by the PSX:
This field contains the called number before the second translation is performed, and carries information about TollFree/LNP translation performed by the PSX.
This field is empty ("") if less than two translations are performed, and occurs when Translation Type 2 field (see "Translation Type 2") is "0" (CPC_ADDR_TRANS_NONE).
This field is also empty ("") when all of the following conditions are true:
This field carries information about the second translation performed by the PSX:
This field is a string of up to 30 characters. The record is populated using the following precedence:
This record is a string of up to 23 characters. The content of this record depends upon the type of call route that is returned from the PSX:
The PSX supports to send RL for each route of a call in the policy response message to the SBC. The flag Enable Per Route Routing Label
is added to the Feature Control Profile (FCP) entity screen. When the flag Enable Per Route Routing
Label
is enabled on the PSX, the PSX returns the RL for each route. The SBC stores these RLs in the CDR records for each call.
Enable Per Route Routing
Label
is enabled, the CDR RL field is populated from the per-route data returned from the PSX.Enable Per Route Routing
Label
is disabled, the SBC stores the per-call routing label returned from the PSX in the CDR Routing Label field.The Route Attempt Number (Decimal number 1 - 65535).
The route selected:
If Gateway Name is unknown, Gateway IP Address displays according to address type:
The Route Selected field is not populated on the egress GW when making GW-GW calls.
For packet based egress trunk groups, the IPv4 or the IPv6 address can be used for egress signaling on the local
The local
If the egress trunk group is circuit-based, this field is empty ("").
For packet-based egress trunk groups, the IPv4 or the IPv6 address can be used for egress signaling on the far end of the packet network.
The local GSX/
If the egress trunk group is circuit based, this field is empty ("").
The origination gateway logs the name of the external trunk group which exists between the ingress network and the origination gateway in this field. The destination gateway logs the name of the internal IP trunk group which exists between the origination gateway and destination gateway in this field.
Applicable only for PSTN-IP and PSTN-PSTN calls.
Ingress PSTN Circuit End Point field – Shelf (1-6):Slot (1-16):Port (1-84):DS0 (1-32):CIC (1-65535):Local Point Code (32 bit HEX format): Remote Point Code (32 bit HEX format).
The Port range of 1-84 applies to calls that are assigned to a CNS60 or CNS71 module. 1-28 are the T1 circuits on the first T3, 29-56 are the T1 circuits on the second T3, and 57-84 are the T1 circuits on the third T3.
Ingress IP Circuit End Point field applies to both local and remote IP addresses.
The IP address can be in IPv4 or IPv6 format. For IPv4 address type, use dotted decimal format. For example, 128.1.22.233 (up to 15 characters).
For IPv6 address type, use hexadecimal format. For example, 3ffe:1900:4545:3:200:f8ff:fe21:67cf (up to 39 characters).
If NAPT or ICE are enabled on the call then the Ingress IP information is set to 127.0.0.0:5004 in the START/ATTEMPT/INTERMEDIATE CDRs. This happens because STUN messages happen after the INVITE processing.
The STOP record contains the correct remote IP address. Field 23 of the SIP/SIP-I protocol variant string Original Peer SDP address for NAPT or ICE contains the peer IP address as received in the SDP but unconfirmed by STUN messaging.
The default IP address 127.0.0.0 is taken as remote IP address and the default port 5004 is taken as remote port when a NAT call is made without sending media from the endpoints.
Applicable only for IP-PSTN and PSTN-PSTN calls.
Egress PSTN Circuit End Point field – Shelf (1-6):Slot (1-16):Port (1-84):DS0 (1-32):CIC (1-65535):Local Point Code (32 bit HEX format): Remote Point Code (32 bit HEX format).
The Port range of 1-84 applies to calls that are assigned to a CNS60 or CNS71 module. 1-28 are the T1 circuits on the first T3, 29-56 are the T1 circuits on the second T3, and 57-84 are the T1 circuits on the third T3.
Egress IP Circuit End Point field applies to both local and remote IP addresses.
The IP address can be in IPv4 or IPv6 format. For IPv4 address type, use dotted decimal format. For example, 128.1.22.233 (up to 15 characters).
For IPv6 address type, use hexadecimal format. For example, 3ffe:1900:4545:3:200:f8ff:fe21:67cf (up to 39 characters).
The Remote IP Address and Port number may not be available in certain call attempt situations captured in ATTEMPT records. Examples include when the remote gateway has no available routes, or when address information is not contained in a backwards release message. In these situations the IP Address and Port display as "0.0.0.0:0". The remote data is always available for completed calls (that is, START, INTERMEDIATE and STOP records).
The default IP address 127.0.0.0 is taken as remote IP address and the default port 5004 is taken as remote port when a NAT call is made without sending media from the endpoints.
Number of Audio Bytes Sent as recorded by the ingress DSP/NP (decimal representation of a 64 bit number: 1 - 1.844674407*1019).
Number of Audio Packets Sent as recorded by the ingress DSP/NP (decimal representation of a 64 bit number: 1 - 1.844674407*1019).
Number of Audio Bytes Received as recorded by the ingress DSP/NP (decimal representation of a 64 bit number: 1 - 1.844674407*1019).
Number of Audio Packets Received as recorded by the ingress DSP/NP (decimal representation of a 64 bit number: 1 - 1.844674407*1019).
Originating Line Information (OLIP), also known as info digits which are expressed as decimal values.
The values in the following table match ANSI T1.113 (ANSI ISUP).
In Local Number Portability (LNP) applications, Jurisdiction Information Parameter (JIP) provides the Local Routing Number (LRN) assigned to the originating number, which is then used to determine proper billing for the call (string up to 15 characters).
The carrier identification code (up to five characters) of the carrier used for carrying the call on the egress trunk (for example 0288). This code is provided by the ingress signaling group from the appropriate parameters in its signaling protocol. For example, ISUP obtains it from the Carrier Identification Code parameter in an IAM message, or from the PSX in a policy response. If the ingress signaling group and the PSX do not provide a value, this field is empty.
An internal identifier (up to 32 bits of hexadecimal data) bound to each call used by the GSX/
Example: "0x0000002F"
A string that contains data logged by a
Multiple variables may be logged within this field, with each variable data separated from the next variable by a configurable separator. The default value for the separator is slash . The data for each script variable includes the variable ID and the variable value, with a ":" as the separator. For example, the data string:
12:9786928999/108:12345
indicates data for two variables, variable ID - 12, and variable ID - 108. The value of variable 12 is 9786928999, and the value of variable 108 is 12345.
This field is applicable only if a Ribbon CPL script is executed for the call. The sub-fields within this field are all variables associated with the CPL script, and are a concatenation of the variables requested by the script to be logged. This field is populated only if a CPL script was executed for the call, and the script requested logging of script variables via the LOG SIBB in the script.
The time elapsed from receipt of setup message to receipt of exit message in 10 ms ticks (decimal number 0 - 4294967295).
Time Elapsed from Receipt of Setup Message to Generation of Exit Message (EXM) in 10 ms Ticks (Decimal number 0 - 4294967295).
The type of Calling Party number (decimal value).
For more information on the nature of the address enumeration values, refer to Nature of Address Enumeration Values.
The type of Called Party number (decimal value).
For more information on the nature of the address enumeration values, refer to Nature of Address Enumeration Values.
A string of up to 1849 characters or empty with delimiters "". Whenever any ingress service group has Protocol Variant Specific Data to log, this data is logged to this field. See the following pages for specific variants:
During a Live Software Update (LSWU), Ingress and Egress Protocol Variant Specific Data may be logged interchangeably to either this field or to the Egress Protocol Variant Specific Data field. This indeterminate behavior persists until after the LSWU is complete as indicated by the SW_CHANGE record.
The ingress signaling type (decimal value).
For signaling type enumeration values, refer to Signaling Type Enumeration Values.
The egress signaling type (decimal value).
For signaling type enumeration values, refer to Signaling Type Enumeration Values.
The ingress far end switch type (decimal value).
For mor information on far end switch type, refer to Far End Switch Type Enumeration Values.
The egress far end switch type (decimal value).
For mor information on far end switch type, refer to Far End Switch Type Enumeration Values.
The Field content depends upon whether the PSX is supporting a JAPAN variant.
If the JAPAN variant is being supported, then this field is the "Own Carrier ID" that is provisioned against the ingress trunk group, and is a string of up to five characters, for example "0288".
If a Non-JAPAN variant is being supported, then this field is the Carrier Code of the carrier that owns the Far End of the ingress trunk group. This is a string of up to 5 characters.
The "Trunk Ownership Fields in START/STOP Records" figure illustrates a typical PSTN-to-PSTN network in which the local GSX/
This depiction applies to all PSTN-to-PSTN networks except Japan.
Field content depends upon whether the PSX is supporting a JAPAN variant.
This field is a string of up to five characters, and is populated using the following precedence:
In all cases, a string of up to five characters is placed in this record (for example "0288").
The Calling Party Category (CPC) field is a hexadecimal value between 0x00 and 0xff. All letters are lower case and leading zeros are always displayed. The length is always four characters, two for the "0x" and two more for the CPC value.
The Calling Party Category Enumeration ValuesCalling Party Category Enumeration Values table lists the valid CPC hex values.
On the ingress GSX/
On the egress GSX/
The ISUP Carrier Selection Information parameter (decimal value) populated either by the ingress ISUP SG or by the PSX in a policy response. If neither the ingress ISUP SG or PSX supplies this field, it takes a value of "0".
The following table lists the valid decimal values.
Table8: Carrier Selection Information Enumeration Values
A decimal value indicating the numbering plan type used for the called number representation. It could be one of ISDN/DATA/TELEX/PRIVATE. The numbering plan for the called number is provided by the ingress signaling group (based on parameters obtained in its signaling messages, or using defaults appropriate to the protocol type), or provided by the PSX in the PSX in the policy response (if it provides a called number in the policy response).
The Numbering Plan Indicator (NPI) range includes ISUP Reserve/Spare values. The block of ISUP NPI enumerations (0 to 7) is appended to the existing
NPI values less than "8" are interpreted as Ribbon NPIs. Values greater than "7" are ISUP (Spare/Reserve) NPIs, to be derived by subtracting "8" from the record value. For example, a record value of "10" is an ISUP 2 NPI (10-8).
ISUP NPIs which map to a
This field is the original called number if LNP is performed by a switch preceding the GSX/
This field (decimal in range 0-4) identifies how the initiator session is closed:
Released internally by the call control entity in the GSX
Released by the ingress signaling group.
Released by the egress signaling group.
Released internally by GSX/
Released by the calling party at an early call attempt stage. Applies only to the ATTEMPT record.
EARLY disconnects may occur before a PSX Policy Request is sent or a PSX Policy Response is received due to an incomplete setup message or a setup message immediately followed by a disconnect from the calling party.
The following table describes the mapping of CDR field numbers and their call disconnect reasons for ATTEMPT records.
The following table describes the mapping of CDR field numbers and their call disconnect reasons for STOP records.
Field Number | Present in Raw CDR | Disconnect Initiator | Call Disconnect Reason |
---|---|---|---|
15 | Yes | Calling | Call Disconnect Reason is derived from (from high to low priority) any one of the following:
|
Called | Call Disconnect Reason is derived from (from high to low priority) any one of the following:
| ||
Internal | Contains internal CPC value that is used to release the call (typically cause value >127). GSX/ Unable to show "metadata-from": No such page "_space_variables" does not include CPC > 127 in the message out (for example, in ISUP MIME or Q.850 in the reason header). Instead, it maps it to an appropriate Q.931 standard release code provided the code is not overwritten by CPC to SIP cause map profile. For more information, refer to Call Disconnect Reason Code Mapping.
For SIP-I (Q.1912.5), cause value in ISUP-MIME takes higher precedence over Q.850 code in reason header in this scenario. | ||
| Yes | Calling |
|
Called |
| ||
Internal |
|
The number of packets recorded as a lost packet by the ingress DSP/NP. This field is a decimal representation of a 32-bit number (applicable to RTCP statistics for VoIP calls only).
The number of packets recorded as a lost packet by the egress DSP/NP. This field is a decimal representation of a 32-bit number (applicable to RTCP statistics for VoIP calls only).
The maximum interarrival packet jitter time (in millisecond) recorded by the ingress DSP/NP. This field is a decimal representation of a 16-bit number, hence must be in the range 0-65535 (This is applicable to RTCP statistics for VoIP calls only).
The last measurement for latency (in milliseconds) as recorded by the ingress DSP. This field is a decimal representation of a 16-bit number, hence must be in the range 0-65535 (applicable to RTCP statistics for VoIP calls only).
This field is applicable for IP-PSTN, PSTN-PSTN, PSTN-IP, and IP-IP calls. (String up to 23 characters.)
The origination gateway logs the name of the internal IP trunk group which exists between the destination gateway and the origination gateway in this field. The destination gateway logs the name of the external trunk group which exists between the destination gateway and the egress network in this field.
Figure XXX illustrates the basic call flow between the Ingress trunk group,
The egress service group protocol variant-specific data. This field is a string of up to 1849 characters, or empty with delimiters "". Whenever any egress service group has protocol variant-specific data to log, the data is logged to this field. See the following pages for specific variants:
During a Live Software Update (LSWU), Ingress and Egress Protocol Variant Specific Data may be logged interchangeably to either this field or to the Ingress Protocol Variant Specific Data field. This indeterminate behavior will persist until the LSWU completes as indicated by the SW_CHANGE record.
This field represents the calling number presented to the
This field indicates the reason the Intermediate Record is generated:
The Automatic Message Accounting (AMA) Call Type field (also known as AMA Call Code) is provided by the
This field is determined from the class of service of the calling subscriber together with the office to which his call is directed, and constitutes the basis for determining the charging rate on bulk billed calls where the called number is not recorded in AMA field.
This field is provided by the
The Originating Local Access and Transport Area (LATA) field. A LATA is a geographical area defined by the FCC within which a local telephone company may offer telecommunications services.The Originating LATA is provided by the
This field signifies which route in the policy response was used for this call. If no routes were successful, then this field is empty (""). The policy response can only hold from 1 to 10 routes. See also Cumulative Route Index.
The Route Index can be combined with the Routing Label (see Route Label) to determine the chosen route.
This field must be used when indexing route specific fields within the PSX Billing Info Field. See "PSX Billing Information".
This field (decimal number, 0-4) indicates the calling party number Presentation Restriction using one of the values below:
This field is extracted from the ISDN User Part (ISUP) Initial Address Message (IAM) received on an SS7 trunk. If the number is not available this field is empty (""). (String up to 30 characters.)
The Incoming ISUP Charge Number Nature of Address (NOA) field (decimal number in the range 0-255).
The Dialed Number Nature of Address (NOA) field. (Decimal number from 0-255.)
This field defines the Ingress Codec type, and consists of a string with a maximum of six characters (the two colons in the field are included in this count) in the following format. If audio encoding is not applicable, this field is set to "0".
<networkType>:<codecType>:<audioEncoding>
Examples:
A T.38, version 0 call will be displayed as: “P:6:0”
See the table for a listing of Ingress Codec Type sub-field variables.
This field defines the Egress Codec Type, and consists of a string with a maximum of six characters (the two colons in the field are included in this count) in the following format.
<networkType>:<codecType>:<audioEncoding>
Examples:
A T.38, version 0 call will be displayed as: “P:6:0”
See the table for a listing of Egress Codec Type sub-field variables.
Decimal value indicating the duration of RTP packets in milliseconds, as recorded by the DSP in the resource chain on the ingress leg of the call. If no DSP resources are allocated on the ingress leg of the call, then this field is empty ("").
This field, assigned by the GSX/
0x89ABCDEF
.)This field (decimal, 0-1) identifies whether or not a script was executed before terminating the call. Possible values:
This field (decimal, 0-1) identifies whether or not the GSX/
This applies only to PSTN to IP and PSTN to PSTN calls. If the call is IP to PSTN, this field is empty ("").
This field indicates if GSX/
This field applies only to IP to PSTN and PSTN to PSTN calls. If the call is PSTN to IP, this field is empty ("").
The Charge Indicator values provisioned on the PSX. These values apply to the Ingress Trunk Group and are shown in the table below.
This field (AMAslpID) is used in an Advanced Intelligent Network (AIN) environment to record the identification of the service logic in the Service Control Point (SCP). (fixed 9-digit decimal number, with any leading zeroes present).
The table below describes the AMAslpID values. The PSX provides this data in Binary Coded Decimal (BCD) format, and the GSX/
If this data is unavailable, this field is empty ("").
See GR-1100-CORE, Section 2 for more detail about this native data.
The Billing Automatic Message Accounting Format (BAF) module is used to record a variety of billing information. The first three characters represent the Module Code Identification that, in turn, specifies how to interpret the remaining characters. See the below table for these codes.
The remaining characters are defined in Section 1.4 "Data Fields" of the Telcordia Technologies Generic Requirements (GR-1100-CORE) Issue 4. Refer to that document for all definitions.
A string of 4-256 hexadecimal characters. If the BAF Module is unavailable, this field is empty ("").
The BAF Module Names table lists each valid BAF Module code and name as published in Telcordia Technologies Generic Requirements (GR-1100-CORE) Issue 4. The Telcordia document defines BAF Module names.
AMA Set Hex AB Indicator:
This field is a BAF parameter indicating a customer's originating or terminating line characteristics. This indication may be used by an accounting application to assess applicable tariffs to determine the price for services rendered.
This ID, if available, is provided by PSX/ERE as a fixed 3-digit decimal number. If no data is available, this field is left empty ("").
The GSX/
The Service Feature IDs table lists valid Service Feature IDs.
An optional parameter in backwards call control messages (ACM, CPG, ANM, and Gateway-to-Gateway signaling).
If the egress GSX/
If the FE Parameter is not present, this field is left empty ("").
The record is generated in one of two formats:
The Parameter Length field of the record designates whether the record is the Short Form or the Long Form.
The following tables depict each of these forms.
The Answer Type and Completion Code (manner by which the call was terminated) are 4-bit values, depicted in the following table.
Example:
The FE Parameter record below:
"0xFE0812BC0A006745DF03"
...is generated by the following FE Parameter subfield values:
Format = Long Form
Completion Code = Treated Call (1)
Answer Type = Software Answer, voice detected (2)
Final Trunk Group ID = 0xABC
Final Switch ID = 0x3DF
Final Trunk Member = 0x4567
Satellite Indicator (SAT):
This value is extracted from the Nature of Connection Indicator.
The following figure displays a high level view of the PSX Billing Information field within an accounting record. This field contains billing data generated by the PSX that is encoded in bytes represented as hexadecimal characters (00 to FF). This variable length field may contain up to 128 bytes of binary data (represented by 256 hexadecimal characters).
Every subfield in the PSX Billing Info field is provisioned on the PSX and placed into the
The PSX Billing Info field is divided into four portions:
Each portion is a series of one or more subfields.
The Billing File Info Header contains a unique 16 bit value.
The Common and Route Specific Tag portions are comprised of subfields that consist of a unique Tag, a Tag Data Length Indicator, and Data for that Tag (or value). In any of these subfields, the one byte Tag Data Length Indicator could be zero, resulting in a zero length value.
The Route Specific Data portion is comprised of subfields of Tag Data Length Indicator and Data for that Tag (or value), for each Tag, for each route. In this portion, the Tags themselves were defined in the Route Specific Tag portion and hence are not present in the subfields.
This subfield detail is depicted below:
This field contains a two byte Billing Information Variant. This subfield is provisioned on the PSX. This field is always occupied by four hexadecimal characters representing two bytes of binary data. A user provisioned Billing Information Variant of 0000 is depicted below.
The Billing information Variant Data table lists the Tags, Tag Data lengths, and Tag Data descriptions that apply to the Billing Information Variants. In this table, the Max Length is the value provisioned in the PSX Billing Info entity. The Max Length value is always less than or equal to the Max Length Limit value, which is hard coded into the entity.
As mentioned previously, every Tag/Length/Value subfield and Route Specific Length/Value must be provisioned in the Billing Info entity on the PSX in order to be present in any accounting record. Furthermore, the Billing Info Profile ID that is provisioned on PSX must be associated with the (ingress) trunk group entity, also on the PSX. See the "PSX Policy Server Provisioning Guide" for these procedures.
When the length of the data that contains integer or hex digits is an odd number, the most significant byte will have a leading "0".
When the length of the data that contains BCD digits is an odd number, the most significant byte will have a leading "F".
The SCP may return certain values more than once. If this is the case, the corresponding subfield is populated in the PSX Billing Info field once per SCP reply. Data from each reply is appended to the end of Common Portion field, so the first occurrence of a subfield corresponds with the first SCP reply, the next occurrence with the second reply, and so on. The following SCP subfields may be populated more than once in PSX Billing Info field:
Example 1
The following PSX Billing Info field is defined in the following table.
00000005000001010603E903F60389000901F1000B03F978580004022345000A01F1000D03F97869000E0100000F010000100A4D696C696E6473204269000C03F60346001304F46089800FA0040FA10FA20100010F01000109010001090100010901000109
Example 2
The PSX Billing Information record below
000100010101000203F1234500030120000403022345000501990006029876000701000008045678EF9A03E905978555121200070122
This field is supplied by the PSX, after customer specific provisioning. If this field is not provisioned on the PSX, it is left empty ("").
For more information on the TDM Trunk Group Type, refer to TDM Trunk Group Type Enumeration Values.
This field is supplied by the PSX, after customer specific provisioning. If this field is not provisioned on the PSX, it is left empty ("").
For more information on the TDM Trunk Group Type, refer to TDM Trunk Group Type Enumeration Values.
Ingress Trunk Member Number. The ingress trunk member number that was provisioned on the GSX/
This field takes the decimal values 0-65534. If this field was not provisioned, or was subsequently UNSET for this circuit, it is left empty ("").
If the ingress trunk group is an IP trunk group, this value is always set to 1.
Egress Trunk Group ID. The egress trunk group ID on the egress GSX/SBC. The content of this field will differ from the corresponding field in the FE Parameter record whenever the final switch is not the same as the egress GSX/
This field is supplied by the PSX, taking the decimal values 0 - 4095. If this field is not provisioned on the PSX, it is left empty ("").
This field is supplied to the GSX/
Egress Switch ID. The egress switch ID on the egress GSX/
This field is supplied by the PSX, taking the decimal values 0 - 1023. If this field is not provisioned on the PSX, it is left empty ("").
This field is supplied to the GSX/
ATM address of the local physical port attached to the ATM network on the ingress leg of the call.
Because this field is not currently supported, it is always empty ("").
ATM address of the remote physical port attached to the ATM network on the ingress leg of the call.
Because this field is not currently supported, it is always empty ("").
ATM address of the local physical port attached to the ATM network on the egress leg of the call.
Because this field is not currently supported, it is always empty ("").
ATM address of the remote physical port attached to the ATM network on the egress leg of the call.
Because this field is not currently supported, it is always empty ("").
The PSX call type, based on the results of the digit analyses performed by the PSX, which is then used as part of the route selection process.
The call type enumeration permits 31 predefined (Ribbon) values [0-30] and 31 user defined values [1001-1031] as shown in the following table.
The outgoing trunk group number for calls that overflow from one gateway to another via a Singapore Inter-Gateway Circuit (IGC) trunk. The GSX/
If GSX/
The type of route that was selected from a GSX/
The following table lists these routes types.
If the ORI is not present, the GSX/
If GSX/
The incoming trunk group number on a GSX/
If the IRI is not present or if GSX/
The calling party's name in text.
The ANSI SS7 specification defines this field as up to 15 acharacters of name information coded in IA5 format. The GSX/
If the Calling Name is unknown, or not provided, then the field is left blank without displaying the double quotes as depicted in the last example above.
The Calling Name Type delivered in the PSX Policy Response.
If Calling Name data is not available, this field is left empty ("").
This field represents the Calling Party Numbering Plan received in the incoming setup message. For ISUP calls this value is extracted from the optional Calling Party Number parameter in the Initial Address Message (IAM). For SIP calls, this value is extracted from the FROM header.
The value logged to the CDR does not comply to the standard ISUP enumeration. This decimal value (range 0-15) must be interpreted according to the below table.
The GSX/
The value logged to the CDR does not comply to the standard ISUP enumeration. This decimal value (range 0-15) must be interpreted according to Table 43.
If the PSX does not manipulate this field, then the Incoming and Outgoing Calling Party Numbering Plans is the same.
START-91, STOP-110, ATTEMPT-101, INTERMEDIATE-91
This value represents the Business Group ID of the calling party. The GSX/
This decimal value is in the range 0 to 4294967295. If this data is not present or unknown, then a one "1" (Public Business Group) is logged.
SIP is the only protocol which supports Business Group IDs. For all other protocols (ISUP, H323, etc.) this field is logged as "1".
This value represents the Business Group ID of the called party. The GSX/
This decimal value is in the range 0 to 4294967295. If this data is not present or unknown, then a one "1" (Public Business Group) is logged.
SIP is the only protocol which supports Business Group IDs. For all other protocols (ISUP, H323, etc.) this field is logged as "1".
The Calling Party Public Presence Directory Number (PPDN) is an optional SIP parameter which is propagated as the calling number when a call goes into the Public PSTN. If the SIP INCOMING INVITE message's Remote Party ID header contains id-context=ppdn, then the Remote Party ID is interpreted and logged as the Calling PPDN.
This string is up to 30 characters.
If the id-context is not PPDN or if the ingress protocol is not SIP, then this field is empty ("").
Carriers bill each other based on Carrier Elapsed Time (as opposed to Customer Elapsed Time). Carrier Elapsed time is defined as the Carrier Connect Time to call disconnect time. Telcordia GR-508-CORE defines Carrier Connect Time as:
"The time when first wink is received from a carrier for Feature Group D (FGD) calls. For Feature Group B (FGB) calls, carrier connect time is the time when carrier off-hook is detected."
The closest the GSX/
This field contains that elapsed time in 10 millisecond ticks. If no routing attempts were made, then this field is left empty ("").
The incoming ISUP IAM message may contain an optional "Charge Number" parameter. This parameter contains a nature of address (NOA) indicator for the charge number. The GSX/
The GSX/
This field takes a decimal value in the range 1 to 255. If Billing Number NOA is unknown, then this field is left empty ("").
START-96 STOP-115 ATTEMPT-107 INTERMEDIATE-98
The incoming ISUP IAM message may contain an optional "Calling Number" parameter. This parameter contains a nature of address (NOA) indicator for the calling number. The GSX/
The outgoing calling number NOA is determined by the PSX and is logged in the "Calling Party Nature of Address" field. See Calling Party Nature of Address.
This field takes a decimal value in the range 1 to 255. If an Incoming Calling Number NOA is not received, then this field is left empty ("").
The Trunk Member used by the egress trunk group for this call. This number uniquely identifies the channel used for this call. The Trunk Member object can be configured for ISDN, ISUP and CAS service groups.
This field takes a decimal value in the range 0 to 65535. If the Trunk Member for the ISDN, ISUP, or CAS egress trunk group is not configured, then this field is left empty ("").
If the egress trunk group is an IP trunk group, this value is always set to "1".
This field identifies the destination gateway's type, such as GSX/
This field takes a decimal value in the range 0-8. For terminating records, this field is left empty ("").
A decimal value indicating what type of Telcordia record is being represented:
Specifies the elapsed time, in 10 millisecond ticks, from the previous record for this call to this record. The previous record is either a START record, or an INTERMEDIATE record. This record is either an INTERMEDIATE record or a STOP record.
If intermediate record mode is interval, this value is approximately 100 times the configured intermediate interval. The interval range of 5 seconds to 24 hours results in a field range of 500 - 8,640,000 milliseconds.
If intermediate record mode is Telcordia, the first Telcordia record range is from 8,640,000 milliseconds (24 hours) to 17,279,999 milliseconds (48 hours minus 10 milliseconds). The continuation Telcordia record range for STOP records is 0 milliseconds (call disconnected immediately following a long duration record generation) to 4,294,967,295 milliseconds. INTERMEDIATE Telcordia continuation records will always show 4,294,967,295 milliseconds in this field.
This decimal value reflects the overall route index used to route this call, counting all prior policy responses. This index can be combined with the Routing Label (see Route Label) to determine the chosen route.
A related field, "Route Index Used", is an index into the most recent policy response.
For example, assume the RL contains 28 routes, and the 25th route succeeds. The first policy response contains 10 routes, none of which succeed. The second policy response also contain 10 routes, again none succeed. The final policy response contains 8 routes, of which the 5th one succeeds. In this case "Route Index Used" is 5 and "Cumulative Route Index Used" is 25.
The range of this value is 1-65535. This field is empty ("") if no routes are chosen to route this call.
This value represents the disconnect reason (or cause code) sent by the local GSX/
If the actual disconnect reason (received from egress or internally generated) is not defined by the ingress signaling protocol, then the reason is mapped to a reason which is defined before being sent.
This value represents the disconnect reason (or cause code) sent by the local GSX/
If the actual disconnect reason (received from ingress or internally generated) is not defined by the egress signaling protocol, then the reason is mapped to a reason which is defined before being sent.
This string identifies the calling party subaddress associated with a call's origin. Although ISDN document Q.931E specifies that Calling Party Subaddress may contain up to 40 characters, this field is limited to 30 characters on GSX/
The Outgoing Trunk Group Number (OTGN) is an optional parameter in the Exit Message (EXM), and is a string of up to six digits. If an EXM is received containing an OTGN, then this field is populated with that value. If an EXM is generated by the GSX/
For packet based ingress trunk groups, the IPv4 or IPv6 address used for ingress signaling on the local GSX/
If the ingress trunk group is circuit based, this field is empty ("").
For packet based ingress trunk groups, the IPv4 or IPv6 address is used for ingress signaling on the far end of the packet network. The IPv4 address is in dotted decimal format, for example 128.1.22.233 and IPv6 address in hexadecimal/colon format, for example fd00:21:445:128::7880. (the local GSX/
If the ingress trunk group is circuit based, this field is empty ("").
The sequence number of this record relative to other records in the file. Depending upon how the parameter is configured, this is either:
This number starts at zero and increments by one each time a new record is written. The software maintains only one sequence regardless of the record type. When the sequence number reaches its maximum configured value, either 65535 or 4294967295, it wraps to zero and begins incrementing again (for example 65534, 65535, 0, 1, 2...). The incrementing continues through file roll-overs.
A sequence number of zero occurs only on a reboot (switchover), or a natural wraparound. (A natural wraparound sequence is 65534, 65535, 0, 1, 2 and so on.)
This field is intended to help reconcile billing records after events which may result in lost accounting records.
This field is a fixed parameter in the ITU ISUP Initial Address Message (IAM).
For ISUP calls, this information is populated from the TMR parameter, if it is present. If the TMR parameter is absent, this information is populated from the USI parameter. The TMR parameter is mandatory in ITU and the USI parameter is mandatory in ANSI. Because the TMR parameter or the USI parameter is always present, this field is always populated.
For CAS ingress calls, this field is populated from the capabilities set in the circuit service profile as follows:
circuitModeData
, then T1 channels are set to CPC_TG_TRANSFER_CAP_RESTRICTED. E1 channels are set to CPC_TG_TRANSFER_CAP_RESTRICTED if type is restricted, or to CPC_TG_TRANSFER_CAP_UNRESTRICTED if type is unrestricted
.voiceOnly
, then T1 and E1 channels are set to CPC_TG_TRANSFER_CAP_SPEECH.voiceorCircuitModeData
, then T1 and E1 channels are set to CPC_TG_TRANSFER_CAP_3_1KHZ_AUDIO.For incoming SIP calls, if the incoming INVITE has PSTN parameters, then the value of this field is taken from those PSTN headers. If an incoming SIP call is received without PSTN parameters, the default value CPC_TG_TRANSFER_CAP_3_1KHZ_AUDIO is placed into this field. For outgoing SIP calls, if Include PSTN Parameters is enabled in the PSX IP Signaling Profile, then these parameters are included in the SIP headers. Otherwise they are not included in outgoing INVITE.
The decimal value in range 0-255 must be interpreted according to the following table:
For ISUP calls, the User Service Information (USI) parameter is mandatory for ANSI, and optional for ITU. The five least significant bits of the second octet in this parameter contain the Information Transfer Rate. If the USI is present, this field is populated according to the ISUP values in the table below. If the USI is absent, then this field is always populated with the value CPC_TG_TRANSFER_RATE_64KBITS.
For CAS ingress calls, this field is always CPC_TG_TRANSFER_RATE_64KBITS.
For SIP ingress calls, if the incoming INVITE has PSTN parameters, then the value of this field is taken from those PSTN headers. If an incoming SIP call is received without PSTN parameters, the default value CPC_TG_TRANSFER_RATE_64KBITS is placed into this field. For outgoing SIP calls, if includePstnParameters is enabled in the PSX IP Signaling Profile, then these parameters are included in the SIP headers. Otherwise they are not included in outgoing INVITE.
This decimal value in the range 0-31 must be interpreted according to the table below . Note that these values do not correspond to the ISUP Q.931 definitions.
This value does not comply with Q.931
The User Service Information (USI) parameter is optional in the ISUP IAM. The five least significant bits of the third octet in this parameter contain the User Information Layer 1 (UIL1) Protocol. If the USI is not present in the IAM, or if the ingress service group is not ISUP, then this field is empty ("").
This decimal value (range 0-31) must be interpreted according to the below table.
This field contains the actual (raw) value of the calling party category if this value is not recognized by this GSX/
If present, the decimal value of this field is in the range 0-255.
The Egress Release Link Trunking (RLT) Feature Specific Data field is populated only when SS7 Release Link Trunking occurs on the egress leg of the call, otherwise this field is empty ("").
A Facility Request Message (FAR) is sent backward from the Redirecting Node to the call-originating node (Pivot Node) to request activation of an RLT service.
Any call that is bridged or redirected creates two accounting records: one for the initial call (AR) and one for the bridged or redirected call (BR). The table below presents the CDR logging scenarios for original, bridged, and redirected calls.
If more than one RLT (redirecting or bridging) occurs on the egress leg of the call, then only the data for the last RLT is present. When bridging occurs, the redirect Sub-Fields are empty (""). Similarly, when redirect occurs, the bridging Sub-Fields are empty (""). This field is a maximum of 598 characters, including all comma separators and the double quotation mark delimiters ("").
The Release Link Trunking Sub-Fields page provide additional explanation about certain Sub-Fields.
Example RLTs:
Redirecting:
"RLT,30,0:4000123456,0:3000123456,1:2000123456,0:1000123456,0:123456,1:0000123456,2:BADC,3:ABCD0102,3330,0:8005551212,1:8005551212,2:0850552121,3:0850552121,7864351112,7865550017,2146809413,19,0,8637,0,,,,,,,,,,"
Bridging:
"RLT,30,0:4000123456,0:3000123456,1:2000123456,0:1000123456,0:123456,1:0000123456,2:BADC,3:ABCD0102,7491,,,,,,,,,,,,2:48656C6C6F,0:2200123456,0:3300123456,0:4400123456,9785550000,9785551212,00070004:050505,0,15123,2033"
This field is populated only when a Two B-Channel Transfer occurs, otherwise this field is empty ("").
If one transfer occurs, then the first three Sub-Fields are populated. If a second transfer occurs, an additional Sub-Field is populated that indicates the time of that transfer. Unpopulated Sub-Fields are empty (""). This field is a maximum of 72 characters, including all comma separators and the double quotation mark delimiters (""). The following table describes the field format.
Example:
"TBCT,2,523,1179"
This string indicates two transfers occurring at 5.23 and 11.79 seconds after the call was established.
This field contains the Business Unit ID (or Sub-Group ID) of the Calling Party. This data is supplied by the PSX in the Policy Response. If Business Unit data is not available for the call, this field is empty ("").
If present, the decimal value of this field is in the range 0-4294967295.
This field contains the Business Unit ID (or Sub-Group ID) of the Called Party. This data is supplied by the PSX in the Policy Response. If Business Unit data is not available for the call, this field is empty ("").
If present, the decimal value of this field is in the range 0-4294967295.
This field captures the redirection information that happens to a call before it is processed by the GSX/SBC. This information is supplied by the originating network in the call setup message (the ISUP IAM message or the SIP INVITE message). This field does not refer to redirects performed internally by the GSX/SBC or PSX.
This field format is similar to the "Egress RLT Feature Specific Data" and the "Two B-Channel Transfer Feature Specific Data".
Field format is described in the below table.
When the ingress protocol is SIP, all diversion headers present in the incoming SIP INVITE message are used to populate Redirection Feature Specific Data. The GSX/
When multiple Diversion headers are present, the name-addr of the bottom-most Diversion header is used to set the ISUP Original Redirecting Number, and the diversion-reason of the bottom-most Diversion header is used to set the ISUP Original Redirecting Reason. The ISUP Redirect counter is set equal to the sum of the counters of all Diversion headers in the SIP message.
A diversion header that does not explicitly specify a diversion-counter tag counts as "1". If no redirect occurs, then the entire "Redirection Feature Specific Data" field is empty ("").
Example Redirection Feature Specific Data Field:
"REDI,11,3971912318,3971912315,1,2,10,0,10,6,01793601618,2,19"
The Ingress RLT (Release Link Trunking) Feature Specific Data field is populated only when SS7 Release Link Trunking occurs on the ingress leg of the call, otherwise this field is empty ("").
A Facility Request Message (FAR) is sent backward from the Redirecting Node to the call-originating node (Pivot Node) to request activation of an RLT service.
Any call bridged or redirected creates two accounting records: one for initial call (AR) and one for bridged or redirected call (BR). Table Encoding Data Detail presents the CDR logging scenarios for original, bridged, and redirected calls.
If more than one RLT (redirecting or bridging) occurs on ingress leg of the call, only the data for the last RLT is present. When bridging occurs, the redirect Sub-Fields are empty (""). Similarly, when redirect occurs, bridging Sub-Fields are empty ("").
This field is a maximum of 598 characters, including all comma separators and the double quotation mark delimiters (""). Table USI User Information Layer 1 describes the field format. Table Release Link Trunking Failure provides additional explanation about certain SubFields.
This field, which is configured on the GSX/
Use the ADMIN
command to see the names of PSX 1 (left column) and PSX 2 (right column).
The names and indexes of the configured PSXs are recorded in the system event log at PSX creation time. An example of such an entry is:
119 06112004 194858.00001:1.01.MAJOR .DS : PSX created, name: boston, index: 2
This field contains the enumerated congestion level value sent to the GSX/SBC by the PSX in the Policy Response. These enumeration are listed below. If no PSX was involved in routing the call or if congestion control was disabled, then this field is empty ("").
This field contains the time in milliseconds that used by PSX to process a Policy Request. This value contributes to the policy response time. If no PSX is involved in routing the call or if no PSX transaction took place, then this field is empty ("").
If present, the decimal value of this field is in the range 0-65535.
This field contains the file name (string of up to 23 characters) of a script executed on behalf of a call. If more than one script is executed, this field contains the name of the last script that executed.
If no script was executed on behalf of this call, this field is empty ("").
This field, consisting of an ASCII string with the delimiters "", contains external accounting data from the ingress leg of the call, similar to the "Ingress Protocol Variant Specific Data". This string takes the form:"<protocol identifier>,<external accounting data>"
The maximum length of the field, including the delimiters, is 128.
Because accounting strings from external entities can contain characters to corrupt a CDR record, the GSX/
Currently, SIP is the only protocol that logs external accounting data with the string generated when a SIP external signaling peer supplies <external accounting data>:
"SIP-PCDR,<external accounting data>"
This field, consisting of an ASCII string with the delimiters "", contains external accounting data from the egress leg of the call, similar to the "Egress Protocol Variant Specific Data". This string takes the form:
"<protocol identifier>,<external accounting data>"
The maximum length of the field, including the delimiters, is 128.
See "Ingress External Accounting Data" for explanation field.
Currently, SIP is the only protocol that logs external accounting data with the string generated when a SIP external signaling peer supplies <external accounting data>:
"SIP-PCDR,<external accounting data>"
Number of Audio Bytes Sent as recorded by the egress DSP/NP (decimal representation of a 64 bit number: 1 - 1.844674407*1019).
Number of Audio Packets Sent as recorded by the egress DSP/NP (decimal representation of a 64 bit number: 1 - 1.844674407*1019).
Number of Audio Bytes Received as recorded by the egress DSP/NP (decimal representation of a 64 bit number: 1 - 1.844674407*1019).
Number of Audio Packets Received as recorded by the egress DSP/NP (decimal representation of a 64 bit number: 1 - 1.844674407*1019).
The maximum interarrival packet jitter time (in millisecond) recorded by the egress DSP/NP. This field is a decimal representation of a 16-bit number, hence must be in the range 0-65535 (This is applicable to RTCP statistics for VoIP calls only).
The last measurement for latency (in milliseconds) as recorded by the egress DSP. This field is a decimal representation of a 16-bit number, hence must be in the range 0-65535 (applicable to RTCP statistics for VoIP calls only).
This field contains a decimal value up to 10 digits, and logs the maximum duration between received packets, in milliseconds, on ingress side of the call.
This field contains a decimal value up to 10 digits, and logs the maximum duration between received packets, in milliseconds, on egress side of the call.
This field summarizes the DSP media quality for the most recent 31 time intervals of the ingress leg of the call. The default time interval is 20,000 milliseconds or 20 seconds. Customize this time interval via the CLI:
The playout buffer quality is averaged over this interval and then quantized into one of four discrete levels characterized by the bit patterns:
Data for the most recent 31 time intervals is recorded. These 62 bits of data (31 intervals x 2 bits/interval) are represented in CDR as a 16-character hexadecimal value. An end of data token (bit pattern 11) is used to indicate start of valid data. All data to the left of the token is invalid, while all data to the right is valid.
This field contains 16 hexadecimal characters without the "0x" prefix. Hex characters "A" through "F" are capitalized. If a DSP resource was not used for the ingress leg of the call, this field is empty ("").
The table below presents several example field values and the explanation of each.
The length of the first measurement interval can range between 0 milliseconds and the configured interval length.
This field summarizes the DSP media quality for the most recent 31 time intervals of the egress leg of the call.
This field contains 16 hexadecimal characters without the "0x" prefix. Hex characters "A" through "F" are capitalized. If a DSP resource was not used for the egress leg of the call, this field is empty ("").
See Ingress Packet Playout Buffer Quality for a full explanation of this field.
This field indicates the type of answer that was detected when ANSWER SUPERVISION was in effect for the call.
Answer Supervision mechanism ensures calls are correctly cut through and accounted for when answer signaling is absent from the call flow. When enabled, a timer starts when the egress call setup occurs, and then clears when the call is answered. If the timer expires an action is initiated to either clear the call or declare the call answered and cut through the forward voice path.
ANSWER SUPERVISION may be configured for all signaling prototypes except GSX/
If ANSWER SUPERVISION is disabled, an answer type of empty (""), is presented in all records.
This field takes a decimal value in the range 1-2, or remains empty (""), as summarized in the following table:
This field contains Feature Specific Data for a SIP REFER (Blind Transfer) or SIP Replaces (Attended Transfer) operation is performed on the ingress leg of a SIP to SIP call.
SIP REFER data is populated if a 'SIP REFER' request is received. SIP REPLACES data is populated if a 'SIP INVITE with Replaces' or 'SIP REFER with Replaces' header message is received. If the SIP REFER or SIP REPLACES operation is absent on this leg of the call, this field is empty ("").
The maximum length of this field is 81 characters, including all commas and double quotes ("").
The format of the SIP REFER Feature Specific Data field is:
"SREF,<number of subfields>,<TimeFromInviteToRefer>,<transferor's number>,<new transfer target number>"
Inspect the CDR of the B>C call to determine whether the SIP REFER is successful:
The format of the SIP REFER Feature Specific Data field is:
"SREF,<number of subfields>,<TimeFromInviteToRefer>,<transferer's number>,<new transfer target number>"
The following table details each of these subfields.
Inspect the CDR of the B>C call to determine whether the SIP Refer is successful:
The example string:
"SREF,3,523,7817771111,9787771111"
indicates that a SIP Refer by party B (7817771111) to party C (9787771111) is received 5.23 seconds after receiving the setup message (INVITE).
The format of the SIP Replaces Feature Specific Data field is:
"SREPL,<number of subfields>,<Time>,<opLeg>,<legId>,<peerCallGcid>, <peerCallLegId>"
The following table details each of these subfields.
The example string:
"SREPL,5,625,1,0,0x00060001,0"
indicates INVITE with REPLACES was received 6.25 seconds after the initial setup (INVITE) message. This call's ingress leg Replaces the peer (GCID x00060001) call's ingress leg.
SIP REFER with Replaces
The format of the SIP REFER with Replaces Feature Specific Data field is:"SREFREPL,<number of subfields>,<Time>,<opLeg>,<legId>,<peerCallGcid>, <peerCallLegId>"
The following table details each of these subfields.
The example string:
"SREFREPL,5,750,1,0,0x00080002,0"
indicates REFER with REPLACES was received 7.50 seconds after the initial setup (INVITE) message. This call's ingress leg Replaces the peer (GCID x00080002) call's ingress leg.
This field contains Feature Specific Data for a SIP REFER (Blind Transfer) or SIP Replaces (Attended Transfer) operation is performed on the egress leg of a SIP to SIP call.
SIP REFER data is populated if a 'SIP REFER' request is received. SIP REPLACES data is populated if a 'SIP INVITE with Replaces' or 'SIP REFER with Replaces' header message is received. If the SIP REFER or SIP REPLACES operation is absent on this leg of the call, this field is empty ("").
The maximum length of this field is 81 characters, including all commas and double quotes ("").
See "Ingress SIP REFER-Replaces Feature Specific Data" above for details about each of subfield of SIP REFER, SIP INVITE with Replaces, and SIP REFER with Replaces feature-specific data fields.
This field is populated when a Network Transfer occurs.
The format of the field is:"NWXF,<number of subfields>,<Speed Dial Digits>,<RefTod>, <NTCallType>"
The following table
details each of these subfields.
The maximum length of this field is 54 characters, including all commas and double quotes ("").
The example string:
"NWXF,3,100,18007817788,25" indicates that Network Transfer of type "Network Transfer Courtesy" is initiated by "18007817788" by dialing speed dial digits "100".
This field provides the criteria for determining the AMA call type value for billing records. This value is generated by the PSX and based on the type of call along with other network information such as terminating call, inter-network call, intra-network call, etc. This two-digit decimal field takes a value from 0-39, that maps to the call conditions described in the Call Condition Criteria table.
This field provides the toll indication for the call. This value is generated by the PSX. This two- digit decimal field takes a value from 0-64, that maps to the toll indicators described in the table.
This field contains the digits from the Generic Number "number" subfield, and is located in ISUP signaling messages received at the gateway, such as IAM, SGM, etc. This string is up to 30 characters. If no "number" was included in ISUP messages associated with this call, then this field is empty ("").
An example of this field is:
"01793601014"
This one-decimal digit field provides the Presentation Restriction Indication for the Generic Number "number" subfield described above. This field is presented in ISUP signaling messages received at the gateway, such as IAM, SGM, etc. and takes the values enumerated in the following table.
This two-digit field provides the numbering plan for the Generic Number "number" subfield (above) and is located in ISUP signaling messages received at gateway, such as IAM, SGM, etc. This field takes the values enumerated in the following table:
This three-digit field provides the Nature of Address for the generic number "number" subfield described above. This field is presented in ISUP signaling messages received at the gateway, such as IAM, SGM, etc., and takes the values enumerated in the Generic Number NOA Values table.
This two-digit field indicates the type of the Generic Number "number" subfield, and is presented in ISUP signaling messages received at the gateway, such as IAM, SGM, etc. The generic number "type" depends on the ISUP variant that is in effect. The 'Generic Number Type Values table enumerates the valid types for particular variants.
This one-digit decimal field indicates whether this is the final record written for a call. This field applies only to the ATTEMPT record and takes the values enumerated in the following table:
This is a one-byte hexadecimal field without a leading "0x". This field is either empty ("") or contains the hex code representing the originating trunk type. This field is associated with the corresponding field of the trunk group screen on the PSX, and takes the values enumerated in the following table.
A one-byte hex field without leading "0x" that takes values enumerated in the Final ATTEMPT indicator table. Field is either empty ("") or contains hex code representing terminating trunk type, and is associated with corresponding field of PSX trunk group screen.
This one-digit decimal field indicates whether a CDR record contains billing information from the destination GSX/
This four-digit decimal field details the GSX/
This field is populated when a call is released before invoking call control in the GSX/
This field occurs only in ATTEMPT records when both of the following conditions are met. Otherwise, this field is empty ("").
The Extra Disconnect Reason Codes table details the contents of this field.
This field contains the VPN private presence number for VPN originated calls, and is populated from the PSX policy response. This field is only populated under following conditions:
This field contains a string of up to 30 characters, or is empty. An example of this field is "8189".
This field contains the VPN public presence number for VPN originated calls in E-164 format. This field is populated from the PSX policy response. This field is only populated under following conditions:
This field contains a string of up to 30 characters, or is empty. An example of this field is:
"19786543210, 441793123456"
This field contains up to 400 bytes of binary data (represented by up to 800 hexadecimal characters) generated by the PSX. The External Furnish Charging Info (FCI) data comes from external source such as a Service Control Point (SCP), a Global System for Mobile Communication (GSM), or a Service Control Function (SCF). This FCI field is only present while some external service populates the data for a call involving Customized Application of Mobile Enhanced Logic (CAMEL) services.
The PSX passes the FCI field to GSX/
FCI data is divided into three portions:
The FCI Variant ID contains a single byte FCI Variant ID value. This value is used to determine the format of the rest of the data. Value 1 is defined for CAP (this is the only value currently defined for this GSX/SBC software release). In the future this FCI Variant ID may be extended to include the Intelligent Networking Application Part (INAP) and others.
The Leg Count contains a single byte count indicating how many sets of data are present. For FCI data of CAP, there is one set of data per Leg ID. For example, if FCI data is only present for leg 1, then the Leg Count is set to 1. If FCI data is present for leg 1 and leg 2, then the Leg Count is set to "2".
For CAP variant specific data, each set of FCI data contains three sub-fields, Leg ID, Data Length, and Data. The Leg ID field determines the call leg. For CAP this is either 1 or 2. The Data Length field determines the variable length of the FCI data. The FCI data can be up to 160 bytes per leg. The actual FCI Data field contains the binary data as received by PSX from the external sources.
This 20-digit decimal field contains the number of ingress packets discarded due to policing. If no ingress packets are discarded by policers, this field is empty ("").
This 20-digit decimal field contains the number of egress packets discarded due to policing. If no egress packets are discarded by policers, this field is empty ("").
This five-digit decimal field contains the announcement ID of the last announcement played by the GSX/SBC for the call. If no announcement is played, this field is empty ("").
This field describes the Source Information type for the call, based on the ISUP signaling received at the gateway, or from information received from the PSX. This two-digit decimal field takes a value of 0-15, enumerated in Table 79 . If no source information is received, this field is empty ("").
This four-digit decimal field describes the Partition used based on the ISUP signaling received at the gateway, or from information received from the PSX.
This field takes a decimal value in the range 0 to 4095. If no partition ID information is received, this field is empty ("").
This five-digit decimal field describes the Network used based on ISUP signaling received at the gateway, or from information received from the PSX.
This field takes a decimal value in the range 0 to 32767. If no network information is received, this field is empty ("").
This five-digit decimal field describes the N Class of Service (NCOS) for this call, based on the ISUP signaling received at the gateway, or from information received from the PSX.
This field takes a decimal value in the range 0 to 65535. If no NCOS information is received, this field is empty ("").
This seven-character field displays the Crypto information used for setting up RTP and RTCP for the ingress leg. If Secure RTP is configured and used on the call, each field will contain four (4) sub-fields indicating the RTP authentication and encryption values and the RTCP authentication and encryption values selected. Each subfield is separated by ":". If regular RTP is used, the field is left blank.
The possible values for RTP and RTCP Authentication sub-fields are listed in the following table. The possible values for RTP and RTCP Encryption sub-fields are listed in the "Values for RTP and RTCP Encryption Sub-Field" table.
The sub-field string:
"1:0:1:0"
indicates SHA1_80 authenticated SRTP, unencrypted SRTP, and SHA1_80 authenticated SRTCP, unencrypted SRTCP.
This seven-character field displays the Crypto information used for setting up RTP and RTCP for the egress leg. If Secure RTP is configured and used on the call, each field will contain four (4) sub-fields indicating the RTP authentication and encryption values and the RTCP authentication and encryption values selected. Each subfield is separated by ":". If regular RTP is used, the field is left blank. The possible values for RTP and RTCP Authentication sub-fields are listed in Table 76. The possible values for RTP and RTCP Encryption sub-fields are listed in the below table-.
The sub-field string:
"1:0:1:0"
indicates SHA1_80 authenticated SRTP, unencrypted SRTP, and SHA1_80 authenticated SRTP, unencrypted SRTP.
This field contains an enumerator describing the ISDN Access Indicator value from the Forward Call Indicator parameter. The Forward Call Indicator parameter is an optional parameter in incoming signaling messages such as IAM (ISUP), SETUP (ISDN), and INVITE (SIP). This field is either one decimal digit or empty (""). The defined enumerations are:
This field contains an enumeration that describes the Location value from the Cause Indicator parameter in the release message. The Cause Indicator parameter is an optional parameter in call disconnect signaling messages such as REL (ISUP) and DISCONNECT (ISDN). When the call is released by the network, this field will contain the Location value from the Cause Indicator parameter received by the
When the
Not currently supported by
This field contains an enumeration describing the Location value from the Cause Indicator parameter in the release message sent to the ingress network. The Cause Indicator parameter is an optional parameter in call disconnect signaling messages such as REL (ISUP) and DISCONNECT (ISDN). This field is 1-2 decimal digits or empty ("").
The defined enumerations are shown in the table, "Location Value from Cause Indicator Parameter".
This field contains an enumeration describing the Location value from the Cause Indicator parameter in the release message sent to the egress network. The Cause Indicator parameter is an optional parameter in call disconnect signaling messages such as REL (ISUP) and DISCONNECT (ISDN). This field is 1-2 decimal digits or empty ("").
The defined enumerations are shown in the table "Location Value from Cause Indicator Parameter".
This field contains an enumeration describing the Call Identity from ISUP Network Call Reference parameter. The Network Call Reference parameter is an optional signaling parameter. This field is up to eight decimal digits or empty ("").
This field contains an enumeration describing the Signalling Point Code from the optional ISUP Network Call Reference parameter. This field is up to five decimal digits or empty ("").
The ingress ISUP MIME Protocol Variant Specific Data. A string with delimiters "" or empty. The string has multiple sub-fields separated by a comma (,). An empty sub-field is represented by either two consecutive commas (,,) or by comma-space-comma (, ,). Whenever any ingress service group has ISUP MIME Protocol Variant Specific Data to log, this data is logged to this field.
An example of this field is:
"JAPAN,0,0, ,,,,...,0x04"
See the following for the Ingress ISUP MIME Protocol Variant Specific Data:
The egress ISUP MIME Protocol Variant Specific Data. A string with delimiters "" or empty. The string has multiple sub-fields separated by a comma (,). An empty sub-field is represented by either two consecutive commas (,,) or by comma-space-comma (, ,). Whenever any egress service group has ISUP MIME Protocol Variant Specific Data to log, this data is logged to this field.
An example of this field is:
"JAPAN,0,0, ,,,,...,0x04"
See the following for the Egress ISUP MIME Protocol Variant Specific Data:
This field represents the types of detected Modem tones in a call. If no modem is detected, this field is empty. The following table lists the possible Modem tone types.
The field represents the power level of Modem Tone Signal. The value returned is in -dBm0 with a range from 0 to 36 where 0 represents the strongest signal and 36 the weakest signal. If no modem is detected, this field is empty.
This field displays the Video Codec Data and contains four subfields separated by commas. The maximum length of this field is 512 characters, including all commas and double quotes ("").
The Video Bandwidth subfields are empty in START/INTERMEDIATE records. The Video Call Duration subfields are empty in START/INTERMEDIATE/ATTEMPT records.
The format of the Video Codec Data field is:
"Bandwidth,Duration,<localIpAddr>:<localIpPort>/<remoteIpAddr>:<remoteIpPort>,<localIpAddr>:<localIpPort>/<remoteIpAddr>:<remoteIpPort>"
An example of this field is:
"64,250,10.1.1.1:40/10.1.1.2:80,10.1.1.1:40/10.1.1.2:80"
The following table details each of the subfields.
Displays statistical data related to the Video Codec feature with up to 14 subfields () separated by a comma (,). The maximum length of this field is 512 characters, including all commas and double quotes ("").
Each subfield contains a decimal value between 0 - 4294967295.
An example of this field is:
"60,10,500,2100,2,0,100,5,500,10,0,0,0,"
The Customer field indicates the Trunk Group Number received in the Route Information K-ISUP parameter used to identify the ingress carrier. Decimal value 1 to 4 digits or empty.
The Call to Test PSX field indicates if a call is for a Test PSX, and is determined based on the Calling Party Number. Boolean field with the following usage:
The PSX Overlap Route Requests field indicates the number of routing requests sent to the PSX by the GSX/
The Call Setup Delay field indicates the setup latencies of Key Performance Indicators (KPI) for the purpose of troubleshooting and monitoring and contains decimal-value sub-fields separated by commas (,). The maximum length of this field is 21 characters, including all commas and double quotes ("").
Subfields:
An example of a Call Setup Delay field is:
"88,931,19,983"
This field (decimal, 1-3 digits, or empty) indicates the congestion level for monitored resources on the node or server that processes this call.
The Congestion Levels are as follows:
0 - No Congestion
1 - System Machine Congestion (MC) Level one congestion
2 - System Machine Congestion (MC) Level two congestion
3 - System Machine Congestion (MC) Level three congestion
The Ingress DSP data field is used to report Ingress DSP Data to assist in troubleshooting and monitoring. Each bit indicates a setting where Bit 0 is LSB and bit 15 is MSB. An example of this field is: "12FF".
The Egress DSP data field is used for reporting Egress DSP Data to assist in troubleshooting and monitoring, where each bit indicates a setting. An example of this field is: "12FF".
For details on Bit fields and Bit values, see the tables in "Ingress DSP Data" section above.
This field is populated for populated for SIPrec and NICE-based call recording. NICE Systems using their forwarding based protocol (based on the SIP forwarding extension) provide a mechanism for recording calls. SBC 9000 acts as a forwarding capable device which routes the content of an active call to a recording system. When a call is tapped an indication is provided in the "STOP" CDR field for that call along with the transmit and receive RTP stream IP address and port.
This field specifies whether the NICE Systems recording feature is enabled or disabled. It can accept "Yes" or empty. The length of this field can be up to 3 characters.
This field is populated for populated for SIPrec and NICE-based call recording. This field contains the RTP transmitting IP address if the NICE Systems recording feature is enabled. If the NICE systems recording feature is not enabled, then this field is empty. The length of this field can be up to 39 characters. IP address can be in IPv4 or IPv6 format. For IPv4 address type, use the dotted decimal format (for example, 128.1.22.233) and for IPv6 address type, use the hexadecimal format (for example, 3ffe:1900:4545:3:200:f8ff:fe21:67cf (up to 39 characters)).
This field is populated for populated for SIPrec and NICE-based call recording.This field contains the RTP transmitting port number if the NICE Systems recording feature is enabled. If the NICE systems recording feature is not enabled, then this field is empty. The length of this field can be up to 5 characters.
This field is populated for populated for SIPrec and NICE-based call recording. This field contains the RTP receiving IP address if the NICE Systems recording feature is enabled. If the NICE systems recording feature is not enabled, then this field is empty. The length of this field can be up to 39 characters. IP address can be in IPv4 or IPv6 format. For IPv4 address type, use the dotted decimal format (for example, 128.1.22.233) and for IPv6 address type, use the hexadecimal format (for example, 3ffe:1900:4545:3:200:f8ff:fe21:67cf (up to 39 characters)).
This field is populated for populated for SIPrec and NICE-based call recording. This field contains the RTP receiving port number if the NICE Systems recording feature is enabled. If the NICE systems recording feature is not enabled, then this field is empty. The length of this field can be up to 5 characters.
This field indicates the precedence level of the call. The values are:
If field is empty, then MLPP feature is not enabled.
This field is a 20-byte array used for Call Data Record (CDR) correlation. Each byte contains two ASCII characters. ISUP Signaling profile flag GCR is supported on ingress or egress side.
Example: 456f1c000300000025180000
This decimal field displays the R-Factor of the inbound RTP stream for the ingress trunk group.
The length of this field is up to two places.
This decimal field displays the R-Factor of the outbound RTP stream for the ingress trunk group.
The length of this field is up to two places.
This decimal field displays the R-Factor of the inbound RTP stream for the egress trunk group.
The length of this field is up to two places.
This decimal field displays the R-Factor of the outbound RTP stream for the egress trunk group.
The length of this field is up to two places.
This field provides the data for all core audio, video, and text streams.
This compound field shows transport-related information, such as:
Example:
Media Stream Data | [STO:230] | |
Number of Streams | [sf: 1] | 06 |
mediaType1 | [sf: 2] | audio |
streamIndex1 | [sf: 3] | 1 |
ingress codec used1 | [sf: 4] | G711 |
ingress local IP1 | [sf: 5] | 10.54.54.26:1032 |
ingress remote IP1 | [sf: 6] | 10.70.54.114:1026 |
ingress SRTP Info1 | [sf: 7] | 0:0:0:0 |
ingress bw1 | [sf: 8] | 124 |
egress codec Used1 | [sf: 9] | G711 |
egress local IP1 | [sf: 10] | 10.54.56.26:1032 |
egress remote IP1 | [sf: 11] | 10.70.59.103:1036 |
egress SRTP info1 | [sf: 12] | 0:0:0:0 |
egress bw1 | [sf: 13] | 124 |
ingress private leg local EP1 | [sf: 14] | 10.54.4.101:1116 |
ingress private leg remote EP1 | [sf: 15] | 10.54.4.171:1094 |
egress private leg local EP1 | [sf: 16] | 10.54.4.101:1118 |
egress private leg remote EP1 | [sf: 17] | 10.54.6.171:1090 |
mediaType2 | [sf: 18] | video |
streamIndex2 | [sf: 19] | 2 |
ingress codec used 2 | [sf: 20] | H263 |
ingress local IP2 | [sf: 21] | 10.54.54.26:1034 |
ingress remote IP2 | [sf: 22] | 10.70.54.114:1024 |
ingress SRTP info2 | [sf: 23] | 0:0:0:0 |
ingress bw2 | [sf: 24] | 2000 |
egress codec used2 | [sf: 25] | H263 |
egress local IP2 | [sf: 26] | 10.54.56.26:1034 |
egress remote IP2 | [sf: 27] | 10.70.59.103:1034 |
egress SRTP info2 | [sf: 28] | 0:0:0:0 |
egress bw2 | [sf: 29] | 2000 |
ingress private leg local EP2 | [sf: 30] | 10.54.4.101:1116 |
ingress private leg remote EP2 | [sf: 31] | 10.54.4.171:1094 |
egress private leg local EP2 | [sf: 32] | 10.54.4.101:1118 |
egress private leg remote EP2 | [sf: 33] | 10.54.6.171:1090 |
mediaType3 | [sf: 34] | text |
streamIndex3 | [sf: 35] | 3 |
ingress codec used3 | [sf: 36] | T140 |
ingress local IP3 | [sf: 37] | 10.54.54.26:1036 |
ingress remote IP3 | [sf: 38] | 10.70.54.114:1028 |
ingress SRTP info3 | [sf: 39] | 0:0:0:0 |
ingress bw3 | [sf: 40] | 4 |
egress codec used3 | [sf: 41] | T140 |
egress local IP3 | [sf: 42] | 10.54.56.26:1036 |
egress remote IP3 | [sf: 43] | 10.70.59.103:1038 |
egress SRTP info3 | [sf: 44] | 0:0:0:0 |
egress bw3 | [sf: 45] | 4 |
ingress private leg local EP3 | [sf: 46] | 10.54.4.101:1116 |
ingress private leg remote EP3 | [sf: 47] | 10.54.4.171:1094 |
egress private leg local EP3 | [sf: 48] | 10.54.4.101:1118 |
egress private leg remote EP3 | [sf: 49] | 10.54.6.171:1090 |
mediaType4 | [sf: 50] | audio |
streamIndex4 | [sf: 51] | 4 |
ingress codec used4 | [sf: 52] | G711 |
ingress local IP4 | [sf: 53] | 10.54.54.26:1032 |
ingress remote IP4 | [sf: 54] | 10.70.54.114:1026 |
ingress SRTP info4 | [sf: 55] | 0:0:0:0 |
ingress bw4 | [sf: 56] | 124 |
egress codec used4 | [sf: 57] | G711 |
egress local IP4 | [sf: 58] | 10.54.56.26:1032 |
egress remote IP4 | [sf: 59] | 10.70.59.103:1036 |
egress SRTP info4 | [sf: 60] | 0:0:0:0 |
egress bw4 | [sf: 61] | 124 |
ingress private leg local EP4 | [sf: 62] | 10.54.4.101:1116 |
ingress private leg remote EP4 | [sf: 63] | 10.54.4.171:1094 |
egress private leg local EP4 | [sf: 64] | 10.54.4.101:1118 |
egress private leg remote EP4 | [sf: 65] | 10.54.6.171:1090 |
mediaType5 | [sf: 66] | video |
streamIndex5 | [sf: 67] | 5 |
ingress codec used5 | [sf: 68] | H263 |
ingress local IP5 | [sf: 69] | 10.54.54.26:1034 |
ingress remote IP5 | [sf: 70] | 10.70.54.114:1024 |
ingress SRTP info5 | [sf: 71] | 0:0:0:0 |
ingress bw5 | [sf: 72] | 2000 |
egress codec used5 | [sf: 73] | H263 |
egress local IP5 | [sf: 74] | 10.54.56.26:1034 |
egress remote IP5 | [sf: 75] | 10.70.59.103:1034 |
egress SRTP info5 | [sf: 76] | 0:0:0:0 |
egress bw5 | [sf: 77] | 2000 |
ingress private leg local EP5 | [sf: 78] | 10.54.4.101:1116 |
ingress private leg remote EP5 | [sf: 79] | 10.54.4.171:1094 |
egress private leg local EP5 | [sf: 80] | 10.54.4.101:1118 |
egress private leg remote EP5 | [sf: 81] | 10.54.6.171:1090 |
mediaType6 | [sf: 82] | text |
streamIndex6 | [sf: 83] | 6 |
ingress codec used6 | [sf: 84] | T140 |
ingress local IP6 | [sf: 85] | 10.54.54.26:1036 |
ingress remote IP6 | [sf: 86] | 10.70.54.114:1028 |
ingress SRTP info6 | [sf: 87] | 0:0:0:0 |
ingress bw6 | [sf: 88] | 4 |
egress codec used6 | [sf: 89] | T140 |
egress local IP6 | [sf: 90] | 10.54.56.26:1036 |
egress remote IP6 | [sf: 91] | 10.70.59.103:1038 |
egress SRTP info6 | [sf: 92] | 0:0:0:0 |
egress bw6 | [sf: 93] | 4 |
ingress private leg local EP6 | [sf: 94] | 10.54.4.101:1116 |
ingress private leg remote EP6 | [sf: 95] | 10.54.4.171:1094 |
egress private leg local EP6 | [sf: 96] | 10.54.4.101:1118 |
egress private leg remote EP6 | [sf: 97] | 10.54.6.171:1090 |
The length of the Media Stream Data field depends on the "Number of Streams", which is the first sub-field. For a call with single stream, only sub-field #1 to sub-field #17 will be present. For calls with multiple streams, sub-field #2 to sub-field #17 will be repeated for each stream.
This field provides the statistics for all core audio, video, and text streams.
Example:
Media Stream Statistics | [STO:231] | |
Number of Streams | [sf: 1] | 03 |
mediaType1 | [sf: 2] | audio |
streamIndex1 | [sf: 3] | 1 |
ingress packetSent1 | [sf: 4] | 3246 |
ingress packetReceived1 | [sf: 5] | 3091 |
ingress octetSent1 | [sf: 6] | 519360 |
ingress octetReceived1 | [sf: 7] | 494560 |
ingress packetLost1 | [sf: 8] | 0 |
ingress packetDiscarded1 | [sf: 9] | 0 |
egress packetSent1 | [sf: 10] | 3091 |
egress packetReceived1 | [sf: 11] | 3246 |
egress octetSent1 | [sf: 12] | 494560 |
egress octetReceived1 | [sf: 13] | 519360 |
egress packetLost1 | [sf: 14] | 0 |
egress packetDiscarded1 | [sf: 15] | 0 |
mediaType2 | [sf: 16] | video |
streamIndex2 | [sf: 17] | 2 |
ingress packetSent2 | [sf: 18] | 1396 |
ingress packetReceived2 | [sf: 19] | 1614 |
ingress octetSent2 | [sf: 20] | 532687 |
ingress octetReceived2 | [sf: 21] | 831526 |
ingress packetLost2 | [sf: 22] | 32 |
ingress packetDiscarded2 | [sf: 23] | 0 |
egress packetSent2 | [sf: 24] | 1614 |
egress packetReceived2 | [sf: 25] | 1396 |
egress octetSent2 | [sf: 26] | 831526 |
egress octetReceived2 | [sf: 27] | 532687 |
egress packetLost2 | [sf: 28] | 34 |
egress packetDiscarded2 | [sf: 29] | 0 |
mediaType3 | [sf: 30] | text |
streamIndex3 | [sf: 31] | 3 |
ingress packetSent3 | [sf: 32] | 29 |
ingress packetReceived3 | [sf: 33] | 52 |
ingress octetSent3 | [sf: 34] | 481 |
ingress octetReceived3 | [sf: 35] | 824 |
ingress packetLost3 | [sf: 36] | 0 |
ingress packetDiscarded3 | [sf: 37] | 0 |
egress packetSent3 | [sf: 38] | 52 |
egress packetReceived3 | [sf: 39] | 29 |
egress octetSent3 | [sf: 40] | 824 |
egress octetReceived3 | [sf: 41] | 481 |
egress packetLost3 | [sf: 42] | 0 |
egress packetDiscarded3 | [sf: 43] | 0 |
The Media Stream Stats field (231 of STOP record) is updated to log TCP/LYNC/APPSHARE, when the SBC accepts a media stream of media type of desktop sharing on protocol TCP/RTP/AVP or TCP/RTP/SAVP.
Transcode Indicator is a Boolean value to indicate whether transcoded is used. A value of “1” indicates transcoding between the two call legs and "0" means no transcoding.
HD Codec Rate is a decimal value field to hold the HD codec rate per leg.
Remote RTCP statistics are populated in STOP CDR for both pass-through and transcoded calls based on the following conditions, as applicable:
This feature is supported in the following call scenarios:
The Remote Ingress Audio RTCP Learned Metrics field indicates statistics received from Ingress endpoint in SR/RR RTCP Packet. The maximum length of this field is 1024 characters, including all commas and double quotes ("").
Subfields:
An example of a Remote Ingress Audio RTCP Learned Metrics field is: "137,71200,0x452272d,0,0,0,28853,193".
The Remote Egress Audio RTCP Learned Metrics field indicates statistics received from Egress endpoint in SR/RR RTCP Packet. The maximum length of this field is 1024 characters, including all commas and double quotes ("").
Subfields:
Egress Packets Sent - Received as part of RTCP Packet from Egress. It is the total number of RTP data packets transmitted by the sender since starting transmission up until the time this SR packet was generated.
An example of a Remote Egress Audio RTCP Learned Metrics field is: "137,71200,0x452272d,0,0,0,28853,193".
SBC Call Data Record (CDRs) support storing Major Trading Area (MTA) information in CDRs. MTA is a boundary that segments a country for telecommunication licensing and consists of several Basic Trading Areas (BTAs). PSX can route the call based on MTA of calling and called parties. This record is a string, which may contain up to 49 characters. The content of this record depends upon the feature control profile and NPA NXX configuration in PSX.
If PSX determines MTA for calling and called parties, then PSX returns this information to SBC. Otherwise, the CDR field MTA Information is empty (“”).
This field is formatted as a quoted string of four comma-separated values. The values include; Origination Primary MTA, Origination Secondary MTA, Destination Primary MTA, and Destination Secondary MTA. For example, ...,"18,11,08,11"....
The following table provides the MTA stream accounting information:
SBC Call Data Record (CDRs) support storing Value Based Routing (VBR) information in CDRs.
The following fields are used to populate VBR details in SBC CDRs:
The following table provides the VBR stream accounting information:
This record is a string of 256 characters. SBC receives the VBR Billing Information in the policy response and writes it to CDR.
This field is optional and is populated when the PSX returns the VBR Route.
The PSX captures the following common or global VBR information and sends it in the policy response:
The Sell/Offer price is present, if an Offer rate sheet is configured on the selected offer. SBC includes this data in the VBR Common Billing Data.
This record is a string of 256 characters. For every route that is part of VBR routing label, the billing information is captured as per route data in the policy/trigger response by PSX and is sent to SBC. SBC treats it as opaque data and writes it to CDR. This field is optional. This is populated when the PSX returns a VBR Route.
For every route (routing label route) within a policy response, the following information is captured:
The Vendor Id represents the vendor who owns the Trunk Group. The cost is derived from active vendor rate sheet. The jurisdiction represents the jurisdiction associated with the selected rate sheet entry of the vendor. This may vary from vendor to vendor. For non VBR routes, this AVP will be empty. A maximum of 10 routes is considered for VBR Billing data purposes.
SBC includes the access-network-charging-info parameter received through PCRF over the Rx or Gx interfaces in the P-charging-vector header field in the first request or response originated by UE. When the charging information is available in SBC after the local resource reservation is complete, UE traverses the SBC. If P-CSCF receives Access Network Charging Information from PCRF server, P-CSCF sends Access Network Charging Information in the CAM records.
The format for Access Network Charging Information is "Character string, Max length 130".
Example: ggsn=10.10.0.1; auth-token=0;pdp-info=pdp-item=uniqueNum;pdp-dig=no;gcid=gcIdValue;flow-id=({0,0})
The location records for Access Transfer Specific Data are START, STOP, ATTEMPT, and INTERMEDIATE.
The following table details each of the sub-fields of Access Transfer Specific Data:
Both the Original and Target Call (Handover call) are considered as individual calls and have separate CDR that is generated for each call. In case of a PS-to-PS handover call, the field "Access Transfer Specific Data" of the Target call contains the following information:
All PS-to-PS Handover call can be identified by the "Transfer Type" indicated above and the source call which is handed over can be identified from the Source access GCID. The CDR of the original call does not have any indication that it is handed over to a new Target call. Any correlation of CDR must come backward by identifying the Target call and then tracing back the Original Call.
The "Emergency Indicator" indicates the IMS session as an IMS emergency session or IMS registration. This covers both INVITE and REGISTER messages.
The format for Emergency Indicator is "Boolean of max length 1".
The "Ingress Dtls-Srtp: Dtls-Srtp status info" indicates if the DTLS negotiation in the corresponding stream is successfully completed, the value is enabled or disabled for an ingress call.
The supported values are:
The "Egress Dtls-Srtp: Dtls-Srtp status info" indicates if the DTLS negotiation in the corresponding stream is successfully completed, the value is enabled or disabled for an egress call.
The supported values are:
The format for UE Roming Staus is as follows:
Values | Meaning |
---|---|
Empty | Without roaming |
1 | Subscriber |
2 | Called |
3 | Calling |
Prints the session bandwidth value signaled by Ingress EP.
Computed using the traffic received from Ingress Peer (session) for the call duration that is,
Computed Rx Session Bandwidth = Sum of all received bytes for call adjusted to Link value/Call Duration.
Computed using the traffic sent to Ingress Peer (session) for the call duration that is,
Computed Tx Session Bandwidth = Sum of all transmitted bytes for call leg adjusted to Link value/Call Duration.
Prints the reduction factor configured in the Ingress PSP, used for this call.
Represents the factor that is resulted in the measured bandwidth for the ingress relative to the allocated bandwidth. That is,
Estimated Reduction Factor = 1 - (Maximum of Send and Received Computed Bandwidth/Signaled Bandwidth).
Prints the session bandwidth value signaled by Egress EP.
Computed using traffic received from Egress Peer (session) for the call duration that is,
Computed Rx Session Bandwidth = Sum of all received bytes for call adjusted to Link value/Call Duration.
Computed using traffic sent to Egress Peer (session) for the call duration that is,
Computed Tx Session Bandwidth = Sum of all transmitted bytes for call leg adjusted to Link value/Call Duration.
Prints the reduction factor configured in the Egress PSP, used for this call.
Represent the factor that would have resulted in the measured bandwidth for the egress relative to the allocated bandwidth. That is,
Estimated Reduction Factor = 1 - (Maximum of Send and Received Computed Bandwidth / Signaled Bandwidth)
Additional Media Stream Statistics is a string field and contains additional sub-fields. The sub-fields are comma separated values, which are included in the string.
The following table decribes the sub-fields for Additional Media Stream Statistics:
Sub-field Number | Additional Media Stream Statistics | Size |
---|---|---|
1 | Entries per stream | 2 characters, for example: 4 |
2 | Number of streams | 2 characters, for example: 06 |
3 | ingress lostPktBursts1 | 5 characters, for example: 65535 |
4 | ingress lostPktSingles1 | 5 characters, for example: 65535 |
5 | ingress codecParams1 | 32 characters, for example: P:27:4;8 |
6 | egress lostPktBursts1 | 5 characters, for example: 65535 |
7 | egress lostPktSingles1 | 5 characters, for example: 65535 |
8 | egress codecParams1 | 32 characters, for example: P:27:4;8 |
9 | transcode indicator1 | 0 or 1 character, for example: 1 |
10 | ingress lostPktBursts2 | 5 characters, for example: 65535 |
11 | ingress lostPktSingles2 | 5 characters, for example: 65535 |
12 | ingress codecParams2 | This field is applicable only for stream 1. |
13 | egress lostPktBursts2 | 5 characters, for example: 65535 |
14 | egress lostPktSingles2 | 5 characters, for example: 65535 |
15 | egress codecParams2 | This field is applicable only for stream 1. |
16 | transcode indicator2 | 0 character, for example: 0 |
17 | ingress lostPktBursts3 | 5 characters, for example: 65535 |
18 | ingress lostPktSingles3 | 5 characters, for example: 65535 |
19 | ingress codecParams3 | This field is applicable only for stream 1. |
20 | egress lostPktBursts3 | 5 characters, for example: 65535 |
21 | egress lostPktSingles3 | 5 characters, for example: 65535 |
22 | egress codecParams3 | This field is applicable only for stream 1. |
23 | transcode indicator3 | 0 character, for example: 0 |
24 | ingress lostPktBursts4 | 5 characters, for example: 65535 |
25 | ingress lostPktSingles4 | 5 characters, for example: 65535 |
26 | ingress codecParams4 | This field is applicable only for stream 1. |
27 | egress lostPktBursts4 | 5 characters, for example: 65535 |
28 | egress lostPktSingles4 | 5 characters, for example: 65535 |
29 | egress codecParams4 | This field is applicable only for stream 1. |
30 | transcode indicator4 | 0 character, for example: 0 |
31 | ingress lostPktBursts5 | 5 characters, for example: 65535 |
32 | ingress lostPktSingles5 | 5 characters, for example: 65535 |
33 | ingress codecParams5 | This field is applicable only for stream 1. |
34 | egress lostPktBursts5 | 5 characters, for example: 65535 |
35 | egress lostPktSingles5 | 5 characters, for example: 65535 |
36 | egress codecParams5 | This field is applicable only for stream 1. |
37 | transcode indicator5 | 0 character, for example: 0 |
38 | ingress lostPktBursts6 | 5 characters, for example: 65535 |
39 | ingress lostPktSingles6 | 5 characters, for example: 65535 |
40 | ingress codecParams6 | This field is applicable only for stream 1. |
41 | egress lostPktBursts6 | 5 characters, for example: 65535 |
42 | egress lostPktSingles6 | 5 characters, for example: 65535 |
43 | egress codecParams6 | This field is applicable only for stream 1. |
44 | transcode indicator6 | 0 character, for example: 0 |
The transcode indicator BOOLEAN field is added to audio stream, where the value 1 indicates transcoding
and 0 indicates passthru
.
For more information, refer to Additional Media Stream Statistics Sub-fields for Audio Encoding for a description of the ingress codecParams1 and egress codec Params1 sub-fields.
This field provides the name of the Ingress zone.
This field provides the name of the Egress zone.
This field provides the ID of the Ingress zone.
This field provides the ID of the Egress zone.
The media type (Video) and CAC level (TG/zone/Shared...) of a video stream that pruned because the configured video threshold limit is reached is included as a new CAM field called "Video Cac". This field includes the media type (video) and the CAC level (TG, ZN, SH, EP....). This CAM field includes the following values, as applicable, when the video threshold level is reached:
The CDR includes "Ingress Trunk Group Name" field for both the ingress IPTG found with prefix match and the IPTG determined based on the SIP Message Manipulation (SMM). If SMM is not used to determine the ingress IPTG, the relevant CDR field is empty.
This field indicates the type of transcoder (Media Resource Function (MRF) or a TSBC) used for the call.
This field Stores MRF related information.
This field contains two sub-fields:
This field binds all the forked calls initiated by one incoming call.
First Forking recorder Tx IP Address.
First Forking recorder Tx port number.
First Forking recorder Rx IP Address.
First Forking recorder Rx Port Number.
Second Forking recorder Tx IP Address.
Second Forking recorder Tx port number.
Second Forking recorder Rx IP Address.
Second Forking recorder Rx port number.
Third Forking recorder Tx IP Address.
Third Forking recorder Tx port number.
Third Forking recorder Rx IP Address.
Third Forking recorder Rx port number.
The fields corresponding to Call Recorder 2 and Call Recorder 3 are supported in future release.
This field is added to the CAM records to indicate that the call was in a SO-SBC mode.
The SO-SBC field is a string field indicating the used signaling mode (global, onAnswer, onPolicyRsp....). The default is signaling only not set and this field will be empty.
Currently, only the global mode is supported.
The following are the proposed string values:
The following table lists the attributes for audio stream statistics:
The following table lists the attributes for audio stream RTCP-XR voice metric statistics:
The following table lists the attributes for media stream SRTP statistics:
Reason for a DSP resource’s inclusion in a media flow, or for its rejection upon request.
The reason include the following:
DSP insertion/rejection reason is in both the STOP record and ATTEMPT record.
A globally unique string corresponding to a Universally Unique Identifier (UUID)(RFC 4122).The purpose of the unique origination identifier is to assign an opaque identifier corresponding to the service provider-initiated calls themselves, customers, classes of devices, or other groupings that a service provider might want to use for determining things such as reputation or trace back identification of customers or gateway
Ingress PVSD STI Service Type
Secure Telephone Identity Service Type.
Ingress PVSD STI Service Status
Secure Telephone Identity Service Status.
Ingress PVSD STI Reason Code
Secure Telephone Identity SIP Reason Code. SIP reason code corresponding to the STI Service.
Egress PVSD Origination ID
A globally unique string corresponding to a Universally Unique Identifier (UUID)(RFC 4122).The purpose of the unique origination identifier is to assign an opaque identifier corresponding to the service provider-initiated calls themselves, customers, classes of devices, or other groupings that a service provider might want to use for determining things such as reputation or trace back identification of customers or gateway
Egress PVSD STI Service Type
Secure Telephone Identity Service Type.
Egress PVSD STI Service Status
Secure Telephone Identity Service Status.
Egress PVSD STI Reason Code
Secure Telephone Identity SIP Reason Code. SIP reason code corresponding to the STI Service.