Обновить статус доставки сообщения messageservice.message.status.update

Scope: messageservice

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

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

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

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

Обязательные параметры отмечены *

Название `тип`	Описание
CODE* `string`	Код провайдера. Код провайдера можно получить методом messageservice.sender.list
MESSAGE_ID* `string`	Внешний идентификатор сообщения, полученный обработчиком приложения при отправке сообщения
STATUS* `string`	Новый статус сообщения. Поддерживаемые значения: `queued` — сообщение поставлено в очередь на отправку `sent` — сообщение отправлено провайдером `delivered` — сообщение успешно доставлено получателю `undelivered` — сообщение не доставлено получателю `failed` — ошибка отправки или обработки сообщения у провайдера

Примеры кода

Как использовать примеры в документации

cURL (OAuth)

PHP

BX24.js

PHP CRest

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

try
        {
            const response = await $b24.callMethod(
                'messageservice.message.status.update',
                {
                    CODE: 'provider1',
                    MESSAGE_ID: '65575980fa531ac284c2ee68f81ebebd',
                    STATUS: 'delivered'
                }
            );
        
            const result = response.getData().result;
            console.log(result);
        }
        catch (error)
        {
            console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'messageservice.message.status.update',
                    [
                        'CODE' => 'provider1',
                        'MESSAGE_ID' => '65575980fa531ac284c2ee68f81ebebd',
                        'STATUS' => 'delivered',
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            print_r($result);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error updating message status: ' . $e->getMessage();
        }

BX24.callMethod(
            'messageservice.message.status.update',
            {
                CODE: 'provider1',
                MESSAGE_ID: '65575980fa531ac284c2ee68f81ebebd',
                STATUS: 'delivered'
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error(), result.error_description());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'messageservice.message.status.update',
            [
                'CODE' => 'provider1',
                'MESSAGE_ID' => '65575980fa531ac284c2ee68f81ebebd',
                'STATUS' => 'delivered',
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Обработка ответа

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, 403

{
            "error": "ERROR_MESSAGE_STATUS_INCORRECT",
            "error_description": "Message status incorrect!"
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код	Описание	Значение
`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!`	Метод запустил не администратор

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	Текущий метод не разрешен для вызова с помощью batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	Превышена максимальная длина параметров, переданных в метод batch
`401`	`NO_AUTH_FOUND` Wrong authorization data	Неверный access-токен или код вебхука
`400`	`INVALID_REQUEST` Https required	Для вызовов методов требуется использовать протокол HTTPS
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	REST API доступен только на коммерческих планах
`403`	`INVALID_CREDENTIALS` Invalid request credentials	У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	Манифест недоступен
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более высоких привилегий, чем предоставляет токен вебхука
`401`	`expired_token` The access token provided has expired	Предоставленный access-токен доступа истек
`403`	`user_access_error` The user does not have access to the application	Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям
`500`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Удалить провайдер

Пример провайдера сообщений

Обновить статус доставки сообщения messageservice.message.status.update

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

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

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

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

Возможные коды ошибокВозможные коды ошибок

Статусы и коды системных ошибокСтатусы и коды системных ошибок

Продолжите изучениеПродолжите изучение