CallHistoryFilterDTO

Request body for POST /v1/open-api/call-history/filter. All fields are optional except pagination; an omitted or empty-array filter matches everything. Calls carry no custom fields — fields/customFields intentionally don't exist here.

pageint32

Page number, 1-based (min 1).

Possible values: >= 1

Default value: 1

Example: 1

sizeint32

Page size (min 1, max 100).

Possible values: >= 1 and <= 100

Default value: 10

Example: 10

orders object

Sort order. Each key is a sort field (see CallHistoryOrderField) and each value a direction. Keys are applied in the order they appear in the JSON object. Unless UUID is one of the keys, a trailing UUID DESC tie-breaker is appended so paging stays stable. Omit (or send {}) to keep the default — newest call first (START_STAMP DESC).

property name*string

Possible values: [ASC, DESC]

uuidsstring[]

Exact call UUIDs (bulk re-sync).

Example: ["a1b2c3d4-e5f6-7890-abcd-ef1234567890"]

phoneSearchstringnullable

Free-text substring search applied to the caller number (callerIdNumber) and the destination number (destinationNumber).

Example: +998901234567

callTimestampFromint64nullable

Lower bound (inclusive) of the call start time (startStamp), epoch seconds.

Example: 1735689600

callTimestampToint64nullable

Upper bound (inclusive) of the call start time.

Example: 1767207599

durationFromint32nullable

Lower bound (inclusive) for total duration, seconds.

Example: 30

durationToint32nullable

Upper bound (inclusive) for total duration, seconds.

Example: 600

userTalkTimeFromint32nullable

Lower bound (inclusive) for net talk time, seconds.

Example: 10

userTalkTimeToint32nullable

Upper bound (inclusive) for net talk time, seconds.

Example: 500

qualityScoreFromint32nullable

Lower bound (inclusive) for quality score.

Example: 60

qualityScoreToint32nullable

Upper bound (inclusive) for quality score.

Example: 100

operatorNumsstring[]nullable

Filter by operator (employee) PBX extension numbers — matches employeeNum. Omit or pass null to include all.

Example: ["101","102"]

employeeIdsint32[]nullable

Filter by employee IDs — matches the response's employee.id.

Example: [201]

leadIdsint64[]nullable

Filter by linked lead IDs — matches the response's leadId.

Example: [1001]

callHistoryTypesCallHistoryType[]nullable

Filter by PBX / telephony provider type. Omit or pass null to include all.

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

Example: ["ONLINEPBX","ASTERISK"]

callDirectionsCallDirection[]nullable

Filter by call direction — INBOUND or OUTBOUND. Omit or pass null to include both.

Possible values: [INBOUND, OUTBOUND]

Example: ["INBOUND"]

kindsConversationKind[]nullable

Filter by conversation kind — call, offline or online meeting.

Possible values: [CALL, OFFLINE_MEET, ONLINE_MEET]

contactedbooleannullable

true — only calls that were actually answered. null (omit) — don't filter.

Example: true

missedbooleannullable

true — only calls with zero talk time (userTalkTime = 0); false — only calls that had talk time. null (omit) — don't filter.

Example: false

hasRecordingbooleannullable

true — only calls with a stored recording; false — only calls without one. null (omit) — don't filter.

Example: true

startint64deprecated

Deprecated — use callTimestampFrom instead. Lower bound for the call start time (epoch seconds). Defaults to 0 (no lower bound). Combined with callTimestampFrom via the larger of the two.

Default value: 0

Example: 1700000000

finishint64deprecated

Deprecated — use callTimestampTo instead. Upper bound for the call start time (epoch seconds). Defaults to Long.MAX_VALUE (no upper bound). Combined with callTimestampTo via the smaller of the two.

Example: 1750000000

callDirectionCallDirectionnullabledeprecated

Deprecated — use callDirections instead. Combines with it via union.

Possible values: [INBOUND, OUTBOUND]

Example: INBOUND

CallHistoryFilterDTO

{
  "page": 1,
  "size": 10,
  "orders": {
    "START_STAMP": "DESC"
  },
  "uuids": [
    "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  ],
  "phoneSearch": "+998901234567",
  "callTimestampFrom": 1735689600,
  "callTimestampTo": 1767207599,
  "durationFrom": 30,
  "durationTo": 600,
  "userTalkTimeFrom": 10,
  "userTalkTimeTo": 500,
  "qualityScoreFrom": 60,
  "qualityScoreTo": 100,
  "operatorNums": [
    "101",
    "102"
  ],
  "employeeIds": [
    201
  ],
  "leadIds": [
    1001
  ],
  "callHistoryTypes": [
    "ONLINEPBX",
    "ASTERISK"
  ],
  "callDirections": [
    "INBOUND"
  ],
  "kinds": [
    "CALL"
  ],
  "contacted": true,
  "missed": false,
  "hasRecording": true
}