Узнайте, как настроить параметры устройства через HTTP API с помощью Postman, включая регистрацию SIP, ключи DSS, параметры сети, формат запроса XML и поддерживаемое извлечение параметров
Это руководство объясняет, как настроить параметры устройства через HTTP API, включая настройки SIP-сервера, данные регистрации SIP-учетной записи, параметры клавиши DSS и другие опции устройства. Устройство выступает в роли HTTP-сервера, а клиент отправляет определенные HTTP-запросы для применения изменений конфигурации, как показано на диаграмме ниже.
В этом примере Postman используется для имитации HTTP-запросов, отправляемых устройству.
Все доступные в настоящее время модели телефонов из нашей линейки продуктов.
① Одно переговорное устройство BHP-SOS11V, обновленное до последней версии прошивки и подключенное к PoE-коммутатору.
② Один ПК для настройки с установленным Postman, подключенный к тому же коммутатору, с подтвержденной нормальной сетевой связью.
Скачайте Postman с сайта:
https://www.postman.com/downloads/
Затем следуйте инструкциям по установке.
Нажмите File – New, затем выберите HTTP Request.
В окне нового запроса выберите метод POST и введите HTTP-URL устройства в следующем формате:
http://ip/xmlservice
Обратите внимание, что URL чувствителен к регистру. Замените ip на фактический IP-адрес устройства, как показано ниже.
Затем настройте требуемые параметры HTTP-запроса:
Метод аутентификации: Basic Auth
Заголовок: Content-Type: xml/text
Нажмите Body, выберите raw, затем введите XML-содержимое в тело сообщения. Пример формата показан ниже.
Структура следующая:
Это заголовок объявления XML, и он требуется в каждом запросе.
Это определяет структуру XML-команды. Атрибут cmd может быть get для получения текущих параметров или set для записи новых параметров.
Это указывает фактический элемент конфигурации. В этом примере запрос получает параметры, связанные с SIP-линией, от устройства.
При реальном использовании следующий раздел должен быть скорректирован в соответствии с фактическим параметром, который вы хотите запросить или настроить:
Разные модели могут поддерживать разные параметры HTTP API. Вы можете использовать любой из следующих методов, чтобы получить список поддерживаемых параметров для конкретного устройства.
Метод 1: В интерфейсе WEB устройства перейдите в System – System Configuration, затем экспортируйте файл конфигурации типа nc.
Вы можете щелкнуть правой кнопкой мыши, чтобы сохранить файл, или левой кнопкой, чтобы просмотреть конфигурацию напрямую. Общие параметры перечислены в следующем разделе.
Метод 2: Некоторые модели не предоставляют ссылку на файл конфигурации nc непосредственно в веб-интерфейсе. В этом случае вы можете ввести соответствующий URL в адресной строке браузера, чтобы вручную получить файл конфигурации nc.
Примечание: Этот метод может требовать больше времени для ответа.
В этом разделе перечислены несколько общих параметров для справки. В будущих обновлениях могут быть добавлены дополнительные параметры.
Пример параметров SIP-линии (от устройства контроля доступа i30):
sip.line.1.PhoneNumber = 112
sip.line.1.DisplayName = 112
sip.line.1.SipName =
sip.line.1.RegAddr = 172.18.1.45
sip.line.1.RegPort = 2066
sip.line.1.RegUser = 112
sip.line.1.RegPswd = abc123
sip.line.1.RegTTL = 3600
sip.line.1.RegEnabled = 0
sip.line.1. указывает, что эти параметры принадлежат SIP-линии 1.
PhoneNumber соответствует полю номера телефона в веб-интерфейсе.
DisplayName соответствует отображаемому имени.
RegAddr — это адрес SIP-прокси-сервера.
RegPort — это порт SIP-прокси-сервера.
RegUser — это имя пользователя для аутентификации, обычно совпадающее с номером телефона.
RegPswd — это пароль.
RegTTL — это время жизни регистрации, значение по умолчанию — 3600 секунд.
RegEnabled определяет, включена ли линия: 0 означает отключена, 1 — включена.
Пример параметров клавиши DSS для i30:
Рекомендуется сначала настроить клавишу DSS в веб-интерфейсе, затем использовать HTTP API с командой get, чтобы считать соответствующие значения параметров и подтвердить точное соответствие.
Type=1 указывает, что тип клавиши DSS — Hotkey для таких устройств, как i30 или i12. Для других моделей проверьте фактическое значение типа, используя рекомендованный выше метод.
Value=125@1/f означает:
125 = целевой номер
@1 = линия 1
/f = подтип: быстрый набор
Пример сетевых параметров для таких устройств, как i30 и i12:
WANMode указывает режим сети, который может быть DHCP или static. Этот параметр нельзя записать напрямую с помощью команды set. Он изменяется автоматически в соответствии со значением dhcp.Enabled.
static.IP — это статический IP-адрес. Он действует только когда устройство находится в статическом режиме. В режиме DHCP команда get все еще может использоваться для получения текущего IP-адреса.
static.SubnetMask — это маска подсети.
static.Gateway — это шлюз по умолчанию.
static.PrimaryDNS — это основной DNS-сервер.
static.SecondaryDNS — это вторичный DNS-сервер.
dhcp.Enabled определяет, включен ли DHCP: 1 означает, что режим DHCP активен, а 0 означает, что используется режим статического IP.
Пример параметров громкости для BHP-SOS11V:
phone.volume.HandFreeVol — это громкость громкой связи. Диапазон: 1-9, где 9 — максимальная громкость.
phone.volume.HandFreeRingVol — это громкость рингтона для входящих вызовов. Диапазон: 1-9, где 9 — максимальная громкость.
phone.volume.HandFreeToneVol — это громкость сигналов оповещения, таких как предупреждения и уведомления. Диапазон: 1-9, где 9 — максимальная громкость.
Параметры системной информации доступны только для чтения, что означает, что их можно только запрашивать с помощью команды get.
Пример:
Этот параметр возвращает всю системную информацию. Если вам нужен только конкретный элемент, расширьте путь параметра до следующего уровня узла.
Например, чтобы получить MAC-адрес устройства:
