|
Параметры запроса
Параметр
|
Описание
|
Обязательный
|
id
|
Идентификатор станции.
Параметр может быть указан в запросе неограниченное количество раз для отправки сообщения на несколько станций одновременно.
|
да
|
link-text
|
Макрос {link} будет заменен на строку, указанную в данном параметре
|
нет
|
link-url
|
Ссылка на страницу, которая будет открываться при запуске макроса {link}
|
нет
|
logo
|
Логотип в формате BMP (24-битные изображения в кодировке base64)
|
нет
|
logo-text
|
Текст, размещаемый справа от логотипа, например, название компании
|
нет
|
logo-url
|
Ссылка на страницу, которая будет открываться при нажатии на логотип
|
нет
|
message
|
Текст сообщения, отправляемого станции.
Текст сообщения может содержать макрос {link}.
|
да
|
Пример запроса
https://192.168.1.1:9081/api/stations/send-message.ds?id=1000&id=1001&message=message&logo-text=logo-text&logo-url=www.drweb.com&link-text=drweb&link-url=drweb.com&logo={base64}
|
Ниже представлены примеры ответов в формате XML и в формате JSON.
Ответ в формате XML
<drweb-es-api api_version="4.3.2" timestamp="1582030327" server="192.168.1.1" srv_version="13.00.0.202005090" status="true">
<stations total="2">
<station id="1000" status="initiated"/>
<station id="1001" status="delayed"/>
</stations>
</drweb-es-api>
|
Описание параметров ответного XML
Элемент <stations /> содержит информацию об отправке сообщения на станции, указанные в запросе.
Атрибут элемента <stations />:
Атрибут
|
Описание
|
total
|
Общее количество станций в ответе
|
•Элемент <station /> содержит информацию об отправке сообщения на конкретную станцию.
Атрибуты элемента <station />:
Атрибут
|
Описание
|
id
|
Идентификатор станции
|
status
|
Статус отправки сообщения:
•delayed — отправка отложена,
•failed — отправка завершилось с ошибкой,
•initiated — отправка инициирована. |
Ответ в формате JSON
{ "head": {
"status": true,
"timestamp": 1582030584,
"api": {
"version": 40302,
"versionString": "4.3.2"},
"server": {
"name": "192.168.1.1",
"version": "13.00.0.202005090",
"uuid": "eae1a652-96d5-48fd-9169-4788a03688b8"}},
"data": {
"total": 2,
"list": {
"1000": "initiated",
"1001": "delayed"}}}
|
Описание параметров ответного JSON
Блок data содержит информацию об отправке сообщения на станции, указанные в запросе.
Элементы блока data:
Название поля
|
Описание
|
total
|
Общее количество станций в ответе
|
list
|
Блок с результатами отправки сообщения для каждой станции
|
•Элементы блока list:
Название поля
|
Описание
|
Идентификатор станции
|
Статус отправки сообщения:
•delayed — отправка отложена,
•failed — отправка завершилось с ошибкой,
•initiated — отправка инициирована. |
|