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.
Methods
Section titled “Methods”Retrieve Single CDR File
Section titled “Retrieve Single CDR File”/backend/api/v1/CDRFiles/ID - fetch the CDR file with the specified ID.
List CDR Files
Section titled “List CDR Files”/backend/api/v1/CDRFiles/ - list all CDR files.
Additional Query Parameters
Section titled “Additional Query Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
idAfter | integer | No | Only include files with a higher ID |
createdSince | datetime | No | Only include files created since the given time |
updatedSince | datetime | No | Only include files updated since the given time |
Fields
Section titled “Fields”| Field | Name | Type | Description |
|---|---|---|---|
| fileName | Filename | Text | The name of the uploaded CDR file |
| storedFileID | Stored File | Preset Value | Stored file reference for this CDR file |
| uploadedDate | Date Uploaded | Date | The date when this CDR file was uploaded |
| fileSource | File Source | Preset Value | The source method used to receive this CDR file (Upload, Email, FTP) |
| carrier | Carrier | Preset Value | The carrier that provided this CDR file |
| fileType | File Type | Preset Value | The type of CDR file, which determins the processing rules used |
| billing | Billing | Preset Value | Whether this CDR file contains billable call records |
| daily | Frequency | Preset Value | Whether this is a daily or monthly CDR file |
| billrun | Wholesale Billing Period | Text | The ID of the billing run this CDR file is associated with |
| notes | Notes | Text (Multiline) | Additional notes about this CDR file |
| mailMessage | Message ID | Text | Email message identifier for CDR files received via email |
| mailFrom | From Address | Text | Email sender address for CDR files received via email |
| mailTo | To Address | Text | Email recipient address for CDR files received via email |
| mailSubject | Subject | Text (Multiline) | Email subject line for CDR files received via email |
| status | Status | Preset Value | Current processing status of this CDR file |
| filePath | File Path | Text | Internal file system path where the CDR file is stored |
| originalHash | Original Hash | Text | SHA1 hash of the original uploaded file for duplicate detection |
| fileSize | File Size | Text | Size of the uploaded CDR file in bytes |
| lines | Lines | Text | Number of lines processed in the CDR file |
| fileProcessedStamp | Processed Timestamp | Text | Timestamp when this CDR file was processed |
| processingLog | Processing Log | Text (Multiline) | Detailed log of the CDR file processing including any errors or warnings |
| id | CDR File ID | Text | The unique identifier for this CDR file |
| revisionNumber | Revision | Text | Internal version tracking number for this CDR file |