10  /  12

GetMessageStatus - запрос состояния сообщения

Описание

Команда возвращает статусы сообщения по идентификатору, полученному как результат команды отправки сообщения Message.

Направление

PMS -> TurnIP

Метод

POST

Запрос


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

{
    "messageID": 159 // Идентификатор сообщения
}

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

Параметр Тип Значение
messageID number Идентификатор сообщения, полученный как результат команды отправки сообщения Message.

Ответ

TurnIP возвращает код 200 OK и статусы сообщения в разрезе комнат в случае успешного выполнения операции либо код 404 Not Found: Message not found., если передан несуществующий идентификатор сообщения.

Ответ 200 ОК


HTTP/1.1 200 OK
Transfer-Encoding: chunked
Content-Type: application/json; charset=utf-8
[
    {
        "room": "101", // комната
        "status": 3 // статус
    },
    {
        "room": "108",
        "status": 3
    }
]

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

Параметр Тип Значение
room string Комната, по которой определяется статус (status).
status number Статус сообщения в комнате. См. таблицу ниже.

Статусы сообщений

Сататус (status) Значение
0 Удалено
1 Прочитано
2 Получено
3 Отправлено
4 Удаляется
5 Ждет отправки (запланировано)
6 Не доставлено
Нравится0
Описание курса