# mail.message.forward

URL: https://chugunov.pro/api-bitrix24/mail/message/mail-message-forward/
Проверено на Битрикс24 REST API, обновлено 11.09.2026 (ревизия источника fb39d6c).
Источник: официальная документация Битрикс24 (bitrix-tools/b24-rest-docs, лицензия MIT, © Bitrix). Справочник независимый, официальной документацией не является.

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

## Описание

Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](https://chugunov.pro/api-bitrix24/rest-v3/).

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

## Параметры

- `forwardMessageId` `integer` — обязательный. Идентификатор письма, которое нужно переслать.
  Идентификатор можно получить методом [mail.message.list](https://chugunov.pro/api-bitrix24/mail/message/mail-message-list/)
- `from` `string` — обязательный. E-mail отправителя.
  Доступные адреса можно получить методом [mail.mailbox.senders](https://chugunov.pro/api-bitrix24/mail/mailbox/mail-mailbox-senders/)
- `to` `array` — обязательный. Массив email-адресов получателей
- `subject` `string` — обязательный. Тема письма
- `body` `string` — обязательный. Текст письма: обычный текст или базовый HTML
- `cc` `array` — необязательный. Массив email-адресов получателей копии
- `bcc` `array` — необязательный. Массив email-адресов получателей скрытой копии

## Ответ

HTTP-статус: 200

```json
{
    "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

```json
{
    "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`

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

### cURL (Webhook)

```bash
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 (OAuth)

```bash
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
```

### JS (TS)

```ts
// 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: Contract',
      body: 'Forwarding the message.',
    },
    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('Forwarded successfully:', result.success, 'To:', result.to)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
```

### JS (UMD)

```html
<!-- 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: Contract',
          body: 'Forwarding the message.',
        },
        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('Forwarded successfully:', result.success, 'To:', result.to)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', forwardMessage)
</script>
```

### Python

```python
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}")
```

### PHP

```php
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();

    echo 'Success: ' . print_r($result, true);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error: ' . $e->getMessage();
}
```

### BX24.js

```js
BX24.callMethod(
    'mail.message.forward',
    {
        forwardMessageId: 15,
        from: 'user@example.com',
        to: ['manager@example.com'],
        subject: 'Fwd: Договор',
        body: 'Пересылаю письмо.'
    },
    function(result){
        console.info(result.data());
        console.log(result);
    }
);
```

### PHP CRest

```php
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>';
```

### Go

```go
// 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"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.Success)
```

Оригинал в официальной документации: https://apidocs.bitrix24.ru/api-reference/mail/message/mail-message-forward.html
