Differenze tra le versioni di "AdminGuide:Service:CDR/en"
(Creata pagina con "Calls are shown from most to least recent, and display the following information: *UniqueID, a unique call identifier *Source type (extension, inbound line, remote extension)...") |
(Aggiornamento come da nuova versione della pagina di origine) |
||
(17 versioni intermedie di 3 utenti non mostrate) | |||
Riga 1: | Riga 1: | ||
<languages /> | <languages /> | ||
Return to [[AdminGuide: | Return to [[AdminGuide:Service/en|AdminGuide:Service]] | ||
[[File:Registro chiamate.png|miniatura]] | [[File:Registro chiamate.png|miniatura]] | ||
This page lets you view the call detail record through KalliopePBX. | ==Description== | ||
===Call detail record=== | |||
This page lets you view the call detail record through KalliopePBX. A new tab will be automatically created for ease of viewing every month. | |||
All the following information are '''exportable''' through '''[[AdminGuide:RestAPI/en|API REST]]''' or in other formats (Excel, XML, JSON, CSV) by clicking on the proper button '''"''Export in format''"''' present in the panel header.<br>All the information contained in the CDR can also be '''sent periodically''' as better described in the proper '''[[AdminGuide:Service:ScheduledTasks/en|section]]'''. | |||
Calls are shown from most to least recent, and display the following information: | Calls are shown from most to least recent, and display the following information: | ||
{| class="wikitable" | |||
|- | |||
! '''Field''' !! Description !! Exported field | |||
|- | |||
| '''UniqueID''' || a unique call identifier || ''unique_id'' | |||
|- | |||
| '''Source Type''' || The type of call source (extension, inbound line, remote extension) || ''source_type''<br>Click [[AdminGuide:Service:CDR/en#List_of_SOURCE.2FDESTINATION_TYPE_and_DETAIL_SOURCE.2FDESTINATION_TYPE_codes|here]] for possible value | |||
|- | |||
| '''Destination Type''' || The type of call destination (extensions, remote extension, queue, ring group, IVR, outbound line, service) || ''destination_type''<br>Click [[AdminGuide:Service:CDR/en#List_of_SOURCE.2FDESTINATION_TYPE_and_DETAIL_SOURCE.2FDESTINATION_TYPE_codes|here]] for possible value | |||
|- | |||
| '''Status''' || The outcome of the call (failed, busy, canceled, not answered, OK, forbidden) || ''status''<br>Click [[AdminGuide:Service:CDR/en#List_of_EXIT_CAUSE_and_DETAIL_EXIT_CAUSE_codes|here]] for possible value | |||
|- | |||
| '''Day''' || Date of the call (day/month/year) || the date is included in subsequent export timestamps | |||
|- | |||
| '''Start Time''' || Call start time || ''start_datetime'' | |||
|- | |||
| '''Channel Up Time''' || Time of opening of the media channel of the call, i.e. when the PBX answers. In the case of outgoing calls this coincides with the "answer time". || ''channel_up_datetime'' | |||
|- | |||
| '''Answer Time''' || Call answering time. For incoming calls it indicates the answering time of an extension. For outgoing calls it coincides with the "Answer channel" time. || ''answer_datetime'' | |||
|- | |||
| '''Answered by''' || ID of who answered || ''answered_by'' | |||
|- | |||
| '''End Time''' || Call end time. || ''end_datetime'' | |||
|- | |||
| '''Caller''' || Number and ID (if it is present in the phonebook) of the caller || ''caller'' e ''caller_name'' | |||
|- | |||
| '''Anonymous''' || Flag that identifies if the calling number is anonymized (yes/no) || ''anonymous'' (0/1) | |||
|- | |||
| '''Called''' || Number and ID (if it is present in the phonebook) of the called number. In the case of incoming calls it identifies the public number dialed by the caller || ''caller'' | |||
|- | |||
| '''Gateway Name''' || Indicates the gateway or termination used (in the case of outgoing or incoming calls) || ''gateway_name'' | |||
|- | |||
| '''Account Code ''' || Indicates the code (or "tag") assigned to the call. It is possible to assign a "tag" to a particular call using the phone code configurable in the Numbering Plan (available only with the Call Center license). || ''account_code'' | |||
|- | |||
| '''Duration''' || Total duration of the call expressed in hours, minutes and seconds (hh:mm:ss) || ''duration'' | |||
|- | |||
| '''Bill Time''' || Actual call duration once established (following SIP 200 OK message) expressed in hours, minutes and seconds (hh:mm:ss) || ''bill_secs'' (secondi.millisecondi) | |||
|- | |||
| '''Source Peer Name''' || For outgoing calls or calls between extensions, it indicates the SIP source account of the call. || ''src_peer_name'' | |||
|- | |||
| '''Source IP/Port''' || For outgoing calls or calls between extensions, it indicates the IP address and the source port of the call. || ''src_ip_port'' | |||
|} | |||
===Call path=== | |||
For every call, it is also possible to reconstruct the '''entire path of the call''' in the numbering plan, reporting for each step a '''detail line''' containing the following fields:<br> | |||
{| class="wikitable" | |||
|- | |||
! '''Field''' !! Description!! Exported field | |||
|- | |||
| '''Source Number''' || Call source number || ''detail_source_num'' | |||
|- | |||
| '''Source Number''' || Flag that identifies if the calling number is anonymized (yes/no) || ''detail_anonymous'' (0/1) | |||
|- | |||
| '''Destination Type''' || The type of call destination (extension, remote extension, queue, call group, IVR, outgoing line, service) || ''detail_destination_type''<br>Click [[AdminGuide:Service:CDR/en#List_of_SOURCE.2FDESTINATION_TYPE_and_DETAIL_SOURCE.2FDESTINATION_TYPE_codes|here]] for possible value | |||
|- | |||
| '''Destination ID''' || Identifier of the type of destination; in the case of destination "service" indicates the particular service involved, in the case of destination "local_exten" or "voicemail" indicates the recipient extension, in other cases the identifier of the particular destination (e.g. the id of the IVR menu or destination queue) || ''detail_destination_id'' | |||
|- | |||
| '''Destination Name''' || In the case of destination "local_exten" (extension) it shows the name associated with the recipient extension, in the case of destination "queue", "FAX" or "callg" it shows the name of the recipient entity, in the case of destination "obl" (outgoing calls) it shows the name of the outgoing line used, in the case of destination "service" it shows further details on the service || ''detail_destination_name'' | |||
|- | |||
| '''Destination Number''' || Indicates the destination number in case the "Destination type" is "local_exten" or "obl" (outgoing calls) || ''detail_destination_num'' | |||
|- | |||
| '''Enter Time''' || Time (hh:mm:ss) of call entry in the corresponding detail line || ''detail_enter_datetime'' | |||
|- | |||
| '''Enqueue Time''' || Time (hh:mm:ss) of when the call enters the queue (only if the detail line includes a destination of type "queue") || ''detail_enqueue_datetime'' | |||
|- | |||
| '''Answer Time''' || Time (hh:mm:ss) the call was answered (only if the call was answered or destined in a voice mailbox) || ''detail_answer_datetime'' | |||
|- | |||
| '''Exit Time''' || Time (hh:mm:ss) of call exit from the corresponding detail line || ''detail_exit_datetime'' | |||
|- | |||
| '''Exit Cause''' || Time (hh:mm:ss) of call exit from the corresponding detail line || ''detail_exit_cause''<br>Click [[AdminGuide:Service:CDR/en#List_of_EXIT_CAUSE_and_DETAIL_EXIT_CAUSE_codes|here]] for possible value | |||
|- | |||
| '''Answered By''' || The number that answered the corresponding detail line || ''detail_answered_by'' | |||
|- | |||
| '''Waiting Time''' || Indicates in seconds the time elapsed between the input time and the response time || ''detail_waiting_time'' (secondi) | |||
|- | |||
| '''Mapped Source Number''' || For outgoing calls it indicates the source number resulting from any manipulation of outgoing calls || ''detail_mapped_source_num'' | |||
|- | |||
| '''Mapped Destination Number''' || For outgoing calls it indicates the destination number resulting from the possible manipulation of outgoing calls || ''detail_mapped_dst_num'' | |||
|- | |||
| '''Account Code''' || Indicates the code (or "tag") assigned to the call. It is possible to assign a "tag" to a particular call using the phone code configurable in the Numbering Plan (available only with the Call Center license). || ''detail_account_code'' | |||
|} | |||
You can order the calls according to each parameter and invert the order (increasing or decreasing) by clicking on the header of the corresponding column. | |||
You can filter the CDR by each of these fields (e.g. by viewing only calls from a specific extension or to a specific number, or during a specific time range) by clicking on the box corresponding to the column. | |||
You can also click on ''Select columns to display'' to choose which items to show. | |||
[[File:Selezione colonne.png|160x400px|centro]] | [[File:Selezione colonne.png|160x400px|centro]] | ||
== List of SOURCE/DESTINATION TYPE and DETAIL SOURCE/DESTINATION TYPE codes == | |||
'''Source/Destination Type:'''<br> | |||
'''local_exten''' ⇒ PBX extension <br> | |||
'''ibl''' ⇒ nbound line <br> | |||
'''obl''' ⇒ outbound line <br> | |||
'''service''' ⇒ PBX local service <br> | |||
'''callg''' ⇒ call group <br> | |||
'''queue''' ⇒ queue <br> | |||
'''ivr''' ⇒ IVR menu <br> | |||
'''conference''' ⇒ dialout conference room<br> | |||
'''fax''' ⇒ FAX server istance <br> | |||
<br> | |||
'''Detail Source/Destination Type:''' <br> | |||
'''local_exten''' ⇒ PBX extension <br> | |||
'''ibl''' ⇒ nbound line <br> | |||
'''obl''' ⇒ outbound line <br> | |||
'''service''' ⇒ PBX local service <br> | |||
'''callg''' ⇒ call group <br> | |||
'''queue''' ⇒ queue <br> | |||
'''ivr''' ⇒ IVR menu <br> | |||
'''conference''' ⇒ dialout conference room<br> | |||
'''fax''' ⇒ FAX server istance <br> | |||
'''dre''' ⇒ dynamic routing <br> | |||
'''checktime''' ⇒ checktime <br> | |||
'''voicemail''' ⇒ voicemail <br> | |||
== List of EXIT CAUSE and DETAIL EXIT CAUSE codes == | |||
'''Exit cause:'''<br> | |||
'''OK''' ⇒ ended call after being answered from a service/extension/external number <br> | |||
'''CANCELED''' ⇒ ended call because because it was cancelled by the caller before it was answered from a service/extension/external number <br> | |||
'''NOANSWER''' ⇒ call ended unanswered from a service/extension/external number <br> | |||
'''BUSY''' ⇒ ended call because the called number is busy <br> | |||
'''FAILED''' ⇒ ended call because there is no rule to route the call (no destination) <br> | |||
'''UNAVAILABLE''' ⇒ ended call because destination is not available (e.g. destination phone not registered) <br> | |||
'''FORBIDDEN''' ⇒ ended call because it came from an unknown incoming line <br> | |||
'''??''' ⇒ it was not possible to trace the reason why the call ended <br> | |||
<br> | |||
'''Detail exit cause:'''<br> | |||
'''CANCELED''' ⇒ the caller ended the call before it was answered<br> | |||
'''NOANSWER''' ⇒ destination did not answer<br> | |||
'''BUSY''' ⇒ destination is busy<br> | |||
'''NCC''' ⇒ call to destination terminated after being answered (Normal Clearing Code)<br> | |||
'''ANSWNOACC''' ⇒ call answered by mobile but not accepted (key 1 not pressed)<br> | |||
'''PICKUP''' = incoming call picked up from another extension<br> | |||
'''PARKED''' ⇒ call parked in one of the parking slots<br> | |||
'''UFWD''' ⇒ incoming call redirected due to unconditional forwarding<br> | |||
'''CFWD''' ⇒ incoming call redirected to another destination<br> | |||
'''CFWD2MOBILE''' ⇒ incoming call redirected to the mobile associated to the called extension<br> | |||
'''FORK2MOBILE''' ⇒ incoming call was forked to both the extension and the associated mobile number<br> | |||
'''FASTXFER2MOBILE''' ⇒ call in progress transferred from extension to associated mobile number<br> | |||
'''FASTXFER2EXTEN''' ⇒ call in progress transferred from mobile number to associated extension<br> | |||
'''BLINDXFER''' ⇒ call transferred without offer<br> | |||
'''ATXFER_START''' ⇒ start a transfer with offer<br> | |||
'''ATXFER_REFUSED''' ⇒ the transfer with offer to the destination is terminated because the destination has refused the transfer<br> | |||
'''ATXFER_BUSY''' ⇒ the transfer with offer is terminated because the destination is busy<br> | |||
'''ATXFER_UNAVAILABLE''' ⇒ the transfer with offer is terminated because the destination is not available<br> | |||
'''ATXFER_NOANSWER''' ⇒ the transfer with offer is terminated because the destination has not answered<br> | |||
'''ATXFER''' ⇒ call transferred with offer<br> | |||
'''UNAVAILABLE''' ⇒ the call is terminated because the destination is unavailable<br> | |||
'''CONGESTION''' ⇒ the call to the destination is terminated due to congestion<br> | |||
'''DECLINED''' ⇒ the call to the destination has been rejected due to a declined rule on the numbering plan<br> | |||
'''BLOCKED''' ⇒ the call to the destination has been blocked by the LCR because there are no lines to route the cal<br> | |||
'''FORBIDDEN_NOCLASS''' ⇒ the outgoing call was blocked by the LCR because a class to route the call is not defined<br> | |||
'''FORBIDDEN_NORULE''' ⇒ the outgoing call has been blocked by the LCR because no rule is defined to route the call<br> | |||
'''QUEUE_CALLBACK''' ⇒ a callback has been requested on a queue<br> | |||
'''CLOSED''' ⇒ the destination queue is closed due to time control<br> |
Versione attuale delle 09:55, 21 set 2022
Return to AdminGuide:Service
Description
Call detail record
This page lets you view the call detail record through KalliopePBX. A new tab will be automatically created for ease of viewing every month.
All the following information are exportable through API REST or in other formats (Excel, XML, JSON, CSV) by clicking on the proper button "Export in format" present in the panel header.
All the information contained in the CDR can also be sent periodically as better described in the proper section.
Calls are shown from most to least recent, and display the following information:
Field | Description | Exported field |
---|---|---|
UniqueID | a unique call identifier | unique_id |
Source Type | The type of call source (extension, inbound line, remote extension) | source_type Click here for possible value |
Destination Type | The type of call destination (extensions, remote extension, queue, ring group, IVR, outbound line, service) | destination_type Click here for possible value |
Status | The outcome of the call (failed, busy, canceled, not answered, OK, forbidden) | status Click here for possible value |
Day | Date of the call (day/month/year) | the date is included in subsequent export timestamps |
Start Time | Call start time | start_datetime |
Channel Up Time | Time of opening of the media channel of the call, i.e. when the PBX answers. In the case of outgoing calls this coincides with the "answer time". | channel_up_datetime |
Answer Time | Call answering time. For incoming calls it indicates the answering time of an extension. For outgoing calls it coincides with the "Answer channel" time. | answer_datetime |
Answered by | ID of who answered | answered_by |
End Time | Call end time. | end_datetime |
Caller | Number and ID (if it is present in the phonebook) of the caller | caller e caller_name |
Anonymous | Flag that identifies if the calling number is anonymized (yes/no) | anonymous (0/1) |
Called | Number and ID (if it is present in the phonebook) of the called number. In the case of incoming calls it identifies the public number dialed by the caller | caller |
Gateway Name | Indicates the gateway or termination used (in the case of outgoing or incoming calls) | gateway_name |
Account Code | Indicates the code (or "tag") assigned to the call. It is possible to assign a "tag" to a particular call using the phone code configurable in the Numbering Plan (available only with the Call Center license). | account_code |
Duration | Total duration of the call expressed in hours, minutes and seconds (hh:mm:ss) | duration |
Bill Time | Actual call duration once established (following SIP 200 OK message) expressed in hours, minutes and seconds (hh:mm:ss) | bill_secs (secondi.millisecondi) |
Source Peer Name | For outgoing calls or calls between extensions, it indicates the SIP source account of the call. | src_peer_name |
Source IP/Port | For outgoing calls or calls between extensions, it indicates the IP address and the source port of the call. | src_ip_port |
Call path
For every call, it is also possible to reconstruct the entire path of the call in the numbering plan, reporting for each step a detail line containing the following fields:
Field | Description | Exported field |
---|---|---|
Source Number | Call source number | detail_source_num |
Source Number | Flag that identifies if the calling number is anonymized (yes/no) | detail_anonymous (0/1) |
Destination Type | The type of call destination (extension, remote extension, queue, call group, IVR, outgoing line, service) | detail_destination_type Click here for possible value |
Destination ID | Identifier of the type of destination; in the case of destination "service" indicates the particular service involved, in the case of destination "local_exten" or "voicemail" indicates the recipient extension, in other cases the identifier of the particular destination (e.g. the id of the IVR menu or destination queue) | detail_destination_id |
Destination Name | In the case of destination "local_exten" (extension) it shows the name associated with the recipient extension, in the case of destination "queue", "FAX" or "callg" it shows the name of the recipient entity, in the case of destination "obl" (outgoing calls) it shows the name of the outgoing line used, in the case of destination "service" it shows further details on the service | detail_destination_name |
Destination Number | Indicates the destination number in case the "Destination type" is "local_exten" or "obl" (outgoing calls) | detail_destination_num |
Enter Time | Time (hh:mm:ss) of call entry in the corresponding detail line | detail_enter_datetime |
Enqueue Time | Time (hh:mm:ss) of when the call enters the queue (only if the detail line includes a destination of type "queue") | detail_enqueue_datetime |
Answer Time | Time (hh:mm:ss) the call was answered (only if the call was answered or destined in a voice mailbox) | detail_answer_datetime |
Exit Time | Time (hh:mm:ss) of call exit from the corresponding detail line | detail_exit_datetime |
Exit Cause | Time (hh:mm:ss) of call exit from the corresponding detail line | detail_exit_cause Click here for possible value |
Answered By | The number that answered the corresponding detail line | detail_answered_by |
Waiting Time | Indicates in seconds the time elapsed between the input time and the response time | detail_waiting_time (secondi) |
Mapped Source Number | For outgoing calls it indicates the source number resulting from any manipulation of outgoing calls | detail_mapped_source_num |
Mapped Destination Number | For outgoing calls it indicates the destination number resulting from the possible manipulation of outgoing calls | detail_mapped_dst_num |
Account Code | Indicates the code (or "tag") assigned to the call. It is possible to assign a "tag" to a particular call using the phone code configurable in the Numbering Plan (available only with the Call Center license). | detail_account_code |
You can order the calls according to each parameter and invert the order (increasing or decreasing) by clicking on the header of the corresponding column.
You can filter the CDR by each of these fields (e.g. by viewing only calls from a specific extension or to a specific number, or during a specific time range) by clicking on the box corresponding to the column.
You can also click on Select columns to display to choose which items to show.
List of SOURCE/DESTINATION TYPE and DETAIL SOURCE/DESTINATION TYPE codes
Source/Destination Type:
local_exten ⇒ PBX extension
ibl ⇒ nbound line
obl ⇒ outbound line
service ⇒ PBX local service
callg ⇒ call group
queue ⇒ queue
ivr ⇒ IVR menu
conference ⇒ dialout conference room
fax ⇒ FAX server istance
Detail Source/Destination Type:
local_exten ⇒ PBX extension
ibl ⇒ nbound line
obl ⇒ outbound line
service ⇒ PBX local service
callg ⇒ call group
queue ⇒ queue
ivr ⇒ IVR menu
conference ⇒ dialout conference room
fax ⇒ FAX server istance
dre ⇒ dynamic routing
checktime ⇒ checktime
voicemail ⇒ voicemail
List of EXIT CAUSE and DETAIL EXIT CAUSE codes
Exit cause:
OK ⇒ ended call after being answered from a service/extension/external number
CANCELED ⇒ ended call because because it was cancelled by the caller before it was answered from a service/extension/external number
NOANSWER ⇒ call ended unanswered from a service/extension/external number
BUSY ⇒ ended call because the called number is busy
FAILED ⇒ ended call because there is no rule to route the call (no destination)
UNAVAILABLE ⇒ ended call because destination is not available (e.g. destination phone not registered)
FORBIDDEN ⇒ ended call because it came from an unknown incoming line
?? ⇒ it was not possible to trace the reason why the call ended
Detail exit cause:
CANCELED ⇒ the caller ended the call before it was answered
NOANSWER ⇒ destination did not answer
BUSY ⇒ destination is busy
NCC ⇒ call to destination terminated after being answered (Normal Clearing Code)
ANSWNOACC ⇒ call answered by mobile but not accepted (key 1 not pressed)
PICKUP = incoming call picked up from another extension
PARKED ⇒ call parked in one of the parking slots
UFWD ⇒ incoming call redirected due to unconditional forwarding
CFWD ⇒ incoming call redirected to another destination
CFWD2MOBILE ⇒ incoming call redirected to the mobile associated to the called extension
FORK2MOBILE ⇒ incoming call was forked to both the extension and the associated mobile number
FASTXFER2MOBILE ⇒ call in progress transferred from extension to associated mobile number
FASTXFER2EXTEN ⇒ call in progress transferred from mobile number to associated extension
BLINDXFER ⇒ call transferred without offer
ATXFER_START ⇒ start a transfer with offer
ATXFER_REFUSED ⇒ the transfer with offer to the destination is terminated because the destination has refused the transfer
ATXFER_BUSY ⇒ the transfer with offer is terminated because the destination is busy
ATXFER_UNAVAILABLE ⇒ the transfer with offer is terminated because the destination is not available
ATXFER_NOANSWER ⇒ the transfer with offer is terminated because the destination has not answered
ATXFER ⇒ call transferred with offer
UNAVAILABLE ⇒ the call is terminated because the destination is unavailable
CONGESTION ⇒ the call to the destination is terminated due to congestion
DECLINED ⇒ the call to the destination has been rejected due to a declined rule on the numbering plan
BLOCKED ⇒ the call to the destination has been blocked by the LCR because there are no lines to route the cal
FORBIDDEN_NOCLASS ⇒ the outgoing call was blocked by the LCR because a class to route the call is not defined
FORBIDDEN_NORULE ⇒ the outgoing call has been blocked by the LCR because no rule is defined to route the call
QUEUE_CALLBACK ⇒ a callback has been requested on a queue
CLOSED ⇒ the destination queue is closed due to time control