¶ Поддерживаемые домофоны
Поддерживаемые модели домофонов:
- Akuvox R20A, R20K
- Beward серии DKS
- Secret Top T3 API
- Сокол Плюс
- ELTIS DP7000ip-Hybrid
¶ Роли пользователей
¶ Администратор платформы
- Установка компонентов системы
- Установка платформы Форпост
- Установка сервера Asterisk
- Создание БД для Asterisk
- Активация модуля Домофонии
- Создание SIP-сервера через административную панель
- Создание аккаунта управляющей компании
- Подключение домофонов. Выбор, либо создание Дома и подъезда. Выбор режима работы: обычный или калитка.
¶ Инструкция администратора
Инструкция администратора платформы домофонии доступна по ссылке
¶ Администратор УК
- Добавление собственников квартир. Имеется возможность экспорта из файла. В случае необходимости рассылки УЗ для входа в систему, необходимо предварительно настроить SMS шлюз.
- Настройка правила вызова для абонентов, при необходимости
- Установка прав доступа для пользователей на доступ к онлайну, доступ к архиву и скачивание
¶ Схема вызова
- Гость (резидент) набирает на панели домофона номер квартиры.
- Домофон инициирует вызов через SIP сервер. Если к домофону подключен адаптер для работы с аналоговыми трубками, то вызов совершается одновременно и на трубки и на SIP сервер.
- SIP сервер по номеру вызываемой квартиры, получает из БД родительский аккаунт пользователя, который соответствует этой квартире и все зарегистрированные дочерние аккаунты устройств.
- SIP сервер проверяет доступность всех дочерних аккаунтов. Если аккаунт не в сети, на телефон абонента отправляется push уведомление о звонке.
- SIP сервер осуществляет дозвон на все доступные дочерние аккаунты. Если хоть один из дочерних аккаунтов ответил на вызов, дозвон до остальных аккаунтов прерывается. Также прерывается дозвон на аналоговую трубку, при ее наличии.
- Пользователь отвечает на вызов из мобильного приложения (МП) и может либо отправить команду на открытие домофона, либо завершить вызов без открытия.
- SIP сервер завершает вызов и сохраняет данные о нем в журнале.
¶ Требования сетевой доступности
1. Веб-портал Форпост, SIP-сервер Asterisk, Домофон должны быть расположены в одной локальной сети.
Либо должна быть обеспечена сетевая доступность между всеми тремя компонентами.
2. Из внешнего интернета должны быть доступны:
Веб-портал по портам:
| 80 | TCP | для для взаимодействия по HTTP |
| 8080 \ 18080 | TCP+UDP | отображение видео с камеры домофона по RTSP (порты cctv-ctreamer) |
SIP-сервер по портам:
| 15160 | TCP+UDP | для работы SIP-сервера |
| 10000-32000 | UDP | для передачи звука между домофоном и мобильным приложением по RTP |
Также в локальной сети, дополнительно к вышеперечисленному, должны быть разрешены порты:
| 5038 | TCP | для работы скриптов управления SIP phpagi (протокол AMI) |
| 3306 | TCP | для входящих подключений Веб-портала к БД SIP-сервера (при Варианте подключения №2) |
Более подробно на схемах в подключения.
¶ Схемы подключения
¶ Управление через API
¶ Добавление домофона
- Получить список всех домофонных аккаунтов, чтобы выбрать нужный для добавления в него домофона. Домофонные аккаунты - это те аккаунты, в которые должны добавляться домофоны, обслуживаемые одной организацией, которая выдает доступ жильцам к этим домофонам; если все домофоны в системе обслуживает одна организация, то домофонный аккаунт будет один.
curl --location 'http://HOST/system-api/GetAccounts' \
--data-urlencode 'AdminLogin=ADMIN_LOGIN' \
--data-urlencode 'AdminPassword=ADMIN_PASSWORD' \
--data-urlencode 'IsManagementAllowed=1'
- Если нужный домофонный аккаунт отсутствует, то добавить аккаунт с необходимым названием (параметр Name)
curl --location 'http://HOST/system-api/AddAccount' \
--data-urlencode 'AdminLogin=ADMIN_LOGIN' \
--data-urlencode 'AdminPassword=ADMIN_PASSWORD' \
--data-urlencode 'IsManagementAllowed=1' \
--data-urlencode 'Name=Домофоны' \
--data-urlencode 'MaxCameraCount=1000000' \
--data-urlencode 'MaxLoginCount=1000000' \
--data-urlencode 'MaxCameraOnlineTranslationCount=1000000' \
--data-urlencode 'MaxCameraArchivalTranslationCount=1000000' \
--data-urlencode 'MaxCameraUserOnlineTranslationCount=1000000' \
--data-urlencode 'MaxCameraUserArchivalTranslationCount=1000000'Создать пользователя-оператора для управления квартирами в домофонном аккаунте (AccountID=ID аккаунта, который вернул вызов AddAccount) и параметрами учетной записи пользователя-оператора (Login, Password)
curl --location 'http://HOST/system-api/AddUser' \
--data-urlencode 'AdminLogin=ADMIN_LOGIN' \
--data-urlencode 'AdminPassword=ADMIN_PASSWORD' \
--data-urlencode 'AccountID=98' \
--data-urlencode 'Login=doperator' \
--data-urlencode 'Password=Fxkw1N8YN8ne' \
--data-urlencode 'IsReadOnly=1' \
--data-urlencode 'IsAccessibleNewCameraByDefault=1' \
--data-urlencode 'IsAccountUserAdmin=1' \
--data-urlencode 'IsPassAdmin=1'
- Получить список типов устройств, чтобы выбрать идентификатор нужного типа для добавления домофона
curl --location 'http://HOST/system-api/GetDeviceTypes' \
--data-urlencode 'AdminLogin=ADMIN_LOGIN' \
--data-urlencode 'AdminPassword=ADMIN_PASSWORD'
- Создать устройство в домофонном аккаунте (AccountID) с типом (TypeID=ID типа, который вернул вызов GetDeviceTypes), названием (Description=строка в формате "Улица Номер дома [Номер подъезда]"), параметрами подключения к домофону (Settings):
curl --location 'http://HOST/system-api/AddDevice' \
--data-urlencode 'AdminLogin=ADMIN_LOGIN' \
--data-urlencode 'AdminPassword=ADMIN_PASSWORD' \
--data-urlencode 'AccountID=98' \
--data-urlencode 'TypeID=9' \
--data-urlencode 'Description=Попова 101 [3]' \
--data-urlencode 'Settings={"host":"10.23.11.15","port":80,"login":"admin","password":"admin"}'
- Создать камеру в домофонном аккаунте (AccountID) с названием (Name=строка в формате "Улица Номер дома [Номер подъезда]"), идентификатором модели камеры (CameraModelID), параметрами подключения к домофону по сети (IPOrDomain, Login, Password, Port, HTTPPort), параметрами записи (MaxBandwidth, RecordType, Quota)
curl --location 'http://HOST/system-api/AddCamera' \
--data-urlencode 'AdminLogin=ADMIN_LOGIN' \
--data-urlencode 'AdminPassword=ADMIN_PASSWORD' \
--data-urlencode 'AccountID=98' \
--data-urlencode 'Name=Попова 101 [3]' \
--data-urlencode 'CameraModelID=1951' \
--data-urlencode 'IPOrDomain=10.23.11.15' \
--data-urlencode 'Login=admin' \
--data-urlencode 'Password=admin' \
--data-urlencode 'Port=554' \
--data-urlencode 'HTTPPort=80' \
--data-urlencode 'MaxBandwidth=2048' \
--data-urlencode 'RecordType=1' \
--data-urlencode 'Quota=604800' \
--data-urlencode 'MasterID=1' \
--data-urlencode 'IsSound=1' \
--data-urlencode 'Protocol=rtsp' \
--data-urlencode 'RtspTransport=0' \
--data-urlencode 'IsActive=1' \
--data-urlencode 'SkipCameraCheck=1' \
--data-urlencode 'SyncCamera=0'
- Связать устройство (ID, который вернул вызов AddDevice) с камерой (CameraIDList=[ID], который вернул вызов AddCamera)
curl --location 'http://HOST/system-api/BindDeviceToCameras' \
--data-urlencode 'AdminLogin=ADMIN_LOGIN' \
--data-urlencode 'AdminPassword=ADMIN_PASSWORD' \
--data-urlencode 'ID=32' \
--data-urlencode 'CameraIDList=[832]'
- Создать в домофонном аккаунте (AccountID) группу дома с названием (Name=строка в формате "Улица Номер дома")
curl --location 'http://HOST/system-api/AddAccountGroup' \
--data-urlencode 'AdminLogin=ADMIN_LOGIN' \
--data-urlencode 'AdminPassword=ADMIN_PASSWORD' \
--data-urlencode 'AccountID=98' \
--data-urlencode 'Name=Попова 101'
- Если необходимо, то в домофонном аккаунте группе дома (AccountGroupID) присвоить идентификатор дома во внешней информационной системе/биллинге (ExtBillingIDList=[ID])
curl --location 'http://HOSTru/system-api/SetExtBillingIDOfAccountGroup' \
--data-urlencode 'AdminLogin=ADMIN_LOGIN' \
--data-urlencode 'AdminPassword=ADMIN_PASSWORD' \
--data-urlencode 'ExtBillingIDList=[10100]' \
--data-urlencode 'AccountGroupID=191'
- Создать в домофонном аккаунте (AccountID) группу подъезда с названием (Name=строка в формате "Номер подъезда") и вложенностью в группу дома (ParentID=ID, который вернул вызов AddAccountGroup при создании группы дома)
curl --location 'http://HOST/system-api/AddAccountGroup' \
--data-urlencode 'AdminLogin=ADMIN_LOGIN' \
--data-urlencode 'AdminPassword=ADMIN_PASSWORD' \
--data-urlencode 'AccountID=98' \
--data-urlencode 'Name=3' \
--data-urlencode 'ParentID=191'
- Если необходимо, то в домофонном аккаунте группе подъезда (AccountGroupID) присвоить идентификатор подъезда во внешней информационной системе/биллинге (ExtBillingIDList=[Номер подъезда])
curl --location 'http://HOST/system-api/SetExtBillingIDOfAccountGroup' \
--data-urlencode 'AdminLogin=ADMIN_LOGIN' \
--data-urlencode 'AdminPassword=ADMIN_PASSWORD' \
--data-urlencode 'ExtBillingIDList=[3]' \
--data-urlencode 'AccountGroupID=192'
- Связать группу подъезда (AccountGroupID=ID, который вернул вызов AddAccountGroup при создании группы подъезда) с камерой (CameraIDList=[ID], который вернул вызов AddCamera)
curl --location 'http://HOST/system-api/EditAccountGroupCameras' \
--data-urlencode 'AdminLogin=ADMIN_LOGIN' \
--data-urlencode 'AdminPassword=ADMIN_PASSWORD' \
--data-urlencode 'AccountGroupID=192' \
--data-urlencode 'CameraIDList=[832]'
- Создать учетную запись SIP для домофона (ControlledDeviceID=ID, который вернул вызова AddDevice), указав группу подъезда (AccountGroupID=ID, который вернул вызов AddAccountGroup при создании группы подъезда) и SIP-сервер (SipServerID=1)
curl --location 'http://HOST/system-api/AddSipDevice' \
--data-urlencode 'AdminLogin=ADMIN_LOGIN' \
--data-urlencode 'AdminPassword=ADMIN_PASSWORD' \
--data-urlencode 'ControlledDeviceID=32' \
--data-urlencode 'AccountGroupID=192' \
--data-urlencode 'SipServerID=1'¶ Создание и включение квартиры
- Создать аккаунт квартиры с названием (Name=строка в формате "Улица Номер дома [Номер подъезда] [Номер квартиры]"), разрешив управление аккаунтом квартиры для домофонного аккаунта (ManagementAccountID)
curl --location 'http://HOST/system-api/AddAccount' \
--data-urlencode 'AdminLogin=ADMIN_LOGIN' \
--data-urlencode 'AdminPassword=ADMIN_PASSWORD' \
--data-urlencode 'Name=Попова 101 [3] [14]' \
--data-urlencode 'ManagementAccountID=98' \
--data-urlencode 'MaxCameraCount=1000000' \
--data-urlencode 'MaxLoginCount=1000000' \
--data-urlencode 'MaxCameraOnlineTranslationCount=1000000' \
--data-urlencode 'MaxCameraArchivalTranslationCount=1000000' \
--data-urlencode 'MaxCameraUserOnlineTranslationCount=1000000' \
--data-urlencode 'MaxCameraUserArchivalTranslationCount=1000000'
- Найти группу дома в домофонном аккаунте
По домофонному аккаунту (AccountID) и адресу (Name=Улица Номер дома)
curl --location 'http://HOST/system-api/GetAccountGroups' \
--data-urlencode 'AdminLogin=ADMIN_LOGIN' \
--data-urlencode 'AdminPassword=ADMIN_PASSWORD' \
--data-urlencode 'AccountID=98' \
--data-urlencode 'Name=Попова 101'По идентификатору дома во внешней информационной системе/биллинге (ExtBillingID):
curl --location 'http://HOST/system-api/GetAccountGroups' \
--data-urlencode 'AdminLogin=ADMIN_LOGIN' \
--data-urlencode 'AdminPassword=ADMIN_PASSWORD' \
--data-urlencode 'ExtBillingID=10100'
- Найти группу подъезда
По дому (ParentID=ID группы дома) и по номеру подъезда (Name=Номер подъезда)
curl --location 'http://HOST/system-api/GetAccountGroups' \
--data-urlencode 'AdminLogin=ADMIN_LOGIN' \
--data-urlencode 'AdminPassword=ADMIN_PASSWORD' \
--data-urlencode 'ParentID=191' \
--data-urlencode 'Name=3'По дому (ParentID=ID группы дома) и по идентификатору подъезда во внешней информационной системе/биллинге (ExtBillingIDList=[Номер подъезда 1, Номер подъезда 2])
curl --location 'http://HOST/system-api/GetAccountGroups' \
--data-urlencode 'AdminLogin=ADMIN_LOGIN' \
--data-urlencode 'AdminPassword=ADMIN_PASSWORD' \
--data-urlencode 'ParentID=191' \
--data-urlencode 'ExtBillingIDList=[3]'
- Создать квартиру с номером (Apartment) в аккаунте квартиры (AccountID) и связью с группой подъезда в домофонном аккаунте (AccountGroupID)
curl --location 'http://HOST/system-api/SetAccountApartment' \
--data-urlencode 'AdminLogin=ADMIN_LOGIN' \
--data-urlencode 'AdminPassword=ADMIN_PASSWORD' \
--data-urlencode 'AccountID=99' \
--data-urlencode 'AccountGroupID=192' \
--data-urlencode 'Apartment=14' \
--data-urlencode 'IsActive=3'
- Создать учетную запись для входа пользователей в мобильное приложения и приема входящих вызовов с домофона в квартиру (AccountID)
curl --location 'http://HOST/system-api/AddUser' \
--data-urlencode 'AdminLogin=ADMIN_LOGIN' \
--data-urlencode 'AdminPassword=ADMIN_PASSWORD' \
--data-urlencode 'AccountID=99' \
--data-urlencode 'Login=user99' \
--data-urlencode 'Password=Wcf1Tx7k3vvq' \
--data-urlencode 'IsReadOnly=1' \
--data-urlencode 'IsAccessibleNewCameraByDefault=1'
- Если требуется принимать вызов в квартиру с помощью SIP панели, то создать SIP устройство в аккаунте квартиры (AccountID)
curl --location 'http://HOST/system-api/AddApartmentSipDevice' \
--data-urlencode 'AdminLogin=ADMIN_LOGIN' \
--data-urlencode 'AdminPassword=ADMIN_PASSWORD' \
--data-urlencode 'AccountID=99' \
--data-urlencode 'Name=Приемная панель'¶ Получение списка квартир
Получение списка квартир дома (ParentAccountGroupID)
curl --location 'http://HOST/system-api/GetAccountApartments' \
--data-urlencode 'AdminLogin=ADMIN_LOGIN' \
--data-urlencode 'AdminPassword=ADMIN_PASSWORD' \
--data-urlencode 'ParentAccountGroupID=191'Получение списка квартир подъезда (AccountGroupID)
curl --location 'http://HOST/system-api/GetAccountApartments' \
--data-urlencode 'AdminLogin=ADMIN_LOGIN' \
--data-urlencode 'AdminPassword=ADMIN_PASSWORD' \
--data-urlencode 'AccountGroupID=192'¶ Отключение квартиры
Отключить квартиру с номером (Apartment) в аккаунте квартиры (AccountID) для группы подъезда в домофонном аккаунте (AccountGroupID)
curl --location 'http://HOST/system-api/SetAccountApartment' \
--data-urlencode 'AdminLogin=ADMIN_LOGIN' \
--data-urlencode 'AdminPassword=ADMIN_PASSWORD' \
--data-urlencode 'AccountID=99' \
--data-urlencode 'AccountGroupID=192' \
--data-urlencode 'Apartment=14' \
--data-urlencode 'IsActive=0'¶ Доступ к дополнительным домофонам
Предоставить аккаунту квартиры (AccountID) доступ (просмотр камеры, открытие двери) к группам дополнительных подъездов домофонного аккаунта (GroupIDList=[ID группы подъезда 1, ID группы подъезда 2])
curl --location 'http://HOST/system-api/BindAccountToForeignAccountGroups' \
--data-urlencode 'AdminLogin=ADMIN_LOGIN' \
--data-urlencode 'AdminPassword=ADMIN_PASSWORD' \
--data-urlencode 'AccountID=99' \
--data-urlencode 'GroupIDList=[194,196]'