Работа с сообщениями

Отправка сообщения

Общее описание

Функция POST /v6/api/messageManagement/messages позволяет отправить сообщение Сотруднику.

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

Функция имеет следующие параметры:

Параметр	Описание
subscriberID	ИД Сотрудника
text	Текст сообщения

Результат выполнения

При успешном выполнении возвращается статус 201.

Функция возвращает структуру с параметрами отправленного сообщения:

Параметр	Описание
mtMessageID	ИД сообщения

Формат запроса

POST /v6/api/messageManagement/messages HTTP/1.1
Host: host
Authorization: Bearer token

\{
    "subscriberID": integer,
    "text": "string"
}

Пример запроса

POST /v6/api/messageManagement/messages HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

\{
    "subscriberID": 1,
    "text": "Добрый день, на вас назначена срочная задача по доставке 123."
}

Формат ответа

\{
    "mtMessageID": integer
}

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

\{
    "mtMessageID": 1
}

Получение списка сообщений от Пользователей к Сотрудникам

Общее описание

Функция GET /v6/api/messageManagement/messages/mt?dateFrom={dateTime}&dateTo={dateTime}&subscriberIDs={long}&count={integer}&offset={integer}&lastMtMessageID={integer} позволяет получить список сообщений, отправленных Пользователями Сотрудникам.

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

Функция имеет следующие параметры:

Параметр	Описание
dateFrom	Дата, время начала периода сообщений (подробнее о формате времени).
dateTo	Дата, время окончания периода сообщений (подробнее о формате времени).
subscriberIDs	ИД Сотрудников. Подробнее о передаче нескольких идентификаторов
count	Количество возвращаемых сообщений (не более 1000).
offset	Количество сообщений, которые необходимо пропустить относительно первой в списке.
lastMtMessageID	ИД последнего отправленного сообщения, которым должны заканчиваться нужные данные (функция вернет сообщения с идентификаторами, которые строго меньше указанного).

Результат выполнения

Функция возвращает структуру с параметрами отправленного сообщения:

Параметр	Описание
subscriberID	ИД Сотрудника
mtMessageID	ИД сообщения
text	Текст сообщения
creationDate	Дата и время создания сообщения (подробнее о формате времени).
deliveryDate	Дата и время доставки сообщения (подробнее о формате времени).
readDate	Дата и время прочтения сообщения (подробнее о формате времени).

Формат запроса

GET /v6/api/messageManagement/messages/mt?dateFrom=\{dateTime}&dateTo=\{dateTime}&subscriberIDs=\{long}&count=\{integer}&offset=\{integer}&lastMtMessageID=\{integer}  HTTP/1.1
Host: host
Authorization: Bearer token

Пример запроса

GET /v6/api/messageManagement/messages/mt?dateFrom=2021-12-11T16:49:46.61+03:00&dateTo=2022-02-11T16:49:46.61+03:00&subscriberIDs=1&count=2&offset=1&lastMtMessageID=3  HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

Формат ответа

[
    \{
        "subscriberID": integer,
        "mtMessageID": integer,
        "text": "string",
        "creationDate": "dateTime",
        "deliveryDate": "dateTime",
        "readDate": "dateTime"
    },
    \{
        "subscriberID": integer,
        "mtMessageID": integer,
        "text": "string",
        "creationDate": "dateTime",
        "deliveryDate": "dateTime",
        "readDate": "dateTime"
    }
]

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

[
    \{
        "subscriberID": 1,
        "mtMessageID": 1,
        "text": "Добрый день, на вас назначена срочная задача по доставке 123.",
        "creationDate": "2022-02-11T16:49:46.61+03:00",
        "deliveryDate": "2022-02-11T16:50:46.61+03:00",
        "readDate": "2022-02-11T16:50:46.61+03:00"
    },
    \{
        "subscriberID": 1,
        "mtMessageID": 2,
        "text": "Добрый день, на вас назначена срочная задача по доставке 456",
        "creationDate": "2022-02-11T16:49:49.61+03:00",
        "deliveryDate": "2022-02-11T16:50:46.61+03:00",
        "readDate": "2022-02-11T16:50:46.61+03:00"
    }
]

Получение сообщения от Пользователя к Сотруднику

Общее описание

Функция GET /v6/api/messageManagement/messages/mt/{mtMessageID} позволяет получить список сообщений, отправленного Пользователем Сотруднику.

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

В запросе используется обязательный параметр mtMessageID — ИД сообщения, отправленного Пользователем Сотруднику.

Результат выполнения

Функция возвращает структуру с параметрами отправленного сообщения:

Параметр	Описание
subscriberID	ИД Сотрудника
mtMessageID	ИД сообщения
text	Текст сообщения
creationDate	Дата и время создания сообщения (подробнее о формате времени).
deliveryDate	Дата и время доставки сообщения (подробнее о формате времени).
readDate	Дата и время прочтения сообщения (подробнее о формате времени).

Формат запроса

GET /v6/api/messageManagement/messages/mt/\{messageID} HTTP/1.1
Host: host
Authorization: Bearer token

Пример запроса

GET /v6/api/messageManagement/messages/mt/1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

Формат ответа

\{
    "subscriberID": integer,
    "mtMessageID": integer,
    "text": "string",
    "creationDate": "dateTime",
    "deliveryDate": "dateTime",
    "readDate": "dateTime"
}

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

\{
    "subscriberID": 1,
    "mtMessageID": 1,
    "text": "Добрый день, на вас назначена срочная задача по доставке 123.",
    "creationDate": "2022-02-11T16:49:46.61+03:00",
    "deliveryDate": "2022-02-11T16:50:46.61+03:00",
    "readDate": "2022-02-11T16:50:56.61+03:00"
}

Получение списка сообщений от Сотрудников к Пользователям

Общее описание

Функция GET /v6/api/messageManagement/messages/mo?dateFrom={dateTime}&dateTo={dateTime}&subscriberIDs={long}&count={integer}&offset={integer}&lastMtMessageID={integer} позволяет получить список сообщений, отправленных Сотрудниками Пользователям.

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

Функция имеет следующие параметры:

Параметр	Описание
dateFrom	Дата, время начала периода сообщений (подробнее о формате времени).
dateTo	Дата, время окончания периода сообщений (подробнее о формате времени).
subscriberIDs	ИД Сотрудников. Подробнее о передаче нескольких идентификаторов
count	Количество возвращаемых сообщений (не более 1000).
offset	Количество сообщений, которые необходимо пропустить относительно первой в списке.
lastMoMessageID	ИД последнего отправленного сообщения, которым должны заканчиваться нужные данные (функция вернет сообщения с идентификаторами, которые строго меньше указанного).

Результат выполнения

Функция возвращает структуру с параметрами отправленного сообщения:

Параметр	Описание
subscriberID	ИД Сотрудника
moMessageID	ИД сообщения
text	Текст сообщения
creationDate	Дата и время создания сообщения (подробнее о формате времени).

Формат запроса

GET /v6/api/messageManagement/messages/mo?dateFrom=\{dateTime}&dateTo=\{dateTime}&subscriberIDs=\{long}&count=\{integer}&offset=\{integer}&lastMtMessageID=\{integer}  HTTP/1.1
Host: host
Authorization: Bearer token

Пример запроса

GET /v6/api/messageManagement/messages/mo?dateFrom=2021-12-11T16:49:46.61+03:00&dateTo= 2022-02-11T16:49:46.61+03:00&subscriberIDs=1&count=2&offset=1&lastMtMessageID=3  HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

Формат ответа

[
    \{
        "subscriberID": integer,
        "moMessageID": integer,
        "text": "string",
        "creationDate": "dateTime"

    },
    \{
        "subscriberID": integer,
        "moMessageID": integer,
        "text": "string",
        "creationDate": "dateTime"
    }
]

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

[
    \{
        "subscriberID": 1,
        "moMessageID": 1,
        "text": "Добрый день, принято",
        "creationDate": "2022-02-11T16:49:46.61+03:00"

    },
    \{
        "subscriberID": 1,
        "moMessageID": 2,
        "text": "Добрый день, сделано",
        "creationDate": "2022-02-11T16:49:49.61+03:00"
    }
]

Получение сообщения от Сотрудника к Пользователю

Общее описание

Функция GET /v6/api/messageManagement/messages/mo/{moMessageID} позволяет получить сообщения, отправленного Сотрудником Пользователю.

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

В запросе используется обязательный параметр moMessageID — ИД сообщения, отправленного Сотрудником.

Результат выполнения

Функция возвращает структуру с параметрами отправленного сообщения:

Параметр	Описание
subscriberID	ИД Сотрудника
moMessageID	ИД сообщения
text	Текст сообщения
creationDate	Дата и время создания сообщения (подробнее о формате времени).

Формат запроса

GET /v6/api/messageManagement/messages/mo/\{messageID} HTTP/1.1
Host: host
Authorization: Bearer token

Пример запроса

GET /v6/api/messageManagement/messages/mo/1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

Формат ответа

\{
    "subscriberID": integer,
    "moMessageID": integer,
    "text": "string",
    "creationDate": "dateTime"
}

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

\{
    "subscriberID": 1,
    "moMessageID": 1,
    "text": "Добрый день, принято",
    "creationDate": "2022-02-11T16:49:46.61+03:00"
}

Работа с сообщениями

Отправка сообщения

Получение списка сообщений от Пользователей к Сотрудникам

Получение сообщения от Пользователя к Сотруднику

Получение списка сообщений от Сотрудников к Пользователям

Получение сообщения от Сотрудника к Пользователю

Содержание