Переслать письмо mail.message.forward
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
Кто может выполнять метод: пользователь с доступом к почтовому ящику, где находится письмо, если ему доступен адрес отправителя из
from
Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.
Метод mail.message.forward пересылает письмо новым получателям.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
forwardMessageId* |
Идентификатор письма, которое нужно переслать. Идентификатор можно получить методом mail.message.list |
|
from* |
Адрес отправителя. Адрес должен быть в списке доступных пользователю отправителей. Можно передать адрес в формате Доступные адреса можно получить методом mail.mailbox.senders, поле |
|
to* |
Непустой массив получателей. Элемент массива — e-mail или имя получателя. Имя метод ищет сначала в адресной книге почты пользователя, затем среди сотрудников. Если найдено несколько совпадений или ни одного, метод вернет ошибку Адреса из адресной книги можно получить методом mail.recipient.listContacts, адреса сотрудников — методом mail.recipient.listEmployees |
|
subject* |
Тема письма. Пустая строка не допускается |
|
body* |
Текст письма. Пустая строка не допускается. Можно передать обычный текст или HTML. Письмо отправляется в формате HTML |
|
cc |
Массив получателей копии. Формат элементов такой же, как у Передавайте массив, даже для одного адреса |
|
bcc |
Массив получателей скрытой копии. Формат элементов такой же, как у Передавайте массив, даже для одного адреса |
|
mailboxId |
Идентификатор почтового ящика, через который нужно отправить письмо. Нужен, если адрес Значение должно быть положительным числом и соответствовать адресу Идентификатор можно получить методом mail.mailbox.senders, поле |
|
senderId |
Идентификатор отправителя. Используйте, если адрес Значение должно быть положительным числом и соответствовать адресу Идентификатор можно получить методом mail.mailbox.senders, поле |
Под текстом из body метод цитирует исходное письмо и прикладывает все его вложения. Префикс Fwd: в тему метод не добавляет.
Если адрес from принадлежит подключенному почтовому ящику пользователя, письмо уходит через этот ящик и сохраняется в его папке отправленных. Если адрес принадлежит отдельному отправителю без ящика, письмо уходит через почтовый сервис Битрикс24.
Перед отправкой метод проверяет лимиты Битрикс24:
- общее количество получателей в
to,ccиbccограничено тарифом. Если лимит не задан, допускается до 10 получателей - на демо-тарифе и тарифах без синхронизации почты в каждом из массивов
to,ccиbccможет быть только один получатель - действуют дневной лимит отправителя, дневной и месячный лимиты писем Битрикс24
Если лимит превышен, письмо не отправляется, а метод возвращает ошибку с описанием лимита.
Примеры кода
Как использовать примеры в документации
Вызов нового API отличается добавлением параметра /api/ в запросе:
https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/mail.message.forward
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
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":"Пересылаю письмо.","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/mail.message.forward
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type ForwardResult = {
success: boolean
to: string[]
}
try {
const response = await $b24.actions.v3.call.make<ForwardResult>({
method: 'mail.message.forward',
params: {
forwardMessageId: 15,
from: 'user@example.com',
to: ['manager@example.com'],
subject: 'Fwd: Договор',
body: 'Пересылаю письмо.',
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Письмо переслано:', result.success, 'Получатели:', result.to)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function forwardMessage() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v3.call.make({
method: 'mail.message.forward',
params: {
forwardMessageId: 15,
from: 'user@example.com',
to: ['manager@example.com'],
subject: 'Fwd: Договор',
body: 'Пересылаю письмо.',
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Письмо переслано:', result.success, 'Получатели:', result.to)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', forwardMessage)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
to = [
"manager@example.com",
]
try:
bitrix_response = client.mail.message.forward(
forward_message_id=15,
from_='user@example.com',
to=to,
subject='Fwd: Договор',
body='Пересылаю письмо.',
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.
try {
$response = $b24Service
->core
->call(
'mail.message.forward',
[
'forwardMessageId' => 15,
'from' => 'user@example.com',
'to' => ['manager@example.com'],
'subject' => 'Fwd: Договор',
'body' => 'Пересылаю письмо.'
]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.
BX24.callMethod(
'mail.message.forward',
{
forwardMessageId: 15,
from: 'user@example.com',
to: ['manager@example.com'],
subject: 'Fwd: Договор',
body: 'Пересылаю письмо.'
},
result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.
require_once('crest.php');
$result = CRest::call(
'mail.message.forward',
[
'forwardMessageId' => 15,
'from' => 'user@example.com',
'to' => ['manager@example.com'],
'subject' => 'Fwd: Договор',
'body' => 'Пересылаю письмо.'
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "mail.message.forward", b24.Params{
"forwardMessageId": 15,
"from": "user@example.com",
"to": []string{"manager@example.com"},
"subject": "Fwd: Договор",
"body": "Пересылаю письмо.",
})
if err != nil {
return fmt.Errorf("mail.message.forward: %w", err)
}
var item struct {
Success bool `json:"success"`
To []string `json:"to"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.Success, item.To)
Обработка ответа
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 |
Объект с результатом отправки |
|
success |
Результат отправки. В успешном ответе всегда |
|
to |
Адреса получателей из |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
"message": "Ошибка при валидации объекта запроса",
"validation": [
{
"message": "Original message not found or access denied.",
"field": "MESSAGE_FORWARD_FAILED"
}
]
}
}
|
Название |
Описание |
|
error.code |
Строковый код ошибки. Используйте для идентификации типа исключения |
|
error.message |
Текстовое описание ошибки |
|
error.validation |
Массив c деталями ошибки. Присутствует только в ошибках валидации данных |
|
error.validation[].field |
Название поля, в котором возникла ошибка валидации |
|
error.validation[].message |
Описание ошибки, связанной с указанным полем |
Возможные коды ошибок
Ошибки валидации запроса
Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION
В ответе с этим кодом поле field содержит не имя параметра, а код причины ошибки. Метод проверяет параметры по очереди и возвращает первую найденную ошибку.
|
Значение field |
Описание ошибки |
Как исправить |
|
|
Parameter "forwardMessageId" is required. |
Передайте |
|
|
Parameter "from" is required. |
Передайте |
|
|
Parameter "subject" is required. |
Передайте |
|
|
Parameter "body" is required. |
Передайте |
|
|
Parameter "to" is required and must be a non-empty array. |
Передайте |
|
|
Recipient "zzqxnotexist987" not found in address book or among employees. |
Получатель из |
|
|
Ambiguous recipient "Ivan". Found multiple matches: Ivan Petrov <ivan@example.com>, Ivan Smirnov <smirnov@example.com>. Please specify the exact email address. |
По имени найдено несколько получателей. Передайте e-mail из списка в тексте ошибки |
|
|
No valid recipients provided. |
В |
|
|
Original message not found or access denied. |
Письмо |
|
|
The mailbox action is unavailable while its migration status is active or unavailable. |
Почтовый ящик переносится или статус переноса недоступен. Повторите запрос после завершения переноса |
|
|
Sender identifiers must be positive integers. |
|
|
|
Sender email is not available for this user. |
Адреса |
|
|
Sender is not available for this user. |
Переданные |
|
|
Total number of recipients (to + cc + bcc) is 12, must not exceed 10. |
Получателей больше лимита тарифа. Разделите отправку на несколько писем |
|
|
Tariff restriction: each of to, cc, bcc must contain at most 1 recipient(s). |
На тарифе Битрикс24 в каждом массиве может быть только один получатель |
|
|
Daily sender email limit reached. |
Исчерпан дневной лимит отправителя. Повторите отправку на следующий день или используйте другой адрес |
|
|
Daily portal mail limit reached. |
Исчерпан дневной лимит писем Битрикс24. Повторите отправку на следующий день |
|
|
Monthly portal mail limit reached. |
Исчерпан месячный лимит писем Битрикс24 |
|
|
Mailbox authentication failed. |
Почтовый ящик отправителя не прошел авторизацию на почтовом сервере. Проверьте настройки подключения ящика |
|
|
Failed to send email. |
Письмо не удалось отправить. Повторите запрос позже |
Если в cc или bcc передать строку вместо массива, Битрикс24 возвращает HTTP-статус 500 и ошибку INTERNAL_SERVER_ERROR. Передавайте эти параметры массивом.
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Приложение Маркетплейса заблокировано, потому что число установленных приложений превышает лимит тарифа. События такому приложению не доставляются. Приложения, освобожденные от лимита, не блокируются |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |