update_operating
Для запуска или остановки ретранслятора, а также для ретрансляции сообщений за прошедший период используйте метод retranslator/update_operating.
Конечная точка
svc=retranslator/update_operating¶ms={
"itemId": <long>,
"operate": <bool>,
"callMode": <text>,
"stopTime": <uint>,
"timeFrom": <uint>,
"timeTo": <uint>
}
Параметры
Запрос может содержать следующие параметры. Обязательные параметры отмечены звездочкой (*).
| Параметр | Описание |
|---|---|
itemId* |
ID ретранслятора. |
operate* |
Запуск или остановка ретрансляции: true — запуск, false — остановка. Также принимаются значения 1 и 0. |
callMode |
Режим запроса:
switch. Любое другое значение приводит к ошибке 4. |
stopTime |
Время (Unix-время), когда ретранслятор останавливается автоматически. Используется, только если callMode имеет значение switch, а operate — true. Если параметр не указан, ретранслятор не останавливается автоматически. |
timeFrom |
Начало периода, за который ретранслируются сообщения (Unix-время). Обязателен, если callMode имеет значение history, а operate — true. |
timeTo |
Окончание периода, за который ретранслируются сообщения (Unix-время). Обязателен, если callMode имеет значение history, а operate — true. |
Ответ
В случае успешного выполнения запроса возвращается ответ следующего формата:
{
"rtro":<int>, /* Состояние ретранслятора: 0 — остановлен, 1 — запущен. */
"rtrst":<uint> /* Время (Unix-время), когда ретранслятор останавливается автоматически. 0, если время не задано. */
}
В противном случае возвращается код ошибки.
Коды ошибок
| Код ошибки | Описание |
|---|---|
| 4 | Не удалось разобрать входные параметры, значение callMode не поддерживается или не удалось запустить либо остановить ретранслятор. |
| 7 | Указанный элемент не является ретранслятором или у пользователя нет права доступа на редактирование настроек ретранслятора, включая его запуск и остановку (бит ACL 0x100000, см. Токены). |