Difference between revisions of "SMDR"
Nick Branica (talk | contribs) |
|||
(15 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
− | + | ==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] | |
− | + | == '''<u>SMDR data from server</u>''' == | |
+ | |||
+ | The SMDR data is outputted from the Reporting->Reports Page. (the export button will only give you a CDR-summary).<br/> 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/ | ||
+ | |||
+ | | ||
+ | |||
+ | | ||
+ | |||
+ | '''<u>The SMDR specification</u>''' | ||
+ | |||
+ | |||
+ | |||
+ | {| border="1" cellpadding="1" cellspacing="1" | ||
|- | |- | ||
− | | | + | | nowrap="nowrap" | |
− | + | '''Start Time''' | |
− | | | + | | nowrap="nowrap" | |
− | + | '''End Time''' | |
− | | | + | | nowrap="nowrap" | |
− | + | '''Direction''' | |
− | | | + | | nowrap="nowrap" | |
− | + | '''Trunk''' | |
− | + | | | |
− | + | '''Call ID''' | |
− | | | + | | nowrap="nowrap" | |
− | + | '''Source''' | |
− | | | + | | nowrap="nowrap" | |
− | + | '''Source CID''' | |
− | | | + | | nowrap="nowrap" | |
− | + | '''Source Channel''' | |
|- | |- | ||
− | | | + | | nowrap="nowrap" | |
1264086258 | 1264086258 | ||
− | | | + | | nowrap="nowrap" | |
1264086296 | 1264086296 | ||
− | | | + | | nowrap="nowrap" | |
Incoming | Incoming | ||
− | | | + | | nowrap="nowrap" | |
DAHDI/1-1 | DAHDI/1-1 | ||
− | + | | | |
1264086247.6308 | 1264086247.6308 | ||
− | | | + | | nowrap="nowrap" | |
7145554445 | 7145554445 | ||
− | | | + | | nowrap="nowrap" | |
7145554445 | 7145554445 | ||
− | | | + | | nowrap="nowrap" | <p style="text-align: center">DAHDI/1-1</p> |
− | DAHDI/1-1 | ||
− | |||
|} | |} | ||
− | + | {| border="1" cellpadding="1" cellspacing="1" | |
− | |||
− | {| | ||
|- | |- | ||
− | | | + | | nowrap="nowrap" | |
− | + | '''Destination''' | |
− | | | + | | nowrap="nowrap" | |
− | + | '''Destination CID''' | |
− | | | + | | nowrap="nowrap" | |
− | + | '''Destination Channel''' | |
− | | | + | | nowrap="nowrap" | |
− | + | '''DID''' | |
− | | | + | | nowrap="nowrap" | |
− | + | '''Ring Group''' | |
|- | |- | ||
− | | | + | | nowrap="nowrap" | |
Elaine Blodgett | Elaine Blodgett | ||
− | | | + | | nowrap="nowrap" | |
| | ||
− | | | + | | nowrap="nowrap" | <p style="text-align: center">SIP/2208</p> |
− | SIP/2208 | + | | nowrap="nowrap" | |
− | |||
− | | | ||
9413062200 | 9413062200 | ||
− | | | + | | nowrap="nowrap" | <p style="text-align: center">rg_33</p> |
− | rg_33 | ||
− | |||
|} | |} | ||
− | {| | + | {| border="1" cellpadding="1" cellspacing="1" |
|- | |- | ||
− | + | | | |
− | + | '''Hold Time''' | |
− | | | + | | nowrap="nowrap" | |
− | + | '''Status''' | |
− | | | + | | nowrap="nowrap" | |
− | + | '''Total Call Length''' | |
− | + | | | |
− | + | '''Final Entry''' | |
− | + | | | |
− | + | '''Account Code''' | |
− | + | | | |
− | + | '''Authorization''' '''Code''' | |
|- | |- | ||
− | | style=" | + | | <p style="text-align: center">3</p> |
− | + | | nowrap="nowrap" | | |
+ | TRANSFERRED | ||
+ | |||
+ | | nowrap="nowrap" | <p style="text-align: center">35</p> | ||
+ | | | ||
+ | | ||
+ | |||
+ | | | ||
+ | | ||
+ | |||
+ | | | ||
+ | | ||
− | | | + | |} |
− | |||
− | + | | |
− | |||
− | |||
| | ||
− | |||
| | ||
− | |||
| | ||
− | + | '''<u>Field Specification</u>''' | |
+ | | ||
+ | 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 | 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. | *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 193: | 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. | + | *- : 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. | ||
*Account Code: Reserved for future account name information | *Account Code: Reserved for future account name information | ||
*Authorization Code: Reserved for future authorization code information | *Authorization Code: Reserved for future authorization code information | ||
+ | |||
+ | | ||
+ | |||
+ | | ||
+ | |||
+ | | ||
+ | |||
+ | | ||
+ | |||
+ | | ||
Example: | Example: | ||
Line 214: | Line 272: | ||
1264086296, 1264086395, Incoming, DAHDI/1-1, 1264086247.6308, 7145554445, 7145554445, Zap/1-1, Chris Beavers, 2210, SIP/2210-087b12f0, 9413062200, , , ANSWER, 81, 1 | 1264086296, 1264086395, Incoming, DAHDI/1-1, 1264086247.6308, 7145554445, 7145554445, Zap/1-1, Chris Beavers, 2210, SIP/2210-087b12f0, 9413062200, , , ANSWER, 81, 1 | ||
+ | |||
+ | | ||
+ | |||
+ | |
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