метод REST scope: messageservice

messageservice.message.status.update

Обновить статус доставки сообщения

Кто может выполнять: отправитель сообщения или администратор

Описание

Метод messageservice.message.status.update обновляет статус доставки сообщения, отправленного через провайдер сообщений.

Метод работает только в контексте приложения.

Параметры

CODE string обязательный

Код провайдера.

Код провайдера можно получить методом messageservice.sender.list

MESSAGE_ID string обязательный

Внешний идентификатор сообщения, полученный обработчиком приложения при отправке сообщения

STATUS string обязательный

Новый статус сообщения.

Поддерживаемые значения:
- queued — сообщение поставлено в очередь на отправку
- sent — сообщение отправлено провайдером
- delivered — сообщение успешно доставлено получателю
- undelivered — сообщение не доставлено получателю
- failed — ошибка отправки или обработки сообщения у провайдера

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"CODE":"provider1","MESSAGE_ID":"65575980fa531ac284c2ee68f81ebebd","STATUS":"delivered","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/messageservice.message.status.update

Ответ

HTTP-статус: 200

{
    "result": true,
    "time": {
        "start": 1742895600,
        "finish": 1742895600.845505,
        "duration": 0.845505952835083,
        "processing": 0,
        "date_start": "2025-03-25T10:00:00+03:00",
        "date_finish": "2025-03-25T10:00:00+03:00",
        "operating_reset_at": 1742896200,
        "operating": 0
    }
}

Возвращаемые данные

result boolean

true, если статус сообщения успешно обновлен

time time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
    "error": "ERROR_MESSAGE_STATUS_INCORRECT",
    "error_description": "Message status incorrect!"
}
Код Описание Значение
ERROR_SENDER_VALIDATION_FAILURE Empty sender code! Не передан обязательный параметр CODE
ERROR_SENDER_VALIDATION_FAILURE Wrong sender code! CODE содержит недопустимые символы
ERROR_MESSAGE_NOT_FOUND Message not found! Сообщение с указанным MESSAGE_ID не найдено
ERROR_MESSAGE_STATUS_INCORRECT Message status incorrect! Передан неподдерживаемый STATUS
ACCESS_DENIED Application context required Метод вызван вне контекста приложения
ACCESS_DENIED Access denied! Метод запустил не администратор

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.