Skip to content

GetRecallsRequestDto

← Recall DTO

Filters for GET Api/Recalls. Every field except pagination is optional — an absent field means the condition is not applied.

In each facet available is the universe the counts are computed over and selected is the choice; an absent or empty selected means every value.

Backend-источник: core.businesslogicservice/Core.BusinessLogicService/Nuget.BusinessApiClient/Dto/Recall/Requests/GetRecallsRequestDto.cs (core.businesslogicservice).

Также определён в: integration.callcenternotification.

Поля

ПолеТип (TS)ОбязательноеОписаниеТип (C#)
paginationPaginationдаPagination
queueTypeFilterPaginationFilter<QueueTypeDto> | nullнетQueue facet. Counted after the status selection, so it describes that slice.
categoryFilterPaginationFilter<RecallCategoryDto> | nullнетCategory facet. Counted after the status selection, so it describes that slice.
statusFilterPaginationFilter<RecallStatusDto> | nullнетStatus facet, counted before its own selection is applied, so it always shows how many recalls sit in each status. This endpoint used to live at Api/Recalls/Wait and returned waiting recalls unless told otherwise; there is no such default any more. Waiting recalls are statusFilter: { available: [...], selected: [RecallStatusDto.Waiting] }.
phoneContactIdnumber | nullнетint?
startFromFilterstring | nullнетISO 8601. Kept for compatibility — approximateRecallDateTime is the range form.
endFromFilterstring | nullнетISO 8601. Kept for compatibility — approximateRecallDateTime is the range form.
approximateRecallDateTimePaginationRangeFilter<string>нетISO 8601 range over the scheduled recall date-time.
createdAtPaginationRangeFilter<string>нетISO 8601 range over the creation timestamp.
updatedAtPaginationRangeFilter<string>нетISO 8601 range over the last-update timestamp. Recalls never updated are excluded.
phoneNumberstringнетExact match against the phone contact of the recall. Normalized before comparison (digits only, 49-prefixed), so +49 221 12345 and 0221 12345 both work, but a partial number does not match.
recalledByUserIdsnumber[]нетUsers who handled the recall.
recalledByUserFullNamestringнетPrefix match on the full name of the user who handled the recall.
attemptsCountPaginationRangeFilter<number>нет
externalTypesExternalTypeDto[]нет
externalIdnumberнет
emailIdnumberнетEmail the recall was created from.
recallIntervalPaginationRangeFilter<string>нетMatches recalls whose call window overlaps the requested one: from compares against the interval end, to against the interval start. Recalls without an interval are excluded once either bound is set. Values are HH:mm or HH:mm:ss.
commentsstringнетSubstring match on the recall comment.

Пример

json
{
  "pagination": "<Pagination>",
  "queueTypeFilter": "<paginationfilter<queuetypedto>>",
  "categoryFilter": "<paginationfilter<recallcategorydto>>",
  "statusFilter": "<paginationfilter<recallstatusdto>>",
  "phoneContactId": 0,
  "startFromFilter": "string",
  "endFromFilter": "string",
  "approximateRecallDateTime": "<PaginationRangeFilter<string>>",
  "createdAt": "<PaginationRangeFilter<string>>",
  "updatedAt": "<PaginationRangeFilter<string>>",
  "phoneNumber": "+49123456789",
  "recalledByUserIds": [],
  "recalledByUserFullName": "string",
  "attemptsCount": "<PaginationRangeFilter<number>>",
  "externalTypes": [],
  "externalId": 0,
  "emailId": 0,
  "recallInterval": "<PaginationRangeFilter<string>>",
  "comments": "string"
}