Recall DTO
Описание сущностей и типов из src/dto/recall/.
Обогащено snapshot-данными бэкенд-DTO (15 из 18 типов сопоставлено, snapshot от 2026-05-05T13:21:51.699Z).
Содержание
- CreateRecallByPhoneRequestDto · backend ✓
- CreateRecallForNewClientRequestDto · backend ✓
- CreateRecallIntervalRequestDto · backend ✓
- CreateRecallRequestDto · backend ✓
- CreateRecallResponseDto · backend ✓
- GetActualRecallsRequestDto
- GetRecallSettingsResponseDto · backend ✓
- GetRecallsRequestDto · backend ✓
- GetRecallTimeZoneResponseDto
- QueueTypeDto · backend ✓
- RecallByPhoneRequestDto · backend ✓
- RecallCategoryDto
- RecallDto · backend ✓
- RecallSettingsDto · backend ✓
- RecallStatusDto · backend ✓
- SetRecallInProgressRequestDto · backend ✓
- UpdateRecallIntervalRequestDto · backend ✓
- UpdateRecallSettingsRequestDto · backend ✓
CreateRecallByPhoneRequestDto
Backend-источник: core.businesslogicservice/Core.BusinessLogicService/Nuget.BusinessApiClient/Dto/Recall/Requests/CreateRecallByPhoneRequestDto.cs (core.businesslogicservice).
Поля
| Поле | Тип (TS) | Обязательное | Описание | Тип (C#) |
|---|---|---|---|---|
phone | string | да | — | string |
recallDate | string | да | — | DateTime |
comments | string | null | нет | — | string? |
callCenterType | QueueTypeDto | да | — | QueueTypeDto |
emailId | number | null | нет | — | — |
externalType | ExternalTypeDto | null | нет | — | — |
externalId | number | null | нет | — | — |
category | RecallCategoryDto | null | нет | — | — |
Пример
{
"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#) |
|---|---|---|---|---|
phoneNumber | string | да | — | string |
comment | string | null | нет | — | string? |
secret | string | да | — | string |
Пример
{
"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#) |
|---|---|---|---|---|
startTime | string | да | Start from | TimeOnly |
endTime | string | да | End to | TimeOnly |
Пример
{
"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#) |
|---|---|---|---|---|
phoneContactId | number | да | — | int |
recallDate | string | null | нет | — | DateTime |
comments | string | null | нет | — | string? |
callCenterType | QueueTypeDto | да | — | QueueTypeDto |
externalType | ExternalTypeDto | null | нет | — | — |
externalId | number | null | нет | — | — |
category | RecallCategoryDto | null | нет | — | — |
Пример
{
"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#) |
|---|---|---|---|---|
recall | RecallDto | да | — | RecallDto |
Пример
{
"recall": "<RecallDto>"
}GetActualRecallsRequestDto
Фильтры для GET Api/Recalls/Actual.
Пара externalType + externalId сужает выборку до перезвона одной сущности; без неё возвращаются все актуальные перезвоны номера, включая те, у которых сущности нет (пропущенный звонок, перезвон из письма).
Поля
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
phoneNumber | string | да | — |
externalType | ExternalTypeDto | null | нет | — |
externalId | number | null | нет | — |
Пример
{
"phoneNumber": "+49123456789",
"externalType": "<externaltypedto>",
"externalId": 0
}GetRecallSettingsResponseDto
Backend-источник: core.businesslogicservice/Core.BusinessLogicService/Nuget.BusinessApiClient/Dto/Recall/Responses/GetRecallSettingsResponseDto.cs (core.businesslogicservice).
Также определён в:
integration.callcenternotification.
Поля
| Поле | Тип (TS) | Обязательное | Описание | Тип (C#) |
|---|---|---|---|---|
recallSettings | RecallSettingsDto | да | — | RecallSettingsDto |
Пример
{
"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#) |
|---|---|---|---|---|
pagination | Pagination | да | — | Pagination |
queueTypeFilter | PaginationFilter<QueueTypeDto> | null | нет | Queue facet. Counted after the status selection, so it describes that slice. | — |
categoryFilter | PaginationFilter<RecallCategoryDto> | null | нет | Category facet. Counted after the status selection, so it describes that slice. | — |
statusFilter | PaginationFilter<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] }. | — |
phoneContactId | number | null | нет | — | int? |
startFromFilter | string | null | нет | ISO 8601. Kept for compatibility — approximateRecallDateTime is the range form. | — |
endFromFilter | string | null | нет | ISO 8601. Kept for compatibility — approximateRecallDateTime is the range form. | — |
approximateRecallDateTime | PaginationRangeFilter<string> | нет | ISO 8601 range over the scheduled recall date-time. | — |
createdAt | PaginationRangeFilter<string> | нет | ISO 8601 range over the creation timestamp. | — |
updatedAt | PaginationRangeFilter<string> | нет | ISO 8601 range over the last-update timestamp. Recalls never updated are excluded. | — |
phoneNumber | string | нет | 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. | — |
recalledByUserIds | number[] | нет | Users who handled the recall. | — |
recalledByUserFullName | string | нет | Prefix match on the full name of the user who handled the recall. | — |
successfulAttemptsCount | PaginationRangeFilter<number> | нет | Range over the number of calls that reached the subscriber. | — |
failedAttemptsCount | PaginationRangeFilter<number> | нет | Range over the number of calls that did not reach the subscriber. | — |
externalTypes | ExternalTypeDto[] | нет | — | — |
externalId | number | нет | — | — |
emailId | number | нет | Email the recall was created from. | — |
recallInterval | PaginationRangeFilter<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. | — |
comments | string | нет | Substring match on the recall comment. | — |
Пример
{
"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",
"successfulAttemptsCount": "<PaginationRangeFilter<number>>",
"failedAttemptsCount": "<PaginationRangeFilter<number>>",
"externalTypes": [],
"externalId": 0,
"emailId": 0,
"recallInterval": "<PaginationRangeFilter<string>>",
"comments": "string"
}GetRecallTimeZoneResponseDto
Поля
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
timeZoneId | string | да | — |
Пример
{
"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#) |
|---|---|---|---|
NotFound | 0 | — | 0 |
CallCenter1 | 1 | — | 1 |
CallCenter2 | 2 | — | 2 |
CallCenter3 | 3 | — | 3 |
CallCenter4 | 4 | — | 4 |
CallCenterSupport | 5 | — | 5 |
Пример
0RecallByPhoneRequestDto
Закрывает перезвон по номеру. Сущность звонка сужает действие до её перезвона; без сущности берётся единственный актуальный перезвон номера, а если их несколько — только те, у которых сущности нет. Перезвоны других сущностей остаются в очереди.
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#) |
|---|---|---|---|---|
phoneNumber | string | да | — | string |
externalType | ExternalTypeDto | null | нет | — | — |
externalId | number | null | нет | — | — |
Пример
{
"phoneNumber": "+49123456789",
"externalType": "<externaltypedto>",
"externalId": 0
}RecallCategoryDto
Значения
| Имя | Значение | Описание |
|---|---|---|
PotentialClient | 1 | — |
Client | 2 | — |
PotentialWorker | 3 | — |
Worker | 4 | — |
PotentialPartner | 5 | — |
Partner | 6 | — |
Other | 7 | — |
Пример
1RecallDto
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#) |
|---|---|---|---|---|
id | number | да | Recall Id | int |
phoneContactId | number | да | Recall to PhoneContact id | int |
callCenterType | QueueTypeDto | да | Which call center will recall | QueueTypeDto |
comments | string | null | нет | Custom manager comments | string? |
attemptsCount | number | да | Recall attempts count | int |
successfulAttemptsCount | number | да | — | — |
failedAttemptsCount | number | да | — | — |
approximateRecallDateTime | string | да | Approximate date and time when recall should be done | DateTime |
recallIntervalFrom | string | null | нет | Recall should be done in time range start from | TimeOnly |
recallIntervalTo | string | null | нет | Recall should be done in time range end to | TimeOnly |
status | RecallStatusDto | да | Current recall status | RecallStatusDto |
recalledByUserId | number | null | нет | ID of user who recalled / is recalling | int? |
recalledByUserFullName | string | null | нет | Full name of user who recalled / is recalling | string? |
emailId | number | null | нет | — | — |
externalType | ExternalTypeDto | null | нет | — | — |
externalId | number | null | нет | — | — |
category | RecallCategoryDto | null | нет | — | — |
phoneContact | PhoneContactDto | да | Recall to contact | PhoneContactDto |
Пример
{
"id": 0,
"phoneContactId": 0,
"callCenterType": "<QueueTypeDto>",
"comments": "string",
"attemptsCount": 0,
"successfulAttemptsCount": 0,
"failedAttemptsCount": 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#) |
|---|---|---|---|---|
resetRecallPeriod | number | да | — | int |
recallShiftDays | number | да | — | int |
Пример
{
"resetRecallPeriod": 0,
"recallShiftDays": 0
}RecallStatusDto
Backend-источник: core.businesslogicservice/Core.BusinessLogicService/Nuget.BusinessApiClient/Dto/Recall/Enums/RecallStatusDto.cs (core.businesslogicservice).
Значения
| Имя | Значение (TS) | Описание | Код (C#) |
|---|---|---|---|
Waiting | 1 | — | 1 |
InProgress | 2 | — | 2 |
Done | 3 | — | 3 |
Cancelled | 4 | — | 4 |
Пример
1SetRecallInProgressRequestDto
Ставит перезвон в статус InProgress на старте звонка. Сущность звонка сужает действие до её перезвона; без сущности берётся единственный актуальный перезвон номера, а если их несколько — только те, у которых сущности нет.
Backend-источник: core.businesslogicservice/Core.BusinessLogicService/Nuget.BusinessApiClient/Dto/Recall/Requests/SetRecallInProgressRequestDto.cs (core.businesslogicservice).
Поля
| Поле | Тип (TS) | Обязательное | Описание | Тип (C#) |
|---|---|---|---|---|
phoneNumber | string | да | — | string |
userId | number | да | — | int |
userFullName | string | да | — | string |
externalType | ExternalTypeDto | null | нет | — | — |
externalId | number | null | нет | — | — |
Пример
{
"phoneNumber": "+49123456789",
"userId": 0,
"userFullName": "string",
"externalType": "<externaltypedto>",
"externalId": 0
}UpdateRecallIntervalRequestDto
Backend-источник: core.businesslogicservice/Core.BusinessLogicService/Nuget.BusinessApiClient/Dto/Recall/Requests/UpdateRecallIntervalRequestDto.cs (core.businesslogicservice).
Также определён в:
integration.callcenternotification.
Поля
| Поле | Тип (TS) | Обязательное | Описание | Тип (C#) |
|---|---|---|---|---|
id | number | да | Identifier | int |
startTime | string | да | Start from | TimeOnly |
endTime | string | да | End to | TimeOnly |
Пример
{
"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#) |
|---|---|---|---|---|
id | number | да | — | int |
resetRecallPeriod | number | да | — | int |
Пример
{
"id": 0,
"resetRecallPeriod": 0
}