Skip to content

CDR Files

A CDR file holds the raw call data from a carrier, processed to extract individual calls for billing. Files arrive by email, FTP or manual upload. The API exposes them for monitoring which files have arrived and how they processed. See Supply Files (CDRs) for the upload and processing workflow.

/backend/api/v1/CDRFiles/ID - fetch the CDR file with the specified ID.

/backend/api/v1/CDRFiles/ - list all CDR files.

ParameterTypeRequiredDescription
idAfterintegerNoOnly include files with a higher ID
createdSincedatetimeNoOnly include files created since the given time
updatedSincedatetimeNoOnly include files updated since the given time

/backend/api/v1/CDRFiles/ID?action=recognise - re-run recognition using the current carrier processing rules.

Requires API write access and the CDR Files View and Reset File permissions. The file must be Unprocessed, Failed, Held or a Potential Duplicate. Bundle containers are not eligible; use the individual files extracted from them.

POST /backend/api/v1/CDRFiles/123?action=recognise
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
{
"reidentifyCarrier": false
}

reidentifyCarrier is optional and defaults to false. Set it to true to attempt carrier identification again. FTP files retain their account’s carrier; emailed files first use the carrier identified by the recipient address.

The response contains the updated CDR file record. Recognition can change its file type, billing flags and status. Files eligible for import are processed in the background. Check the Processing Log and fetch the record again to follow progress; the response does not mean import has finished.

An ineligible file or missing Reset File permission returns HTTP 403. A file already being imported is skipped. Re-recognition does not repeat email sender-authentication checks; the current processing rules decide the resulting hold status.

See Re-recognising CDR files for the staff workflow.

FieldNameTypeDescription
fileNameFilenameTextThe name of the uploaded CDR file
storedFileIDStored FilePreset ValueStored file reference for this CDR file
BundleFileIDBundle FileTextThe ID of the uploaded bundle that this extracted CDR file came from
uploadedDateDate UploadedDateThe date when this CDR file was uploaded
fileSourceFile SourcePreset ValueThe source method used to receive this CDR file (Upload, Email, FTP)
carrierCarrierPreset ValueThe carrier that provided this CDR file
fileTypeFile TypePreset ValueThe type of CDR file, which determins the processing rules used
billingBillingPreset ValueWhether this CDR file contains billable call records
dailyFrequencyPreset ValueWhether this is a daily or monthly CDR file
billrunWholesale Billing PeriodTextThe ID of the billing run this CDR file is associated with
notesNotesText (Multiline)Additional notes about this CDR file
mailMessageMessage IDTextEmail message identifier for CDR files received via email
mailFromFrom AddressTextEmail sender address for CDR files received via email
mailToTo AddressTextEmail recipient address for CDR files received via email
mailSubjectSubjectText (Multiline)Email subject line for CDR files received via email
statusStatusPreset ValueCurrent processing status of this CDR file
filePathFile PathTextInternal file system path where the CDR file is stored
originalHashOriginal HashTextSHA1 hash of the original uploaded file for duplicate detection
fileSizeFile SizeTextSize of the uploaded CDR file in bytes
linesLinesTextNumber of lines processed in the CDR file
fileProcessedDateProcessedDateDate this CDR file was processed
processingLogProcessing LogText (Multiline)Detailed log of the CDR file processing including any errors or warnings
idCDR File IDTextThe unique identifier for this CDR file
revisionNumberRevisionTextInternal version tracking number for this CDR file
fileProcessedStampProcessed TimeText