Skip to main content

CallHistoryFilterDTO

Request body for POST /v1/open-api/call-history/filter. All fields are optional except page and size. Multiple filter fields are combined with AND logic.

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
startint64

Lower bound for the call start time (epoch seconds). Defaults to 0 (no lower bound).

Default value: 0
Example: 1700000000
finishint64

Upper bound for the call start time (epoch seconds). Defaults to Long.MAX_VALUE (no upper bound).

Example: 1750000000
phoneSearchstringnullable

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

Example: +998901234567
operatorNumsstring[]nullable

Filter by one or more operator (employee) numbers. Matches the employeeNum field on the record. Omit or pass null to include all operators.

Example: ["101","102"]
callHistoryTypesCallHistoryType[]nullable

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

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

Example: ["ONLINEPBX","ASTERISK"]
callDirectionCallDirectionnullable

Filter by call direction. INBOUND — incoming calls; OUTBOUND — outgoing calls. Omit or pass null to include both directions.

Possible values: [INBOUND, OUTBOUND]

Example: INBOUND
CallHistoryFilterDTO
{
  "page": 1,
  "size": 10,
  "start": 1700000000,
  "finish": 1750000000,
  "phoneSearch": "+998901234567",
  "operatorNums": [
    "101",
    "102"
  ],
  "callHistoryTypes": [
    "ONLINEPBX",
    "ASTERISK"
  ],
  "callDirection": "INBOUND"
}