---
title: "CDR record search"
method: GET
path: "/v2/partition/{partitionId}/account/{accountId}/cdrsearch"
tags: ["CDRs"]
---

# CDR record search

`GET /v2/partition/{partitionId}/account/{accountId}/cdrsearch`

## Request

- Base URL: `https://api.alianza.com`
- URL: `https://api.alianza.com/v2/partition/{partitionId}/account/{accountId}/cdrsearch`
- Auth: API key in header `X-AUTH-TOKEN`

Use to search for CDR records

## Path parameters

- `accountId` string, required
- `partitionId` string, required

## Query parameters

- `callCategory` string[]
- `callFlagType` string[]
- `callType` string[]
- `dialedNumber` string
- `endDate` string, required
- `endTime` string
- `firstResultIndex` integer
- `maxResult` integer
- `minCost` number, double
- `origNumber` string
- `sort` 'COST' | 'CALL_LENGTH' | 'DATE'
- `sortOrder` 'ASC' | 'DESC'
- `startDate` string, required
- `startTime` string
- `termNumber` string

## Response `200`

Successful operation

- CallDetailRecordSearchResponse
  - `totalRecords` integer
  - `results` CallDetailRecord[]
    - `id` string, uuid
    - `partitionId` string
    - `startTime` string, date-time
    - `connectTime` string, date-time
    - `endTime` string, date-time
    - `createdDate` string, date-time
    - `actualCallLengthSeconds` integer
    - `billCallLengthSeconds` integer
    - `ratePerMinute` number, double
    - `cost` number
    - `inPlan` boolean
    - `dialedNumber` string
    - `origNumber` string
    - `origLocation` string
    - `origCityName` string
    - `origAbbrRCName` string
    - `origState` string
    - `origCountry` string
    - `origCarrier` string
    - `origCallCategory` 'OffNet' | 'OnNet' | 'DirectoryAssistance' | 'Emergency' | 'Operator' | 'PhoneSupport' | 'TeleRelayService' | 'NonEmergencyServices' | 'Other' | 'PublicServices' | 'NotResolved' | 'EmergencyServicesVerification'
    - `identityAttestLevel` string
    - `identityOriginationId` string
    - `identitySignOrganization` string
    - `identitySignSPCode` string
    - `verstat` 'TN_VALIDATION_PASSED' | 'TN_VALIDATION_FAILED' | 'NO_TN_VALIDATION'
    - `verstatReason` 'BAD_IDENTITY_INFO' | 'CLAIM_TO_SIP_MISMATCH' | 'IDENTITY_HEADER_REQUIRED' | 'INVALID_IDENTITY_HEADER' | 'MALFORMED_IDENTITY_HEADER' | 'STALE_DATE' | 'UNSUPPORTED_CREDENTIAL' | 'UNSUPPORTED_PASSPORT_FORMAT'
    - `correlationData` object
    - `accountCode` string
    - `termNumber` string
    - `termLocation` string
    - `termCityName` string
    - `termAbbrRCName` string
    - `termState` string
    - `termCountry` string
    - `termCarrier` string
    - `termCallCategory` 'OffNet' | 'OnNet' | 'DirectoryAssistance' | 'Emergency' | 'Operator' | 'PhoneSupport' | 'TeleRelayService' | 'NonEmergencyServices' | 'Other' | 'PublicServices' | 'NotResolved' | 'EmergencyServicesVerification'
    - `forwardingNumber` string
    - `forwardingNumberCityName` string
    - `forwardingNumberAbbrRCName` string
    - `forwardingNumberLocation` string
    - `forwardingNumberState` string
    - `forwardingNumberCountry` string
    - `mediaServerType` string
    - `legType` 'Origination' | 'Termination' | 'Forward'
    - `callType` 'INBOUND' | 'OUTBOUND'
    - `callFlagType` 'MISSED' | 'VOICEMAIL' | 'FORWARDED' | 'BUSY' | 'ANSWERED' | 'OTHER' | 'PICKUP' | 'PICKED_UP'
    - `disconnectType` 'Busy' | 'NoAnswer' | 'HangUp' | 'HangUpOther' | 'BlindTransfer' | 'SupervisedTransfer' | 'Error' | 'Cancelled' | 'NextMenu' | 'NetworkBusy' | 'Unauthorized' | 'PickedUp' | 'NoURL' | 'BadURL' | 'URLExpired' | 'NoCallWaiting' | 'ImportantCall' | 'RefreshTimeout' | 'LocationCapacity' | 'Capacity' | 'SystemHangUp' | 'Rejected' | 'NotFound' | 'Other' | 'Forward' | 'Screened' | 'Unregistered'
    - `metroServiceArea` string
    - `rateType` 'Local' | 'OnPlanMinutes' | 'OnPlanRated' | 'OffPlanRated' | 'Free' | 'TollFree' | '_411' | 'Operator' | 'IntraPartitionFree' | 'SipTrunkInbound'
    - `rateLocalFromNumber` string
    - `serviceType` 'INTERSTATE' | 'INTRASTATE' | 'INTERNATIONAL' | 'TOLL_FREE' | 'NOT_APPLICABLE' | 'UNKNOWN'
    - `local` boolean
    - `sessionId` string
    - `accountBillableNumber` string
    - `accountBillableCityName` string
    - `accountBillableAbbrRCName` string
    - `accountBillableLocation` string
    - `accountBillableState` string
    - `accountBillableCountry` string
    - `referenceId` string
    - `referenceType` 'SIP_TRUNK' | 'END_USER' | 'ACCOUNT' | 'SPECIALTY_LINE'
    - `referenceName` string
    - `acctId` string
    - `accountId` string
    - `callingPlanProductId` string
    - `callingPlanProductName` string
    - `accountNumber` string
    - `accountCustomField` string
    - `partitionBillingCode` string
    - `accountBillingCycleDay` integer
    - `accountTimeZone` string
    - `sipCallIds` string[]
    - `meanOpinionScoreAverage` number, double
    - `meanOpinionScores` object
    - `callPickupFromId` string
    - `callPickupById` string
    - `applicationData` CdrApplicationData
      - `type` 'sip-trunks-interactions' | 'vfax-failure' | 'vfax-setup-failure' | 'vfax-success', required
    - `origCnam` string
    - `termCnam` string
    - `forwardingCnam` string
    - `customCallerId` string
    - `origNumberTags` string[]
    - `remoteChargeInfo` string
    - `termNumberTags` string[]

## Other responses

- `400`: Invalid Partition ID
- `401`: Unauthorized
- `404`: Not found

---

[API](https://skmtc.dev/alianza/apis/alianza-public-api.md) - [All operations](https://skmtc.dev/alianza/apis/alianza-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/alianza/apis/alianza-public-api/revisions/cb514a0728ed?raw)