Skip to main content

CallHistoryResponseDTO

A single call history record returned inside the paginated result.

uuidstring

Unique identifier of the call record.

Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
callerIdNamestringnullable

Caller display name (as provided by the PBX).

Example: John Doe
callerIdNumberstringnullable

Caller phone number.

Example: +998901234567
destinationNumberstringnullable

Called (destination) phone number.

Example: +998712345678
startStampint64nullable

Call start time (epoch seconds).

Example: 1719734400
endStampint64nullable

Call end time (epoch seconds).

Example: 1719734520
durationint32nullable

Total call duration in seconds (from ring to hangup).

Example: 180
userTalkTimeint32nullable

Actual talk time in seconds (excludes ringing time).

Example: 155
hangupCausestringnullable

Reason the call ended (e.g. NORMAL_CLEARING, NO_ANSWER).

Example: NORMAL_CLEARING
contactedbooleannullable

true if the call was actually answered and a conversation took place.

Example: true
qualityScoreint32nullable

Quality score assigned to the call (0–100).

Example: 85
contactNamestringnullable

Name of the linked CRM contact (if matched).

Example: Alice Johnson
contactNumberstringnullable

Phone number of the linked CRM contact.

Example: +998901234567
leadIdint64nullable

Linked lead ID — matches the filter's leadIds.

Example: 1001
leadNamestringnullable

The linked lead's name, as stored at the time of the call.

Example: New apartment buyer
employee objectnullable

Employee who made/received the call — matches the filter's employeeIds.

idint32

Employee ID

Example: 201
fullNamestring

Employee full name

Example: David Wilson
contactIdint64nullable

Linked CRM contact ID.

Example: 501
employeeNumstringnullable

Operator / employee extension number that handled the call.

Example: 101
callHistoryTypeCallHistoryTypenullable

Telephony provider that produced this record.

Possible values: [ONLINEPBX, SIPUNI, MOIZVONKI, ASTERISK, UTEL, YEASTAR, OFFLINEMEET, OPEN_API]

Example: ASTERISK
kindConversationKind

Kind of conversation. Never null: records written before the column existed are reported as CALL.

Possible values: [CALL, OFFLINE_MEET, ONLINE_MEET]

Example: CALL
callDirectionCallDirectionnullable

Direction of the call relative to the operator.

Possible values: [INBOUND, OUTBOUND]

Example: INBOUND
missedbooleannullable

true when the net talk time is zero — nobody actually spoke.

Example: false
recordingUrlstringnullable

Pre-signed URL to the call recording file, or null if no recording exists.

Example: https://storage.example.com/recordings/a1b2c3d4.mp3
conversionAnalysisboolean

Whether an analysis has been stored for this conversation (see POST /v1/open-api/call-history/{uuid}/analysis). Always present.

Example: false
CallHistoryResponseDTO
{
  "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "callerIdName": "John Doe",
  "callerIdNumber": "+998901234567",
  "destinationNumber": "+998712345678",
  "startStamp": 1719734400,
  "endStamp": 1719734520,
  "duration": 180,
  "userTalkTime": 155,
  "hangupCause": "NORMAL_CLEARING",
  "contacted": true,
  "qualityScore": 85,
  "contactName": "Alice Johnson",
  "contactNumber": "+998901234567",
  "leadId": 1001,
  "leadName": "New apartment buyer",
  "employee": {
    "id": 201,
    "fullName": "David Wilson"
  },
  "contactId": 501,
  "employeeNum": "101",
  "callHistoryType": "ASTERISK",
  "kind": "CALL",
  "callDirection": "INBOUND",
  "missed": false,
  "recordingUrl": "https://storage.example.com/recordings/a1b2c3d4.mp3",
  "conversionAnalysis": false
}