recallService

recallService

• recallService
  • GetTable(request) ⇒ Promise.<ApiResult>
  • GetActual(phoneNumber) ⇒ Promise.<ApiResult>
  • Add(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) ⇒ 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(phoneNumber) ⇒ Promise.<ApiResult>

Получает единственный актуальный (Waiting или InProgress) перезвон контакта по номеру телефона. Используется на завершении звонка, чтобы получить recallId и текущую дату перезвона.

Принимаемые параметры

Param	Type	Description
phoneNumber	string	Номер телефона контакта

Возвращаемые данные

Returns: Promise.<ApiResult> - Перезвон под полем recall (или null, если актуального нет)

---

Add(params) ⇒ Promise.<ApiResult>

Добавляет перезвон контакту. Если для контакта уже есть актуальный перезвон, он сдвигается на новую дату.

Принимаемые параметры

Param	Type	Description
params	CreateRecallRequestDto	Тело запроса. См. CreateRecallRequestDto

Возвращаемые данные

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> - Подтверждение операции

---