9  /  12

Message - отправка сообщения на телевизор в гостинице

Описание

Команда производит отправку сообщения на комнаты, которым подключены ТВ-дисплеи.

Направление

PMS -> TurnIP

Метод

POST

Запрос


POST /api/Message HTTP/1.1
Content-Type: application/json
API-KEY: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
Accept-Encoding: gzip, deflate, br
Connection: keep-alive
Content-Length: 213

{
  "from": "Админстрация", // отправитель, необязательный
  "subject": "тема", // тема сообщения, необязательный
  "body": "сообщение 11", // тело сообщения, обязательный, если не задано поле "subject"
  "deliveryType": 0, //0 - доставить немедленно, 1 - доставить в sendOn, по умолчанию 0, необязательно
  "sendOn": "29/01/2024 15:35", //дата отправки, обязательно при установке deliveryType = 1
  "storeUntil": "02/02/2024 12:58", //дата хранения сообщения у гостя, необязательный
  "recipient": ["101", "108" ], //- список комнат, обязательный
  "popUp": false // показывать всплывающим сообщением, необязательный
}

Параметры запроса

Параметр Тип Значение
from string Отправитель сообщения, отображаемый гостю. Необязательный параметр. Если не задан заполняется именем отеля из настроек гостиницы. Максимально 200 символов.
subject string Тема сообщения, отображаемая гостю. Необязательный параметр. Если не указан заполняется значением "Новое сообщение". Максимально 200 символов.
body string Тело сообщения. Максимально 2000 символов. Обязательный параметр, если не задано поле "subject". Если передано поле темы, может быть пропущено.
Тело сообщения поддерживает HTML теги.
deliveryType int 0 - доставить немедленно, 1 - запланировать доставку в дату, заданную в параметре "sendOn", Значение по умолчанию 0. Необязательный параметр.
sendOn string Дата отправки сообщения. Применимо, если отправка запланирована (deliveryType = 1). Обязательный параметр при установке deliveryType = 1.
Формат "DD/MM/YYYY HH:MM".
storeUntil string Дата хранения сообщения в комнате. Выезд и заезд гостя имеет приоритет над данным параметром. При заезде и выезде гостя сообщения удаляются. Необязательный параметр. Если параметр не задан, устанавливается как расчетное время выезда из настроек гостиницы.
Формат "DD/MM/YYYY HH:MM".
recipient Array Массив строк - список комнат, в которые будет отправлено сообщение. Обязательный параметр.
popUp boolean Показывать всплывающим сообщением, в том числе во время просмотра ТВ-канала, если true, или доставить в список сообщений, если false. Необязательный параметр. Значение по умолчанию определяется настройкой в конкретной гостинице.

Ограничения

  • Обязательно к передаче поле subject или поле body. В противном приведет к ошибке 400 Bad Request: {"number":10,"message":"Subject field or message field is empty."}. Хотя бы одно из двух этих полей должно быть передано обязательно, чтобы не было пустых сообщений.
  • Если отправка сообщения запланирована (задан параметр deliveryType = 1), обязательно к заполнению поле sendOn - дата отправки сообщения.
  • Поля отправитель (from) и тема (subject) не могут быть больше 200 символов включая пробелы.
  • Поле тело сообщения (body) не может быть больше 2000 символов включая пробелы.

Ответ

TurnIP возвращает код 200 OK с идентификатором отправленного сообщения в случае успешного выполнения операции либо код 400 Bad Request с описанием ошибки.

Ответ 200 ОК


HTTP/1.1 200 OK
Transfer-Encoding: chunked
Content-Type: application/json; charset=utf-8
{
    "messageID": 159 // Идентификатор сообщения
}

Параметры ответа

Параметр Тип Значение
messageID number Идентификатор отправленного сообщения.

Ответ 400 Bad Request



HTTP/1.1 400 Bad Request
Transfer-Encoding: chunked
Content-Type: application/json; charset=utf-8
{
    "number": 10, // Номер ошибки
    "message": "Subject field or message field is empty." //Содержание ошибки
}

Коды ошибок

Number Message Описание
50 Subject field or message field is empty Не заполнено хотя бы одно из полей subject или body.
51 If the value of deliveryType = 1, the value of the "sendOn" field must be filled in Выполняется запланированная отправка сообщения (передан параметрdeliveryType = 1), но при этом не указана дата отправки сообщения в поле sendOn.
52 The "recipient" field is required Не задано поле получателей сообщения recipient.
53 There are no rooms with linked TVs В поле recipient переданы комнаты, в которых нет подключенных телевизоров.
54 The message body exceeds 2000 characters Поле тела сообщения body содержит более 2000 символов.
55 The "from" field exceeds 200 characters Поле От сообщения from содержит более 200 символов.
56 The "subject" field exceeds 200 characters Поле Тема сообщения subject содержит более 200 символов.
57 Invalid field format sendOn Неверный формат даты в поле sendOn.
58 Invalid field format storeUntil Неверный формат даты в поле storeUntil.
Нравится0
Описание курса