recallService
recallService
- recallService
- GetTable(request) ⇒
Promise.<ApiResult> - GetActual(request) ⇒
Promise.<ApiResult> - Add(params) ⇒
Promise.<ApiResult> - AddByPhone(params) ⇒
Promise.<ApiResult> - Start(recallId) ⇒
Promise.<ApiResult> - Cancel(recallId) ⇒
Promise.<ApiResult> - GetIntervals() ⇒
Promise.<ApiResult> - GetTimeZone() ⇒
Promise.<ApiResult> - AddInterval(params) ⇒
Promise.<ApiResult> - UpdateInterval(params) ⇒
Promise.<ApiResult> - DeleteInterval(id) ⇒
Promise.<ApiResult> - GetSettings() ⇒
Promise.<ApiResult> - UpdateSettings(params) ⇒
Promise.<ApiResult>
- GetTable(request) ⇒
GetTable(request) ⇒ Promise.<ApiResult>
Получает список перезвонов с пагинацией и фильтрами.
Все фильтры кроме pagination опциональны: не передан — условие не применяется. Страница строк возвращается только если хотя бы у одного из queueTypes, categories, statuses задан selected; иначе в ответе только счётчики фасетов.
Принимаемые параметры
| Param | Type | Description |
|---|---|---|
| request | GetRecallsRequestDto | Фильтры и пагинация. См. GetRecallsRequestDto |
Возвращаемые данные
Returns: Promise.<ApiResult> - Перезвоны под полем pagination, счётчики под queueTypeFilters, categoryFilters и statusFilters
WARNING
Раньше метод принимал готовую query-строку. Теперь принимает DTO и собирает строку сам.
statuses не передан — возвращаются только перезвоны в статусе Waiting, как было раньше. statuses.selected = [0] — все статусы, включая Done и Cancelled, которые через этот эндпоинт раньше были недоступны.
Пример
await recallService.GetTable({
pagination: { page: 1, rowsPerPage: 25, sortBy: 'ApproximateRecallDateTime', descending: false },
queueTypeFilter: { available: [1, 2, 3, 4, 5] },
statusFilter: { available: [1, 2, 3, 4], selected: [1] },
recallInterval: { from: '09:00', to: '12:00' },
})GetActual(request) ⇒ Promise.<ApiResult>
Получает актуальные (Waiting или InProgress) перезвоны номера.
Имя сущности в ответе не приходит: его берут из contactService.GetLinkedEntities по паре externalType + externalId.
Принимаемые параметры
| Param | Type | Description |
|---|---|---|
| request | GetActualRecallsRequestDto | Фильтры. См. GetActualRecallsRequestDto |
Возвращаемые данные
Returns: Promise.<ApiResult> - Перезвоны под полем recalls (пустой массив, если актуальных нет)
WARNING
Раньше метод принимал строку с номером и отдавал единственный перезвон под полем recall. Теперь принимает DTO и отдаёт массив под полем recalls: на одном номере может одновременно висеть по перезвону на каждую связанную сущность.
Передал externalType + externalId — вернётся перезвон только этой сущности (так проверяется дубль перед созданием и берётся recallId на завершении звонка). Не передал — вернутся все перезвоны номера, включая те, у которых сущности нет.
Пример
const { recalls } = await recallService.GetActual({
phoneNumber: '+49 221 55 44 33',
externalType: ExternalTypeDto.Client,
externalId: 1234,
})Add(params) ⇒ Promise.<ApiResult>
Добавляет перезвон контакту.
Актуальность перезвона считается по тройке «контакт + externalType + externalId»: если у этой сущности на этом номере уже есть актуальный перезвон — он сдвигается на новую дату, а комментарий дописывается. Для другой сущности создаётся отдельный перезвон, и перезвоны остальных сущностей номера не отменяются.
Сущность не передана — перезвон создаётся без привязки и живёт своей записью; бэк не пытается угадать сущность по связям номера.
Принимаемые параметры
| Param | Type | Description |
|---|---|---|
| params | CreateRecallRequestDto | Тело запроса. См. CreateRecallRequestDto |
Возвращаемые данные
Returns: Promise.<ApiResult> - Созданный перезвон под полем recall
AddByPhone(params) ⇒ Promise.<ApiResult>
Создаёт перезвон для контакта, найденного по номеру телефона — для вызывающего, у которого есть номер (например, лид), а не id контакта. Сущность — через externalType + externalId.
Принимаемые параметры
| Param | Type | Description |
|---|---|---|
| params | CreateRecallByPhoneRequestDto | Тело запроса. См. CreateRecallByPhoneRequestDto |
Возвращаемые данные
Returns: Promise.<ApiResult> - Созданный перезвон под полем recall
Start(recallId) ⇒ Promise.<ApiResult>
Запускает перезвон по ID
Принимаемые параметры
| Param | Type | Description |
|---|---|---|
| recallId | number | ID перезвона |
Возвращаемые данные
Returns: Promise.<ApiResult> - Подтверждение операции
Cancel(recallId) ⇒ Promise.<ApiResult>
Отменяет перезвон по ID
Принимаемые параметры
| Param | Type | Description |
|---|---|---|
| recallId | number | ID перезвона |
Возвращаемые данные
Returns: Promise.<ApiResult> - Подтверждение операции
GetIntervals() ⇒ Promise.<ApiResult>
Получает список интервалов перезвонов
Возвращаемые данные
Returns: Promise.<ApiResult> - Список интервалов перезвонов
GetTimeZone() ⇒ Promise.<ApiResult>
Получает идентификатор часового пояса, в котором заданы StartTime/EndTime интервалов перезвонов
Возвращаемые данные
Returns: Promise.<ApiResult> - Идентификатор часового пояса
AddInterval(params) ⇒ Promise.<ApiResult>
Добавляет новый интервал перезвонов
Принимаемые параметры
| Param | Type | Description |
|---|---|---|
| params | CreateRecallIntervalRequestDto | Тело запроса. См. CreateRecallIntervalRequestDto |
Возвращаемые данные
Returns: Promise.<ApiResult> - Подтверждение операции
UpdateInterval(params) ⇒ Promise.<ApiResult>
Обновляет существующий интервал перезвонов
Принимаемые параметры
| Param | Type | Description |
|---|---|---|
| params | UpdateRecallIntervalRequestDto | Тело запроса. См. UpdateRecallIntervalRequestDto |
Возвращаемые данные
Returns: Promise.<ApiResult> - Подтверждение операции
DeleteInterval(id) ⇒ Promise.<ApiResult>
Удаляет интервал перезвонов по ID
Принимаемые параметры
| Param | Type | Description |
|---|---|---|
| id | number | ID интервала перезвонов |
Возвращаемые данные
Returns: Promise.<ApiResult> - Подтверждение операции
GetSettings() ⇒ Promise.<ApiResult>
Получает настройки перезвонов
Возвращаемые данные
Returns: Promise.<ApiResult> - Настройки перезвонов
UpdateSettings(params) ⇒ Promise.<ApiResult>
Обновляет настройки перезвонов
Принимаемые параметры
| Param | Type | Description |
|---|---|---|
| params | UpdateRecallSettingsRequestDto | Тело запроса. См. UpdateRecallSettingsRequestDto |
Возвращаемые данные
Returns: Promise.<ApiResult> - Подтверждение операции