IntercomApi

API для управления домофонами.

Получение списка домофонов

Получение списка домофонов. Укажите страницу для запроса. Для первого запроса установите page = 0.

Если запрос прошел успешно, вы получите пагинированный ответ из групп. Если произойдет какая-либо ошибка, вы получите объект VMSApiError.

CODE

getIntercomsList(page: Int, completion: (PaginatedResponse<VMSIntercom>?, VMSApiError?))

Получение списка кодов домофона

Получение списка кодов домофона. Укажите страницу для запроса. Для первого запроса установите page = 0.

Если запрос прошел успешно, вы получите пагинированный ответ из групп. Если произойдет какая-либо ошибка, вы получите объект VMSApiError.

CODE

getIntercomCodesList(page: Int, completion: (PaginatedResponse<VMSIntercomCode>?, VMSApiError?))

Получение списка звонков

Получение списка звонков. Укажите страницу для запроса. Для первого запроса установите page = 0.

Если запрос прошел успешно, вы получите пагинированный ответ из групп. Если произойдет какая-либо ошибка, вы получите объект VMSApiError.

CODE

getCallsList(page: Int, completion: (PaginatedResponse<VMSIntercomCall>?, VMSApiError?))

Начать флоу добавления домофона

Этот запрос используется для запуска флоу добавления домофона.

Пользователь должен ввести код, полученный в результате этого запроса, а затем применить к домофону физический ключ домофона.

После этого вы получите push-уведомление, и пользователь должен ввести номер квартиры.

Если этот домофон уже был добавлен, этот запрос вернет ошибку с соответствующим информационным сообщением.

Если запрос прошел успешно, вы получите объект VMSActivationCode. Если произойдет какая-либо ошибка, вы получите объект ApiError.

CODE

getActivateCode(completion: (VMSActivationCode?, VMSApiError?))

Задать номер квартиры

Подключить домофон к конкретному номеру квартиры.

Создайте новую группу камер с указанным именем. Изначально группа пуста.

Если запрос прошел успешно, вы получите обновленный домофон. Если произойдет какая-либо ошибка, вы получите объект VMSApiError.

CODE

setIntercomFlat(intercomId: Int, flat: Int, completion: (VMSIntercom?, VMSApiError?))

Переименование домофона

Переименовать конкретный домофон по его идентификатору на новое имя.

Если запрос прошел успешно, вы получите обновленный домофон. Если произойдет какая-либо ошибка, вы получите объект VMSApiError.

CODE

renameIntercom(with id: Int, newName: String, completion: (VMSIntercom?, VMSApiError?))

Задать настройки домофона

Изменить параметры настроек конкретного домофона по его идентификатору.

Если запрос прошел успешно, вы получите обновленный домофон. Если произойдет какая-либо ошибка, вы получите объект VMSApiError.

CODE

changeIntercomSettings(with id: Int, isEnabled: Bool, timetable: VMSTimetable?, completion: (VMSIntercom?, VMSApiError?))

public final class VMSTimetable: Codable {
    public var days: [VMSDays]?
    public var intervals: [VMSIntervals]?
}

id — идентификатор домофона

is_enabled — установите значение false, если вы хотите отключить домофон. В этом случае звонки с домофона не будут поступать на текущее устройство

timetable — расписание домофонных звонков. Звонки будут приниматься только в выбранное время

VMSTimetable

Расписание домофонных звонков.

Расписание можно настроить двумя способами:

по дням
по интервалам

Вы не можете установить оба параметра одновременно. В этом случае будут установлены интервалы.

CODE

init(days: [VMSDays]?, intervals: [VMSIntervals]?)

Открытие двери

Открыть дверь домофона.

Если запрос был успешным, ответом будет nil. Если произойдет какая-либо ошибка, вы получите объект VMSApiError.

CODE

openDoor(intercomId: Int, completion: (VMSApiError?))

Создание кода

Создать код для физического открытия двери.

Если запрос прошел успешно, вы получите объект VMSIntercomCode. Если произойдет какая-либо ошибка, вы получите объект VMSApiError.

CODE

createCode(intercomId: Int, name: String, expiredAt: Date, completion: (VMSIntercomCode?, VMSApiError?))

intercomId — идентификатор домофона

name — наименование нового кода

expiredAt — дата, до которой этот код будет действителен

Удаление дофомонов

Удалите домофоны, которые вам больше не нужны.

Если запрос был успешным, ответом будет nil. Если произойдет какая-либо ошибка, вы получите объект VMSApiError.

CODE

deleteIntercoms(with ids: [Int], completion: (VMSApiError?))

Удаление кодов домофона

Удалите коды домофона, которые вам больше не нужны.

Если запрос был успешным, ответом будет nil. Если произойдет какая-либо ошибка, вы получите объект VMSApiError.

CODE

deleteIntercomCodes(with ids: [Int], completion: (VMSApiError?))

Удаление звонков

Удалите звонки, которые вам больше не нужны.

Если запрос был успешным, ответом будет nil. Если произойдет какая-либо ошибка, вы получите объект VMSApiError.

CODE

deleteCalls(with ids: [Int], completion: (VMSApiError?))