метод REST scope: mail

mail.message.forward

Переслать письмо

Кто может выполнять: пользователь с доступом к почтовому ящику, где находится письмо

Описание

Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.

Метод mail.message.forward пересылает письмо.

Параметры

forwardMessageId integer обязательный

Идентификатор письма, которое нужно переслать.

Идентификатор можно получить методом mail.message.list

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

E-mail отправителя.

Доступные адреса можно получить методом mail.mailbox.senders

to array обязательный

Массив email-адресов получателей

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

Тема письма

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

Текст письма: обычный текст или базовый HTML

cc array необязательный

Массив email-адресов получателей копии

bcc array необязательный

Массив email-адресов получателей скрытой копии

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"forwardMessageId":15,"from":"user@example.com","to":["manager@example.com"],"subject":"Fwd: Договор","body":"Пересылаю письмо."}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/mail.message.forward

Ответ

HTTP-статус: 200

{
    "result": {
        "success": true,
        "to": [
            "manager@example.com"
        ]
    },
    "time": {
        "start": 1779819678,
        "finish": 1779819678.84803,
        "duration": 0.8480300903320312,
        "processing": 0,
        "date_start": "2026-05-26T21:21:18+03:00",
        "date_finish": "2026-05-26T21:21:18+03:00",
        "operating_reset_at": 1779820278,
        "operating": 0
    }
}

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

result object

Объект с результатом отправки

success boolean

Признак успешной отправки

to array

Получатели, которым отправлено письмо

time time

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

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

HTTP-статус: 400

{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
        "message": "Ошибка при валидации объекта запроса",
        "validation": [
            {
                "message": "Обязательное поле `forwardMessageId` не указано",
                "field": "forwardMessageId"
            }
        ]
    }
}
Код Описание Значение
Поле Описание ошибки Как исправить
forwardMessageId Обязательное поле forwardMessageId не указано Передайте forwardMessageId в теле запроса
from Обязательное поле from не указано Передайте from в теле запроса
to Обязательное поле to не указано Передайте to в теле запроса
subject Обязательное поле subject не указано Передайте subject в теле запроса
body Обязательное поле body не указано Передайте body в теле запроса
forwardMessageId MESSAGE_FORWARD_FAILED Проверьте существование письма и доступ к нему, затем повторите запрос
to NO_RECIPIENTS Проверьте, что массив to содержит корректные адреса получателей
to, cc, bcc RESOLVE_RECIPIENTS_ERROR Проверьте формат значений и доступность получателей в в to, cc, bcc

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

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