Skip to content

Recall DTO

Описание сущностей и типов из src/dto/recall/.

Обогащено snapshot-данными бэкенд-DTO (16 из 18 типов сопоставлено, snapshot от 2026-05-05T13:21:51.699Z).

Содержание


CreateRecallByPhoneRequestDto

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

Поля

ПолеТип (TS)ОбязательноеОписаниеТип (C#)
phonestringдаstring
recallDatestringдаDateTime
commentsstring | nullнетstring?
callCenterTypeQueueTypeDtoдаQueueTypeDto
emailIdnumber | nullнет
externalTypeExternalTypeDto | nullнет
externalIdnumber | nullнет
categoryRecallCategoryDto | nullнет

Пример

json
{
  "phone": "+49123456789",
  "recallDate": "2026-05-05T08:00:00Z",
  "comments": "string",
  "callCenterType": "<QueueTypeDto>",
  "emailId": 0,
  "externalType": "<externaltypedto>",
  "externalId": 0,
  "category": "<recallcategorydto>"
}


CreateRecallForNewClientRequestDto

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

Поля

ПолеТип (TS)ОбязательноеОписаниеТип (C#)
phoneNumberstringдаstring
commentstring | nullнетstring?
secretstringдаstring

Пример

json
{
  "phoneNumber": "+49123456789",
  "comment": "string",
  "secret": "string"
}


CreateRecallIntervalRequestDto

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

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

Поля

ПолеТип (TS)ОбязательноеОписаниеТип (C#)
startTimestringдаStart fromTimeOnly
endTimestringдаEnd toTimeOnly

Пример

json
{
  "startTime": "2026-05-05T08:00:00Z",
  "endTime": "2026-05-05T08:00:00Z"
}


CreateRecallRequestDto

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

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

Поля

ПолеТип (TS)ОбязательноеОписаниеТип (C#)
phoneContactIdnumberдаint
recallDatestring | nullнетDateTime
commentsstring | nullнетstring?
callCenterTypeQueueTypeDtoдаQueueTypeDto
externalTypeExternalTypeDto | nullнет
externalIdnumber | nullнет
categoryRecallCategoryDto | nullнет

Пример

json
{
  "phoneContactId": 0,
  "recallDate": "2026-05-05T08:00:00Z",
  "comments": "string",
  "callCenterType": "<QueueTypeDto>",
  "externalType": "<externaltypedto>",
  "externalId": 0,
  "category": "<recallcategorydto>"
}


CreateRecallResponseDto

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

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

Поля

ПолеТип (TS)ОбязательноеОписаниеТип (C#)
recallRecallDtoдаRecallDto

Пример

json
{
  "recall": "<RecallDto>"
}


GetRecallSettingsResponseDto

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

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

Поля

ПолеТип (TS)ОбязательноеОписаниеТип (C#)
recallSettingsRecallSettingsDtoдаRecallSettingsDto

Пример

json
{
  "recallSettings": "<RecallSettingsDto>"
}


GetRecallsRequestDto

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"
}


GetRecallTimeZoneResponseDto

Поля

ПолеТипОбязательноеОписание
timeZoneIdstringда

Пример

json
{
  "timeZoneId": "2026-05-05T08:00:00Z"
}


QueueTypeDto

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

Также определён в: features.callcenterservice, infrastructure.notificationservice, integration.callcenternotification.

Значения

ИмяЗначение (TS)ОписаниеКод (C#)
NotFound00
CallCenter111
CallCenter222
CallCenter333
CallCenter444
CallCenterSupport55

Пример

json
0


RecallByPhoneRequestDto

Simple request with only PhoneNumber -- used for MarkDone and ShiftByPeriods

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

Simple request with only PhoneNumber -- used for MarkDone and ShiftByPeriods

Поля

ПолеТип (TS)ОбязательноеОписаниеТип (C#)
phoneNumberstringдаstring

Пример

json
{
  "phoneNumber": "+49123456789"
}


RecallCategoryDto

Значения

ИмяЗначениеОписание
PotentialClient1
Client2
PotentialWorker3
Worker4
PotentialPartner5
Partner6
Other7

Пример

json
1


RecallDto

Describe recall to contact

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

Describe recall to contact

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

Поля

ПолеТип (TS)ОбязательноеОписаниеТип (C#)
idnumberдаRecall Idint
phoneContactIdnumberдаRecall to PhoneContact idint
callCenterTypeQueueTypeDtoдаWhich call center will recallQueueTypeDto
commentsstring | nullнетCustom manager commentsstring?
attemptsCountnumberдаRecall attempts countint
approximateRecallDateTimestringдаApproximate date and time when recall should be doneDateTime
recallIntervalFromstring | nullнетRecall should be done in time range start fromTimeOnly
recallIntervalTostring | nullнетRecall should be done in time range end toTimeOnly
statusRecallStatusDtoдаCurrent recall statusRecallStatusDto
recalledByUserIdnumber | nullнетID of user who recalled / is recallingint?
recalledByUserFullNamestring | nullнетFull name of user who recalled / is recallingstring?
emailIdnumber | nullнет
externalTypeExternalTypeDto | nullнет
externalIdnumber | nullнет
categoryRecallCategoryDto | nullнет
phoneContactPhoneContactDtoдаRecall to contactPhoneContactDto

Пример

json
{
  "id": 0,
  "phoneContactId": 0,
  "callCenterType": "<QueueTypeDto>",
  "comments": "string",
  "attemptsCount": 0,
  "approximateRecallDateTime": "2026-05-05T08:00:00Z",
  "recallIntervalFrom": "2026-05-05T08:00:00Z",
  "recallIntervalTo": "2026-05-05T08:00:00Z",
  "status": "<RecallStatusDto>",
  "recalledByUserId": 0,
  "recalledByUserFullName": "string",
  "emailId": 0,
  "externalType": "<externaltypedto>",
  "externalId": 0,
  "category": "<recallcategorydto>",
  "phoneContact": "<PhoneContactDto>"
}


RecallSettingsDto

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

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

Поля

ПолеТип (TS)ОбязательноеОписаниеТип (C#)
resetRecallPeriodnumberдаint
recallShiftDaysnumberдаint

Пример

json
{
  "resetRecallPeriod": 0,
  "recallShiftDays": 0
}


RecallStatusDto

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

Значения

ИмяЗначение (TS)ОписаниеКод (C#)
Waiting11
InProgress22
Done33
Cancelled44

Пример

json
1


SetRecallInProgressRequestDto

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

Поля

ПолеТип (TS)ОбязательноеОписаниеТип (C#)
phoneNumberstringдаstring
userIdnumberдаint
userFullNamestringдаstring

Пример

json
{
  "phoneNumber": "+49123456789",
  "userId": 0,
  "userFullName": "string"
}


ShiftRecallToDateRequestDto

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

Поля

ПолеТип (TS)ОбязательноеОписаниеТип (C#)
phoneNumberstringдаstring
callBackDateTimestringдаDateTime

Пример

json
{
  "phoneNumber": "+49123456789",
  "callBackDateTime": "2026-05-05T08:00:00Z"
}


UpdateRecallIntervalRequestDto

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

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

Поля

ПолеТип (TS)ОбязательноеОписаниеТип (C#)
idnumberдаIdentifierint
startTimestringдаStart fromTimeOnly
endTimestringдаEnd toTimeOnly

Пример

json
{
  "id": 0,
  "startTime": "2026-05-05T08:00:00Z",
  "endTime": "2026-05-05T08:00:00Z"
}


UpdateRecallSettingsRequestDto

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

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

Поля

ПолеТип (TS)ОбязательноеОписаниеТип (C#)
idnumberдаint
resetRecallPeriodnumberдаint

Пример

json
{
  "id": 0,
  "resetRecallPeriod": 0
}