Настройка XML API для rps сервера
Содержание
- 1 Функции
- 2 Команды XML-RPC
- 3 2.redirect.registerDevice
- 4 3.redirect.deRegisterDevice
- 5 4. redirect.listDevices
- 6 5. redirect.checkDevice
- 7 6.redirect.registerDevices
- 8 7. redirect.registerDevices[2]
- 9 8.redirect.deRegisterDevices
- 10 9. redirect.addServer
- 11 10.redirect.editDevice
- 12 11.redirect.editDevice[2]
Функции
1.Redirect Provisioning Server Redirect Provisioning Server – Сервер Перенаправления На Сервер Автоконфигурирования (RPS) это промежуточное устройство, которое обеспечивает функцию перенаправления между IP телефоном Akuvox и сервером авто конфигурирования. Телефон пользователя может получить URL для авто конфигурирования от Akuvox RPS, затем скачивать файл common.cfg или MAC.cfg с сервера автоконфигурирования.
2.RPS API протокол API RPS построен как стандартные XML-RPC сервисы, пользователь может отправлять XML-команды через HTTP POST, используя content-Type: text / xml для изменения данных RPS. Аутентификация пользователя осуществляется с помощью обычной аутентификации с использованием имени пользователя и пароля.
3. URL для службы
http://58.96.188.87/fcgi/do?id=1
4. Пользовательские аккаунты Для доступа к RPS у пользователя должна быть действительная учетная запись для функционирования команд API, учетная запись предоставляется оператором Akuvox. Если у вас есть какие-либо вопросы, пожалуйста, напишите нам techsupport@akuvox.com
Команды XML-RPC
1.redirect.registerDevice
Регистрация устройства в RPS по MAC ID.
1.Подпись 1XML-RPC redirect.registerDevice(mac,serverName)
1.2 Параметр 1. mac : MAC адрес, который нужно зарегистрировать в RPS. 2. serverName: Название сервера RPS, в котором будет регистрироваться устройство.
1.3 Возвращаемые значения
Результат | Описание |
---|---|
OK: 1 | MAC адрес успешно зарегистрирован на сервере |
Errors: 0 (Неверный MAC) | Неправильный формат |
Errors: 0 (MAC уже существует) | Уже зарегистрирован вами |
Errors: 0 (MAC уже существует) | Неправильное имя сервера |
Errors: 0 (Перезаписать MAC?) | Уже зарегистрирован другим пользователем |
1.4 Пример
Request
Примечание 1. Строку ”<![CDATA[ ]]>” можно убрать. 2. Четыре допустимых формата MAC адреса 0C1105002189, 0C 11 05 00 21 89, 0C-11-05-00-21-89, 0C:11:05:00:21:89.
Успешный ответ
Отрицательный ответ
2.redirect.registerDevice
Если устройство, которое вы хотите зарегистрировать, уже добавлено, вы можете перезаписать информацию о нём с помощью параметра “isOverride”.
2.Команда 1XML-RPC redirect.registerDevice(mac,serverName,isOverride)
2.2 Параметр 1. mac: MAC адрес устройства для регистрации в RPS. 2. serverName: Название сервера на RPS, на котором будет регистрироваться устройство. 3. isOverride:Подтверждение, нужно ли перезаписать существующий MAC. (1) 1:Подтвердить (2) 0:Отмена
2.3 Возвращаемые значения
Результат | Описание |
---|---|
OK: 1 | MAC адрес успешно зарегистрирован на сервере |
Errors: 0 (Неверный MAC) | Неправильный формат |
Errors: 0 (MAC уже существует) | Уже зарегистрирован вами |
Errors: 0 (Неверный сервер) | Неправильное имя сервера |
Errors: 0 (Перезапись: 1 – да, 0 - нет) | Уже зарегистрирован другим пользователем |
Errors: 0 (Errors: 0) | Не получилось перезаписать предыдущий MAC - адрес |
2.4 Пример Запрос
Положительный ответ
Отрицательный ответ
3.redirect.deRegisterDevice
Можете удалить устройство из RPS через его MAC id. 3.1 Команда XML-RPC redirect.deRegisterDevice(mac) 3.2 Параметр mac: MAC адрес устройство RPS 3.3 Возвращаемые значения
Результат | Описание |
---|---|
OK | MAC адрес успешно зарегистрирован |
Error (Неверный MAC) | Неверный формат MAC адреса или он уже зарегистрирован другим пользователем |
3.4 Пример Запрос
Позитивный ответ
Отрицательный ответ
4. redirect.listDevices
Выводит список всех устройств(MACs), которые вы уже зарегистрировали. 4.1 Команда XML-RPC redirect.listDevices() 4.2 Возвращаемые значения
Результат | Описание |
---|---|
ОК | <array>
<value>MAC1</value> <value>MAC2</value> … </array> |
Error (Не найдено) | Зарегистрированные устройства не обнаружены |
4.3 Пример Запрос
Положительный ответ
Негативный ответ
5. redirect.checkDevice
Вы можете проверить (MACs), зарегистрировано ли устройство в RPS. 5.1 Команда XML-RPC redirect.checkDevice(mac) 5.2 Параметр mac: MAC адрес для проверки. 5.3 Возвращаемые значения
Результат | Описание | |
---|---|---|
Error | Неверный MAC | Неверный формат MAC |
OK | Не зарегистрирован | Нет привязки к какому-то серверу |
OK | Зарегистрирован | MAC привязан к серверу |
OK | Уже зарегистрирован | MAC зарегистрирован другим RPS пользователем |
OK | Неизвестный | MAC отсутствует в RPS |
5.4 Пример Запрос
Положительный ответ
Негативный ответ
6.redirect.registerDevices
Пользователь может зарегистрировать устройства по списку из MAC ID.
6.1 Команда XML-RPC
redirect.registerDevices(macList,serverName)
6.2 Parameter
1. mac : MAC адрес устройства для регистрации на RPS. 2. serverName: название сервера, добавленного на RPS, на котором будет регистрироваться устройство
6.3 Возвращаемые устройства
Результат | Описание | |
---|---|---|
OK: 1 | MAC адрес успешно зарегистрирован на сервере | |
Errors: 0 | Неверный MAC | Неправильный формат |
Errors: 0 | MAC уже существует | Уже зарегистрирован вами |
Errors: 0 | Неверный сервер | Неправильное имя сервера |
Errors: 0 | Перезаписать MAC? | Уже зарегистрирован другим пользователем |
6.4 Пример Запрос
Позитивный ответ
Отрицательный ответ
7. redirect.registerDevices[2]
Если MAC адреса из списка уже зарегистрированы ранее, вы можете перезаписать их через параметр isOverride.
7.1 Команда XML-RPC
redirect.registerDevices(macList,serverName,isOverride)
7.2 Parameter 1. macList: MAC адреса для регистрации на RPS. 2. serverName: Название сервера, уже добавленного на RPS, на который будет регистрироваться устройство. 3. isOverride:Подтвердить перезапись зарегистрированного устройства. (1) 1:подтвердить (2) 0:отмена перезаписи
7.3 Возвращаемые значения
Результат | Результат | |
---|---|---|
OK: 1 | MAC адрес успешно зарегистрирован на сервере | |
Errors: 0 | Неверный MAC | Неправильный формат |
Errors: 0 | MAC уже существует | Уже зарегистрирован вами |
Errors: 0 | Неверный сервер | Неправильное имя сервера |
Errors: 0 | Перезапись: 1 – да, 0 - нет | Уже зарегистрирован другим пользователем |
Errors: 0 | Ошибка перезаписи | Не получилось перезаписать предыдущий MAC - адрес |
7.4 Пример Запрос
Положительный ответ
Отрицательный ответ
8.redirect.deRegisterDevices
Вы можете удалить список устройств из RPS с помощью списка MAC адресов. 8.1 Команда XML-RPC redirect.deRegisterDevices(macList) 8.2 Параметр macList: MAC адреса, которые нужно удалить из RPS 8.3 Возвращаемые значения
Результат | Описание | |
---|---|---|
OK | MAC – адрес успешно зарегистрирован | |
Error | Неверный MAC адрес | Неверный формат MAC адреса или устройство уже зарегистрировано другим пользователем |
8.4 Пример Запрос
Положительный ответ
Отрицательный ответ
9. redirect.addServer
Вы можете прописать специальную конфигурацию для сервера на RPS. 9.1 Команда XML-RPC redirect.addServer(serverName,serverUrl) 9.2 Параметр 1. serverName: Название сервера на RPS, на который устройство будет перенаправлено 2. serverUrl: Специальный URL для конфигурирования. 9.3 Возвращаемые значения
Результат | Описание | |
---|---|---|
OK | Сервер добавлен успешно | |
Errors | Может начинаться только с http:// или https:// или ftp:// или tftp:// | Неверный формат URL |
Errors | Может начинаться только с http:// или https:// или ftp:// или tftp:// | Название сервера не может быть пустой строкой |
Errors | URL не может быть пустым | URL сервера не может быть пустой строкой |
Errors | Название занято | Такое название уже используется |
Errors | Название может содержать только A-z 0-9, _ . и пробел | Неверный формат названия сервера |
9.4 Пример Запрос
Положительный ответ
Отрицательный ответ
10.redirect.editDevice
Вы можете изменить сервер, на котором будут регистрироваться устройства 10.1 Команда XML-RPC redirect.editDevice(mac,serverName) 10.2 Параметр 1. mac : MAC адрес, который будет изменен. 2. serverName: Название сервера, на котором будет происходить регистрация устройства 10.3 Возвращаемые значения
Результат | Описание | |
---|---|---|
OK: 1 | MAC адрес успешно зарегистрирован на сервере | |
Errors: 0 | Неверный MAC | Неправильный формат |
Errors: 0 | MAC уже существует | Уже зарегистрирован вами |
Errors: 0 | Неверный сервер | Неправильное имя сервера |
Errors: 0 | Перезаписать MAC? | Уже зарегистрирован другим пользователем |
10.4 Пример Запрос
Положительный ответ
Отрицательный ответ
11.redirect.editDevice[2]
Если MAC адрес устройства, который вы пытаетесь зарегистрировать, уже существует на сервере, вы можете перезаписать его, используя параметр isOverride. 11.1 Команда XML-RPC redirect.editDevice(mac,serverName,isOverride) 11.2 Параметр 1. mac : MAC адрес устройства. 2. serverName: Название сервера, на котором хотите перезаписать MAC. 3. isOverride: подтверждение процесса перезаписывания . (1) 1:Подтверждение (2) 0:Отмена
11.3 Возвращаемые значения
Результат | Описание | |
---|---|---|
OK: 1 | MAC адрес успешно зарегистрирован на сервере | |
Errors: 0 | Неверный MAC | Неправильный формат |
Errors: 0 | MAC уже существует | Уже зарегистрирован вами |
Errors: 0 | Неверный сервер | Неправильное имя сервера |
Errors: 0 | Перезапись: 1 – да, 0 - нет | Уже зарегистрирован другим пользователем |
Errors: 0 | Ошибка перезаписи | Не получилось перезаписать предыдущий MAC - адрес |
11.4 Пример Запрос
Положительный ответ
Отрицательный ответ