Calls

Call records represent individual CDR entries imported from carrier files. Each record contains the full detail for a single call leg, including retail and wholesale costs, duration, carrier information, and rating details.

For an audit trail of removed records, see Deleted Calls. For the merged A-leg/B-leg view, see Combined Calls vs Call Details in the Call Management guide.

Methods

GET

Retrieve Single Call

/backend/api/v1/calls/ID - fetch call with specified ID.

List Calls

/backend/api/v1/calls/ - list all calls.

/backend/api/v1/customers/ID/calls/ - list calls belonging to customer with specified ID.

/backend/api/v1/numbers/ID/calls/ - list calls belonging to number with specified ID.

/backend/api/v1/invoices/ID/calls/ - list calls on the invoice with specified ID.

/backend/api/v1/features/ID/calls/ - list calls belonging to feature with specified ID.

/backend/api/v1/transactions/ID/calls/ - list calls belonging to transaction with specified ID.

/backend/api/v1/CDRFiles/ID/calls/ - list calls from the CDR file with specified ID.

Additional Query Parameters
Parameter Type Required Description
billed flag No Only return calls that have been billed
unbilled flag No Only return calls that have not yet been billed
minDate date No Only return calls from this date onwards (YYYY-MM-DD)
maxDate date No Only return calls up to this date (YYYY-MM-DD)

Standard pagination parameters (limit, offset, idAfter, createdSince, updatedSince) are also supported.

Example Requests

Fetch unbilled calls for a customer:

curl -H "Authorization: Bearer YOUR_API_TOKEN" \
  "https://YOUR_DOMAIN/backend/api/v1/customers/42/calls/?unbilled"

Fetch calls on a specific invoice:

curl -H "Authorization: Bearer YOUR_API_TOKEN" \
  "https://YOUR_DOMAIN/backend/api/v1/invoices/1085/calls/"

Fetch calls within a date range:

curl -H "Authorization: Bearer YOUR_API_TOKEN" \
  "https://YOUR_DOMAIN/backend/api/v1/numbers/7/calls/?minDate=2026-01-01&maxDate=2026-01-31"

Fields

Field Name Type Description
target Billed Number (CDR) Text The phone number that was billed for this call as reported in the CDR
numberID Number Text The ID of the number that was billed for this call
extension Extension Text The extension number used for this call, if applicable
external Third Party Number Text The third-party number that was called or that called the billed number
terminationNumber Termination Number Text The number where this call terminated
location Location Preset Value The geographic location associated with this call
locationFull Full Location Preset Value The full location details associated with this call
locationCarrier Carrier Location Text The location information provided by the carrier for this call
terminationLocation Termination Location Preset Value The geographic location where this call terminated
terminationLocationFull Full Termination Location Preset Value The full location details where this call terminated
callTypeDirectionFlag Call Leg Preset Value Indicates whether this is an inbound or outbound call (A-leg, B-leg)
chargeBand Carrier Charge Band Text The charge band used by the carrier to bill this call
tariffType Call Type (Calculated) Preset Value The calculated call type used for billing this call
tariffTypeCarrier Call Type (Carrier) Preset Value The call type reported by the carrier for this call
callTypeOriginationTypeFlag Call Origination Type Preset Value Indicates the type of origination for this call if applicable (e.g., mobile, landline, payphone)
callTypeRecordingFlag Call Recording Preset Value Indicates whether this call was recorded
startDate Call Date Date The date when the call occurred
startTime Call Time Text The time when the call started
tariffTime Rating Period Preset Value The time period rating applied to this call (e.g., daytime, evening, weekend)
duration Duration (s) Number The duration of the call in seconds
bytes Data Usage (Bytes) Number The amount of data used during this session in bytes
events Events Number The number of events recorded during this session
answerTime Answer Time (s) Number The time in seconds between call setup and answer
costBase Retail Cost (p) Text The base retail cost of this call in pence before any discounts
cost Retail Cost (Discounted) (p) Text The retail cost of this call in pence after applying any discounts
costCDR Wholesale Cost (p) Text The wholesale cost of this call in pence as reported by the carrier
costCarrier Calculated Wholesale Cost (p) Text The calculated wholesale cost of this call in pence based on internal rate tables
costSuggestedRetail Suggested Retail Cost (p) Text The suggested retail cost for this call in pence
costBaseBasic Basic Retail Cost (p) Text The basic retail cost of this call in pence, excluding any surcharges
costBaseAccessCharge Retail Access Charge Text The retail access charge component of this call in pence
costBaseSurchargeMobileOrigination Retail Mobile Origination Surcharge Text The retail mobile origination surcharge component of this call in pence
costBaseSurchargePayphoneOrigination Retail Payphone Origination Surcharge Text The retail payphone origination surcharge component of this call in pence
costBaseSurchargeCallRecording Retail Cost Call Recording Surcharge Text The retail call recording surcharge component of this call in pence
costBasic Basic Retail Cost (Discounted) (p) Text The discounted basic retail cost of this call in pence
costAccessCharge Retail Access Charge (Discounted) (p) Text The discounted retail access charge component of this call in pence
costSurchargeMobileOrigination Retail Mobile Origination Surcharge (Discounted) (p) Text The discounted retail mobile origination surcharge component of this call in pence
costSurchargePayphoneOrigination Retail Payphone Origination Surcharge (Discounted) (p) Text The discounted retail payphone origination surcharge component of this call in pence
costSurchargeCallRecording Retail Cost Call Recording Surcharge (Discounted) (p) Text The discounted retail call recording surcharge component of this call in pence
costCDRBasic Basic Wholesale Cost (p) Text The basic wholesale cost of this call in pence, excluding any surcharges
costCDRAccessCharge Wholesale Access Charge (p) Text The wholesale access charge component of this call in pence
costCDRSurchargeMobileOrigination Wholesale Mobile Origination Surcharge (p) Text The wholesale mobile origination surcharge component of this call in pence
costCDRSurchargePayphoneOrigination Wholesale Payphone Origination Surcharge (p) Text The wholesale payphone origination surcharge component of this call in pence
costCDRSurchargeCallRecording Wholesale Cost Call Recording Surcharge (p) Text The wholesale call recording surcharge component of this call in pence
costCarrierBasic Basic Calculated Wholesale Cost (p) Text The calculated basic wholesale cost of this call in pence, excluding any surcharges
costCarrierAccessCharge Calculated Wholesale Access Charge (p) Text The calculated wholesale access charge component of this call in pence
costCarrierSurchargeMobileOrigination Calculated Wholesale Mobile Origination Surcharge (p) Text The calculated wholesale mobile origination surcharge component of this call in pence
costCarrierSurchargePayphoneOrigination Calculated Wholesale Payphone Origination Surcharge (p) Text The calculated wholesale payphone origination surcharge component of this call in pence
costCarrierSurchargeCallRecording Calculated Wholesale Cost Call Recording Surcharge (p) Text The calculated wholesale call recording surcharge component of this call in pence
carrier Carrier Preset Value The carrier responsible for this call
callCarrier Call Carrier Preset Value The carrier that handled this specific call (may differ from the primary carrier)
CDRFileID CDR File Text The ID of the CDR file that contained this call record
lineNumber Line Number Text The line number in the CDR file where this call record appeared
carrierCallID Carrier Call ID Text The call identifier provided by the carrier
callGroup Call Group Text Optional call grouping label provided by the CDR loader
aLegID Text ID of the A-leg call when this is part of a multi-leg call
id Call ID Text The unique identifier for this call record
tariffTypeUsed Call Type Preset Value The call type used for billing

Still Didn’t Find Your Answer?

For assistance, please contact us below.

Submit a ticket