Difference between revisions of "SMDR"

From IPitomy Wiki
Jump to navigation Jump to search
 
(13 intermediate revisions by 3 users not shown)
Line 1: Line 1:
To download the pdf go here:
+
==Additional Information==
 +
Two new security features have been added to the PBX for the SMDR.
 +
*The SMDR Access button allows you to configure and Access Control List for SMDR communication, defining what addresses are and are not permitted to communicate.
 +
*SMDR Authentication when enabled requires login credentials from whatever 3rd party service is trying to access the SMDR.  You can also disable this to eliminate the need for login.
 +
 
 +
==To download the pdf go here:==
  
 
[http://ipitomy.com/webrelease/IPitomy/IP1100+/SMDR.pdf http://ipitomy.com/webrelease/IPitomy/IP1100+/SMDR.pdf]
 
[http://ipitomy.com/webrelease/IPitomy/IP1100+/SMDR.pdf http://ipitomy.com/webrelease/IPitomy/IP1100+/SMDR.pdf]
  
 
+
== '''<u>SMDR data from server</u>''' ==
 +
 
 +
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; The SMDR data is outputted from the Reporting->Reports Page. (the export button will only give you a CDR-summary).<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; The file should be polled by directly by calling [ip address]/ippbx/exportCSV.php?stime=&etime=&type= .
 +
 
 +
&nbsp;By default it will give you all completed calls that day, in SMDR format.
  
{| border="0" cellpadding="0" cellspacing="0" height="34" width="13"
+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; To specify a range of times, you can enter values for the variables ‘etime’ and ‘stime’. If you provide an stime, it will give you all records from that time until the current time. If you specify both, it will give you records between those times.&nbsp; If you specify neither, it will give you all records.&nbsp; You can also specify the type variable.&nbsp; When left blank, the formwat will be CDR, but you can also set the it to CSV.&nbsp; In PBX releases 4.8.4-4.8.8&nbsp; you need to specify the variables stime=&etime=&type= in the string, even if they are blank.
|-
 
| style="width:166px" | <br/>
 
| style="width:166px" | <br/>
 
| style="width:166px" | <br/>
 
| style="width:166px" | <br/>
 
|-
 
| style="width:166px" | <br/>
 
| style="width:166px" | <br/>
 
| style="width:166px" | <br/>
 
| style="width:166px" | <br/>
 
|-
 
| style="width:166px" | <br/>
 
| style="width:166px" | <br/>
 
| style="width:166px" | <br/>
 
| style="width:166px" | <br/>
 
|-
 
| style="width:166px" | <br/>
 
| style="width:166px" | <br/>
 
| style="width:166px" | <br/>
 
| style="width:166px" | <br/>
 
|}
 
  
'''<u>SMDR data from server</u>'''
+
&nbsp;
  
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; The SMDR data tis outputted from the Reporting->Reports Page. (the export button will only give you a CDR-summary). The file should be polled by directly by calling [ip address]/ippbx/exportCSV.php .
+
Example:
  
&nbsp;By default it will give you all completed calls that day, in SMDR format.
+
[ip address]/ippbx/exportCSV.php?stime=[epoch]&etime=&type=
  
&nbsp;
 
  
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; To specify a range of times, you can use the get variables ‘etime’ and ‘stime’. If you provide an stime, it will give you all records from that time until the current time. If you specify both, it will give you records between those times.
+
Further Example if you want to set start and end time
  
&nbsp;
+
12.34.56.78/ippbx/exportCSV.php?stime=1264086258&etime=1264086296&type=
  
Example:
 
  
[ip address]/ippbx/exportCSV.php?stime=[epoch]
+
Epoch time converter:
 +
http://www.epochconverter.com/
  
 
&nbsp;
 
&nbsp;
Line 50: Line 37:
 
'''<u>The SMDR specification</u>'''
 
'''<u>The SMDR specification</u>'''
  
&nbsp;
 
  
{| style="width:771px" align="center" border="0" cellpadding="0" cellspacing="0" width="771"
+
 
 +
{| border="1" cellpadding="1" cellspacing="1"
 
|-
 
|-
| style="width:99px; height:17px" nowrap="nowrap" |  
+
| nowrap="nowrap" |  
== Start Time ==
+
'''Start Time'''
  
| style="width:99px; height:17px" nowrap="nowrap" |  
+
| nowrap="nowrap" |  
== End Time ==
+
'''End Time'''
  
| style="width:77px; height:17px" nowrap="nowrap" |  
+
| nowrap="nowrap" |  
== Direction ==
+
'''Direction'''
  
| style="width:74px; height:17px" nowrap="nowrap" |  
+
| nowrap="nowrap" |  
== Trunk ==
+
'''Trunk'''
  
| style="width:130px; height:17px" |  
+
|  
== Call ID ==
+
'''Call ID'''
  
| style="width:99px; height:17px" nowrap="nowrap" |  
+
| nowrap="nowrap" |  
== Source ==
+
'''Source'''
  
| style="width:99px; height:17px" nowrap="nowrap" |  
+
| nowrap="nowrap" |  
== Source CID ==
+
'''Source CID'''
  
| style="width:93px; height:17px" nowrap="nowrap" |  
+
| nowrap="nowrap" |  
== Source Channel ==
+
'''Source Channel'''
  
 
|-
 
|-
| style="width:99px; height:17px" nowrap="nowrap" |  
+
| nowrap="nowrap" |  
 
1264086258
 
1264086258
  
| style="width:99px; height:17px" nowrap="nowrap" |  
+
| nowrap="nowrap" |  
 
1264086296
 
1264086296
  
| style="width:77px; height:17px" nowrap="nowrap" |  
+
| nowrap="nowrap" |  
 
Incoming
 
Incoming
  
| style="width:74px; height:17px" nowrap="nowrap" |  
+
| nowrap="nowrap" |  
 
DAHDI/1-1
 
DAHDI/1-1
  
| style="width:130px; height:17px" |  
+
|  
 
1264086247.6308
 
1264086247.6308
  
| style="width:99px; height:17px" nowrap="nowrap" |  
+
| nowrap="nowrap" |  
 
7145554445
 
7145554445
  
| style="width:99px; height:17px" nowrap="nowrap" |  
+
| nowrap="nowrap" |  
 
7145554445
 
7145554445
  
| style="width:93px; height:17px" nowrap="nowrap" |
+
| nowrap="nowrap" | <p style="text-align: center">DAHDI/1-1</p>
DAHDI/1-1
 
 
 
 
|}
 
|}
  
&nbsp;
+
{| border="1" cellpadding="1" cellspacing="1"
 
 
{| style="width:675px" align="center" border="0" cellpadding="0" cellspacing="0" width="675"
 
 
|-
 
|-
| style="width:129px; height:32px" nowrap="nowrap" |  
+
| nowrap="nowrap" |  
== Destination ==
+
'''Destination'''
  
| style="width:122px; height:32px" nowrap="nowrap" |  
+
| nowrap="nowrap" |  
== Destination CID ==
+
'''Destination CID'''
  
| style="width:171px; height:32px" nowrap="nowrap" |  
+
| nowrap="nowrap" |  
== Destination Channel ==
+
'''Destination Channel'''
  
| style="width:99px; height:32px" nowrap="nowrap" |  
+
| nowrap="nowrap" |  
== DID ==
+
'''DID'''
  
| style="width:153px; height:32px" nowrap="nowrap" |  
+
| nowrap="nowrap" |  
== Ring Group ==
+
'''Ring Group'''
  
 
|-
 
|-
| style="width:129px; height:32px" nowrap="nowrap" |  
+
| nowrap="nowrap" |  
 
Elaine Blodgett
 
Elaine Blodgett
  
| style="width:122px; height:32px" nowrap="nowrap" |  
+
| nowrap="nowrap" |  
 
&nbsp;
 
&nbsp;
  
| style="width:171px; height:32px" nowrap="nowrap" |
+
| nowrap="nowrap" | <p style="text-align: center">SIP/2208</p>
SIP/2208
+
| nowrap="nowrap" |  
 
 
| style="width:99px; height:32px" nowrap="nowrap" |  
 
 
9413062200
 
9413062200
  
| style="width:153px; height:32px" nowrap="nowrap" |
+
| nowrap="nowrap" | <p style="text-align: center">rg_33</p>
rg_33
 
 
 
 
|}
 
|}
  
{| style="width:679px" align="left" border="0" cellpadding="0" cellspacing="0" width="679"
+
{| border="1" cellpadding="1" cellspacing="1"
 
|-
 
|-
| style="width:109px; height:24px" |  
+
|  
== Hold Time ==
+
'''Hold Time'''
  
| style="width:84px; height:24px" nowrap="nowrap" |  
+
| nowrap="nowrap" |  
== Status ==
+
'''Status'''
  
| style="width:123px; height:24px" nowrap="nowrap" |  
+
| nowrap="nowrap" |  
== Total Call Length ==
+
'''Total Call Length'''
  
| style="width:92px; height:24px" |  
+
|  
== Final Entry ==
+
'''Final Entry'''
  
| style="width:115px; height:24px" |  
+
|  
== Account Code ==
+
'''Account Code'''
  
| style="width:155px; height:24px" |  
+
|  
== Authorization Code ==
+
'''Authorization''' '''Code'''
  
 
|-
 
|-
| style="width:109px; height:19px" |
+
| <p style="text-align: center">3</p>
3
+
| nowrap="nowrap" |  
 
 
| style="width:84px; height:19px" nowrap="nowrap" |  
 
 
TRANSFERRED
 
TRANSFERRED
  
| style="width:123px; height:19px" nowrap="nowrap" |  
+
| nowrap="nowrap" | <p style="text-align: center">35</p>
35
+
|  
 
 
| style="width:92px; height:19px" |  
 
 
&nbsp;
 
&nbsp;
  
| style="width:115px; height:19px" |  
+
|  
 
&nbsp;
 
&nbsp;
  
| style="width:155px; height:19px" |  
+
|  
 
&nbsp;
 
&nbsp;
  
Line 253: Line 228:
 
Status
 
Status
  
*Abandoned: Call entered a Queue, but the caller hung up before the call was answered or met the failover requirement.
+
*Abandon: Call entered a Queue, but the caller hung up before the call was answered or met the failover requirement.
 
*ChanUnavail: No channel was able to be created for the call due to a possible error state for the intended destination.
 
*ChanUnavail: No channel was able to be created for the call due to a possible error state for the intended destination.
 
*Agent Completed: Connected Queue call was terminated at the extension.
 
*Agent Completed: Connected Queue call was terminated at the extension.
Line 266: Line 241:
 
*Transferred: Connected call successfully transferred.
 
*Transferred: Connected call successfully transferred.
 
*Busy: Call out a trunk returned busy status, or extension was busy.
 
*Busy: Call out a trunk returned busy status, or extension was busy.
*- : Defines the call is still active, and the status will update when completed. Click on the call record for details.
+
*-&nbsp;: Defines the call is still active, and the status will update when completed. Click on the call record for details.
 
*Exited Empty Queue: Call to Queue that follows Exit Empty rule.
 
*Exited Empty Queue: Call to Queue that follows Exit Empty rule.
 
*Exited With Key: Call to Queue that follows the Exit Menu key press.
 
*Exited With Key: Call to Queue that follows the Exit Menu key press.

Latest revision as of 12:53, 24 October 2014

Additional Information

Two new security features have been added to the PBX for the SMDR.

  • The SMDR Access button allows you to configure and Access Control List for SMDR communication, defining what addresses are and are not permitted to communicate.
  • SMDR Authentication when enabled requires login credentials from whatever 3rd party service is trying to access the SMDR. You can also disable this to eliminate the need for login.

To download the pdf go here:

http://ipitomy.com/webrelease/IPitomy/IP1100+/SMDR.pdf

SMDR data from server

                The SMDR data is outputted from the Reporting->Reports Page. (the export button will only give you a CDR-summary).
                The file should be polled by directly by calling [ip address]/ippbx/exportCSV.php?stime=&etime=&type= .

 By default it will give you all completed calls that day, in SMDR format.

                 To specify a range of times, you can enter values for the variables ‘etime’ and ‘stime’. If you provide an stime, it will give you all records from that time until the current time. If you specify both, it will give you records between those times.  If you specify neither, it will give you all records.  You can also specify the type variable.  When left blank, the formwat will be CDR, but you can also set the it to CSV.  In PBX releases 4.8.4-4.8.8  you need to specify the variables stime=&etime=&type= in the string, even if they are blank.

 

Example:

[ip address]/ippbx/exportCSV.php?stime=[epoch]&etime=&type=


Further Example if you want to set start and end time

12.34.56.78/ippbx/exportCSV.php?stime=1264086258&etime=1264086296&type=


Epoch time converter: http://www.epochconverter.com/

 

 

The SMDR specification


Start Time

End Time

Direction

Trunk

Call ID

Source

Source CID

Source Channel

1264086258

1264086296

Incoming

DAHDI/1-1

1264086247.6308

7145554445

7145554445

DAHDI/1-1

Destination

Destination CID

Destination Channel

DID

Ring Group

Elaine Blodgett

 

SIP/2208

9413062200

rg_33

Hold Time

Status

Total Call Length

Final Entry

Account Code

Authorization Code

3

TRANSFERRED

35

 

 

 

 

 

 

 

Field Specification

 

Start Time to End Time is the total length of the call.

                                Epoch Time

                Direction is the direction the call in coming

Incoming, Outgoing, or Internal

 

                Trunk is the associated inbound/outbound trunk

                                (SIP/ or DAHDI/ or IAX/)

                Call ID

                                The call id of the parent call entry (ties multiple legs of a call together

                Source

                                The Nickname the PBX gives the Source      

                Source Caller ID

                                The Caller ID of the Source

                Source Channel

                                The Channel of the Source caller

                Destination          

                                The Nickname the PBX gives the Destination

Destination Caller ID

                                The Caller ID of the Destination

                Destination Channel

                                The Channel of the Destination caller

                DID

                                The DID the Call came in on (if applicable)

               

Ring Group Name

                If it is sent into a ring group, the name of that ring group.

Hold Time

                                The amount of time the party was waiting for an Agent

Status

  • Abandon: Call entered a Queue, but the caller hung up before the call was answered or met the failover requirement.
  • ChanUnavail: No channel was able to be created for the call due to a possible error state for the intended destination.
  • Agent Completed: Connected Queue call was terminated at the extension.
  • Hangup: Call to a Menu, but the caller hung up before taking any actions.
  • Caller Completed: Connected Queue call was terminated at the calling parties end.
  • Cancel: Call from an Extension, but the caller hangs up before the call is connected.
  • Answer: A connected call.
  • No Answer: A call that met the ring time of an extension without being answered.
  • Timeout Exit: Call to a Queue that meets the Timeout.
  • VM Not Left: Call ended with the caller being sent to voicemail where they did not leave a message.
  • VM Left: Call ended with the caller being sent to voicemail where they left a message.
  • Transferred: Connected call successfully transferred.
  • Busy: Call out a trunk returned busy status, or extension was busy.
  • - : Defines the call is still active, and the status will update when completed. Click on the call record for details.
  • Exited Empty Queue: Call to Queue that follows Exit Empty rule.
  • Exited With Key: Call to Queue that follows the Exit Menu key press.
  • Account Code: Reserved for future account name information
  • Authorization Code: Reserved for future authorization code information

 

         

         

 

 

Example:

The call is incoming on a hardware channel 1 group 1, the call ID links the two records together. The call first goes to a ring group ‘rg_33’ is answered by SIP/2208 (Elaine), and was transferred after 35 seconds of talking. Because the final flag is not set, we know there will be more about this call in the future.

 

The second entry for the call was picked up by SIP/2210 (Chris) and lasted 81 seconds long. The final entry flag has a ‘1’ signifying it is the last leg of this call.

 

1264086258, 1264086296, Incoming, DAHDI/1-1, 1264086247.6308, 7145554445, 7145554445, Zap/1-1, Elaine Blodgett, , SIP/2208, 9413062200, rg_33, 3, TRANSFERRED,35,

 

1264086296, 1264086395, Incoming, DAHDI/1-1, 1264086247.6308, 7145554445, 7145554445, Zap/1-1, Chris Beavers, 2210, SIP/2210-087b12f0, 9413062200, , , ANSWER, 81, 1