|
Параметры запроса
Параметр
|
Описание
|
Обязательный
|
id
|
Идентификатор станции
|
да
|
link-text
|
Макрос {link} будет заменен на строку, указанную в данном параметре
|
нет
|
link-url
|
Ссылка на страницу, которая будет открываться при клике на {link}
|
нет
|
logo
|
Логотип в формате BMP (24-битные изображения в кодировке base64)
|
нет
|
logo-text
|
Текст, размещаемый справа от логотипа, например, название компании
|
нет
|
logo-url
|
Ссылка на страницу, которая будет открываться при клике на логотип
|
нет
|
message
|
Текст сообщения, отправляемого станции.
Текст сообщения может содержать макрос {link}.
|
да
|
Пример запроса
http://192.168.1.1:9080/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.0" timestamp="1558521952" server="192.168.1.1" srv_version="12.00.0.201909260" 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": 1552276920,
"api": {
"version": 40300,
"versionString": 4.3.0},
"server": {
"name": "192.168.1.1",
"version": "12.00.0.201909260",
"uuid": "a509dab1-d423-4059-971a-aa3944a2c48a"}},
"data": {
"total": 2,
"list": {
"1000": "initiated",
"1001": "delayed"}}}
|
Описание параметров ответного JSON
Блок data содержит информацию обо всех станциях, на которые отправлялось сообщение.
Элементы блока data:
Название поля
|
Описание
|
total
|
Общее количество станций, на которые отправлялось сообщение
|
•Массив list содержит информацию о конкретных станциях, на которые отправлялось сообщение. Элементы объектов в массиве list:
Название поля
|
Описание
|
Идентификатор станции, на которую отправлялось сообщение
|
Статус процесса отправки сообщения. Может принимать значения:
•delayed — отправка отложена, •failed — отправка завершилось с ошибкой, •initiated — отправка инициирована. |
|