Sansay CDR Interface Format Guide

Sansay Inc.
Page 1 of 13
------------------------------------------------------------------------
Sansay Proprietary 3/8/2010
VSX System
Call Detail Record Interface
Release 1.15
3/8/2010
Doc #: 0000000

Sansay Inc. San Diego, CA 92121

This document contains confidential and proprietary information that belongs to Sansay Inc. (Sansay). Using any of the information contained herein or
copying or imaging all or part of this document by any means is strictly forbidden without express written consent o f Sansay.

Sansay Inc. Page 2 of 13
------------------------------------------------------------------------

1 Scope ........................................................................................................................... 3
2 CDR Format ................................................................................................................ 3
2.1 CDR Header ........................................................................................................ 3
2.2 CDR body ........................................................................................................... 3
2.3 Detail Field Information ..................................................................................... 8
2.4 Release Causes .................................................................................................... 9
2.5 Sample CDR record .......................................................................................... 12
3 CDR File Storage/Retrieval ...................................................................................... 12
3.1 File Storage Policy ............................................................................................ 12
3.2 File Naming Convention ................................................................................... 13
3.3 File Retrieval Procedure ................................................................................... 13

------------------------------------------------------------------------
1 Scope

This document defines the Sansay CDR file format and the file retrieval process.

2 CDR Format
2.1 CDR Header

Parameter
Max ASCII
Characters

Description Notes
Record Sequence Number 9 Unique identification of this record
Version Number 5 Format version number of records to follow 1
Record Type 1 Type of CDR being generated 2
Record Data Variable Parameters as defined in section 2.3

Notes:
1. Current version: V1.13
2. Type: R Normal CDR record, A - Audit

CDR fields which do not have data will have NA. The character semi-colon (;) is used as the
field delimiter to separate the fields of a CDR record. Each CDR record in the file is separated
by line feed \n.

Starting from CDR V1.11 and above, users can choose to opt out the additional fields in
the CDR record and/or skip the intermediate records ( non-final failed call record).
Contact Sansay support for details. This means a system can use any version of the CDR
format under configuration control.

2.2 CDR body

Parameter Max ASCII
Characters
Description Notes comment
ConnectionType
16
Type of connection :

SessionID
32
Unique ID assigned to the call by
SSM subsystem

------------------------------------------------------------------------
Release Cause 4 2.4
Start Time of Date 32 Indicates Time of Date when the call
entered the system

Answer Time of Date 32 Indicates TOD when the call was
answered

Release TOD 32 Indicates the TOD when the call was
disconnected

Minutes West of
Greenwich Mean Time
32 Minutes West of Greenwich Mean
Time. Used to calculate the time
zone.

Release Cause from
Protocol Stack
32 Release cause string from either H323
or SIP protocol stack
New in
v1.1
Binary Value of Release
Cause from Protocol
stack
4 Binary value of the protocol release
cause
New in
v1.1
1
st
release dialogue 1 O: origination, T: termination New v1.1
Trunk ID -- Origination 6 TrunkID for origination
GW(resources)
use
previous
value
VoIP Protocol -
Origination
6 VoIP protocol for origination
dialogue

Origination Source
Number
128 Source Number in Origination
Dialogue

Origination Source Host
Name
128 FQDN or IP address for Source GW
in Origination Dialogue

Origination Destination
Number
128 Destination Number in Origination
Dialogue

Host Name
128 FQDN or IP address for Destination
GW in Origination Dialogue

Origination Call ID 128 Unique ID for the origination
dialogue(leg)

Origination Remote
Payload IP
Address
16 Remote Payload IP address for
origination dialogue

Origination Remote
Payload UDP
Address
6 Remote Payload UDP address for

Origination Local
Payload IP
Address
16 Local(SG) Payload IP address for

Origination Local
Payload UDP
Address
6 Local(SG) Payload UDP address for

Origination Codec List 128 Supported Codec list( separated by
comma) for origination dialogue

Origination Ingress
Packets
10 Number of Ingress( into Sansay
system) payload packets in

Origination Egress 10 Number of Egress( out from Sansay
------------------------------------------------------------------------
Packets system) payload packets in
Origination Ingress
Octets
system) payload octets in origination
dialogue

Origination Egress
Octets
10 Number of Egress( out from Sansay
system) payload octets in origination
dialogue

Origination Ingress
Packet Loss
system) payload packet loss in

Origination Ingress
Delay
10 Average Ingress( into Sansay system)
payload packets delay ( in ms) in

Origination Ingress
Packet Jitter
10 Average of Ingress( into Sansay
system) payload packet Jitter ( in ms)
in origination dialogue

Trunk ID -- Termination 6 TrunkID for termination
GW(resources)

VoIP Protocol -
Termination
6 VoIP protocol from termination GW
Termination Source
Number
128 Source Number in Termination
Dialogue

Termination Source Host
Name
128 FQDN or IP address for Source GW
in Termination Dialogue

Termination Destination
Number
128 Destination Number in Termination
Dialogue

Host Name
128 FQDN or IP address for Destination
GW in Termination Dialogue

Termination Call ID 128 Unique ID for the termination
dialogue(leg)

Termination Remote
Payload IP
Address
16 Remote Payload IP address for
termination dialogue

Termination Remote
Payload UDP
Address
6 Remote Payload UDP address for

Termination Local
Payload IP
Address
16 Local(SG) Payload IP address for
2.00,
2.10

Termination Local
Payload UDP
Address
6 Local(SG) Payload UDP address for
C,
2.00,
2.10

Termination Codec List 128 Supported Codec list( separated by
comma) for termination dialogue
C,
2.00,
2.10

Termination Ingress
Packets
I,
2.00,
2.10

------------------------------------------------------------------------
Termination Egress
Packets
f,
C,
2.00,
2.10

Termination Ingress
Octets
system) payload octets in
d,
2.00,
2.10

Termination Egress
Octets
system) payload octets in
g,
2.00,
2.10

Termination Ingress
Packet Loss
system) payload packet loss in
i,
2.00,
2.10
Payload
only
Should we
add
signaling
address
too?
Termination Ingress
Delay
10 Average Ingress( into Sansay system)
payload packets delay ( in ms) in
f,C,
2.00,
2.10

Termination Ingress
Packet Jitter
10 Average of Ingress( into Sansay
system) payload packet Jitter ( in ms)
in termination dialogue
d,
2.00,
2.10

Final Route Indication 1 F: Final Route Selection,
I: Intermediate Route Attempts
New in
V1.3
Routing Digits 64 Routing Digit (Digit after Inbound
translation, before Outbound
Translation).
V 1.4
Call Duration in Second 6 Call Duration in Seconds. 0 if this is
failed call
V 1.5
Post Dial Delay in
Seconds
6 Post dial delay( from call attempt to
ring). 0 if this is failed call
V 1.6
Ring Time in Second 6 Ring Time in Seconds. 0 if this is
failed call
V 1.6
Duration in mini-
seconds
10 Call duration in mini-seconds. V1.8
Conf ID 32 Unique Conference ID for this call V 1.9
RPID/ANI 32 Remote Party ID line V1.10
RouteEntryIndex 2 1-8, indicate the relative index in a
route entry
V1.11
RouteTable Used 5 1-59,999 V1.11
LNPDipped 1 The call has been through External
LNP server. 1: Yes, 0: No
VSXi V1.12
Ingress LRN 32 Routed Number (RN) from Ingress
Call Attempt
VSXi V1.12
Egress LRN 32 Egress RN sent to termination leg VSXi V1.12
CNAM Dipped 1 CNAM server has been queried for
this call, 1: Yes, 0: NO
VSXi V1.12
DNC Dipped 1 DNC ( Do Not Call) Server has been VSXi V1.12
------------------------------------------------------------------------
queried for this call, 1: Yes, 0: NO
Origination TID Alias
Name ( as configured in
Resource Page)
15 Could be used as CompanyID if
configured in resource Page
VSXi V1.13
Termination TID Alias
Name ( as configured in
Resource Page)
15 Could be used as CompanyID if
configured in resource Page
VSXi V1.13
External Route Server
Dipped
1 Did call query an ERS; 1: Yes; 0: No VSXi V1.14
OLI Digits 2 Inbound OLI Digits if they were
present
VSXi V1.15

------------------------------------------------------------------------

2.3 Detail Field Information
Field Size CSV Column
ConnectionType
16 D
SessionID
32 E
Release Cause 4 F
Start Time of Date 32 G
Answer Time of Date 32 H
Release TOD 32 I
Minutes West of Greenwich
Mean Time
32 J
Release Cause from Protocol
Stack
32 K
Binary Value of Release
Cause from Protocol stack
4 L
1
st
release dialogue 1 M
Trunk ID -- Origination 6 O
VoIP Protocol - Origination 6 P
Origination Source Number 128 Q
Origination Source Host
Name
128 R
Number
128 S
Origination Destination Host
Name
128
Origination Call ID 128 T
Origination Remote Payload
IP Address
16 U
Origination Remote Payload
UDP Address
6 V
Origination Local Payload IP
Address
16 W
Origination Local Payload
UDP Address
6 X
Origination Codec List 128 Y
Origination Ingress Packets 10 Z
Origination Egress Packets 10 AA
Origination Ingress Octets 10 AB
Origination Egress Octets 10 AC
Origination Ingress Packet
Loss
10 AD
Origination Ingress Delay 10 AE
Origination Ingress Packet
Jitter
10 AF
Trunk ID -- Termination 6 AG
VoIP Protocol - Termination 6 AH
Termination Source Number 128 AI
Termination Source Host 128 AJ
------------------------------------------------------------------------
Name
Number
128 AK
Termination Destination Host
Name
128 AL
Termination Call ID 128 AM
Termination Remote Payload
IP Address
16 AN
Termination Remote Payload
UDP Address
6 AO
Termination Local Payload
IP Address
16 AP
Termination Local Payload
UDP Address
6 AQ
Termination Codec List 128 AR
Termination Ingress Packets 10 AS
Termination Egress Packets 10 AT
Termination Ingress Octets 10 AU
Termination Egress Octets 10 AV
Termination Ingress Packet
Loss
10 AW
Termination Ingress Delay 10 AX
Termination Ingress Packet
Jitter
10 AY
Final Route Indication 1 AZ
Routing Digits 64 BA
Call Duration 6 BB
PDD 6 BC
Ring Time 6 BD
CallDuration in ms 10 BE
Conf ID 32 BF
RPID 32 BG
RouteEntryIndex 2 BH
RouteTable Used 5 BI
LNPDipped 1 BJ
Ingress Routed Number 32 BK
Egress Routed Number 32 BL
CNAM Dipped 1 BM
DNC Dipped 1 BN
Origination device Name ( as
configured in Resource Page)
15 BO
Termination device Name (as
configured in Resource Page)
15 BP
ERS Dipped 1 BQ
OLI Digits 2 BR

2.4 Release Causes

------------------------------------------------------------------------
The CDR records generated by the Sansay VSX contains four fields that can be used to
determine the exact cause of a call termination.

1. Session Release Causes: ( Field #3 in CDR body)

This is mainly for success calls (answered, ring no answer) calls. All the session release
cause of 00x indicates the call is not failed. (Field #3 in CDR body). For all the failed
calls, the released stack and stack release cause can provide more information.

Cause Code Descriptions
01 Normal answered call
02 No Answer, tear down by originator
03 No answer, tear down by the termination
04 NORMAL_NO_ANSWER, tear down by
system
402 Service Not Available
403 Termination capability un-compatible
404 Outbound digit translation failed
405 Termination reject for some other reasons
406 Termination Route is blocked
500 Originator is not in the Authorized list
(source verification failed)

501 Origination digit translation failed
502 Origination direction is not bi-directional or
inbound
503 Origination is not in service state
600 Max system call handling reached
601 System reject call
602 System outbound digit translation error
(maybe invalid configuration)
603 System inbound digit translation error
(Maybe invalid configuration)

2. 1
st
Release Dialogue ( Field #10 in CDR) - a one character value identifying
the side of the call that initiated the teardown.
O origination initiated the teardown.
T termination initiated the teardown.
N the VSX internally initiated the teardown.

3. Release Cause from Stack ( Field # 9 in CDR0 - an integer value based on the
releasing dialogues protocol.
------------------------------------------------------------------------
a. For a H.323 call leg originated release, It will be the returned Q.931 value
received from the release side.

Some of the Q.931 release causes;
3: No route to destination
16; Normal Clearing
17: User Busy
19: NO Answer from User
21; Call Rejected
28: Address Incomplete
34: No Circuit Channel Available
.

b. For a SIP call leg originated release, its the RFC 3261 release cause value
received from the release side.

The following is the list that VSX generated if certain event happen:

"400 Parse Failed" - Malformed Message
"405 Method Not Allowed" - Unsupported Method
"480 Temporarily Unavailable" - Overload Throttle Rejection, Max
Sessions Exceeded, Demo License Expired, Capacity Exceeded on Route,
Radius Server Timeout

415 No valid codec - No valid codec could be supported between
orig and term call legs.
"481 Transaction Does Not Exist" - Unknown Transaction or Dialog

"487 Transaction Terminated" - Origination Cancel
"488 ReInvite Rejected" - Relay of ReInvite was Rejected
"504 Server Time-out" - Internal VSX Failure
"500 Sequence Out of Order" - CSeq counter violation

c. For a VSX system originated release, it an internal release cause for
teardown.
If the VSX initiates a call teardown, the following cause values and strings are written
into the CDR:

999, Demo Licence Expired!"
999, "VSX Capacity Exceeded"
999, "VSX Operator Reset"
999, "Route Rejected"
999, "Radius Rejected"
999, "Radius Access Timeout"
------------------------------------------------------------------------
999, "Gatekeeper Reject"
999, "Enum Server Reject"
999, "Enum Server Timeout"
999, "DNS Server Reject"
999, "DNS/GK Timeout"
999, "Could not allocate media"
999, "No Response to INVITE"
999, "Ring No Answer Timeout"
999, "200 OK Timeout"
999, "Maximum Duration Exceeded"

987, "Termination Capacity Exceeded"
987, "Origination Capacity Exceeded"
987, "Term CPS Capacity Exceeded"
987, "Orig CPS Capacity Exceeded"
987, "Max H323 Legs Exceeded"

4. Release Cause String (Field #8 in CDR) - a string of text further
identifying the teardown circumstance.

.

2.5 Sample CDR record

002452502;V1.10;R;WithMedia;181-1071459514@192.188.0.28;0001;Mon Dec 15
11:38:34 2003;Mon Dec 15 11:38:41 2003;Mon Dec 15 11:38:48 2003;480;
EndedByRemoteUser;3;T;000200;H323;;192.188.0.38;9001;192.188.0.28;f0faf
f54-2e6c-11d8-8c4b-
bd4d562c2265;192.188.0.38;18044;192.188.0.28;10756;G.729b;240;460;6066;
14060;0;0;0;000200;H323;;192.188.0.28;8811;192.188.0.38;e83af3d3-1d2d-
d811-9f98-
003048424934;192.188.0.38;19236;192.188.0.28;10758;G.729b;460;240;14060
;6066;0;0;0; F;9001;305;2;15;305000;00000011 44934567 45231267
2300BCC0;345L1;;;
3 CDR File Storage/Retrieval
3.1 File Storage Policy
By default, all CDR files will be kept on the system for at least 360 hours. CDR files which are
older than 240 hours will be deleted by the SG system automatically in order to save disk space.

The CDR file is generated in a configured time interval. The time interval can be configured from
60 seconds to 99,999 seconds.
------------------------------------------------------------------------
3.2 File Naming Convention
All CDR files are stored on the SG system at the default directory (/CDR) with the following
naming convention:
File name is assembled using the format YearMonthDate-HHmm-BeginCDRSeq-
EndCDRSeg.xxx, where the Year is 4 digit long; where the Month, Date, Hour field is 2-digit
each; while the CDRSeq is 9-digit log. The Hour/Minute field is always of 24-hour format,
which ranges from 00 through 23. The .xxx suffix/extension indicates the file was completed
(cdr). The working CDR field will be named cdr.tmp, which has the most current CDRs
before the cdr file interval expired.

For example, the CDR file 20031227-0515-70001-800000.cdr indicates the file was created on
12/27/2003 at 5:15AM and contains the CDR records seq # from 70,001 to 80,000.

The CDRSeq is a 9 digits number where it is wrapped around when the value hit 999,999,999.

Integer fields which do not have data will be set for 0; Non-integer fields which do not have data
will simply be left empty or with string NA. The character semi-colon (;) is used as the field
delimiter to separate the fields of a CDR record.
3.3 File Retrieval Procedure
CDR files can be retrieved using the SCP (secure file copy) procedure. The SCP procedure
requires a defined user login name with password. The CDR user name and password can be
obtained through Web GUI via system administrator. Following is a simple procedure for
retrieving CDR files from the SG system:
1. Obtain the IP address or the host name of the VSX system.
2. Open an SCP( or ftp) session using one of the following commands:
SCP user@ <IP address>:TBD-directory/20031227*.cdr
(get all cdr files created in 12/27/2003)
3. Repeat 2 if necessary.

Sansay CDR Interface Format Guide

Încărcat de

Informații document

Descriere originală:

Titlu original

Drepturi de autor

Formate disponibile

Partajați acest document

Partajați sau inserați document

Opțiuni de partajare

Vi se pare util acest document?

Este necorespunzător acest conținut?

Drepturi de autor:

Formate disponibile

Sansay CDR Interface Format Guide

Încărcat de

Drepturi de autor:

Formate disponibile

Sansay Inc.

S-ar putea să vă placă și