Ответить на письмо mail.message.reply

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: mail

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

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

Метод mail.message.reply отправляет ответ на письмо.

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

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

Название
тип

Описание

replyToMessageId*
integer

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

Идентификатор можно получить методом mail.message.list. Адрес отправителя исходного письма для to можно получить методом mail.message.get

from*
string

Адрес отправителя. Адрес должен быть в списке доступных пользователю отправителей.

Можно передать адрес в формате Имя <email>: метод учитывает только адрес.

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

to*
array

Непустой массив получателей. Элемент массива — e-mail или имя получателя.

Имя метод ищет сначала в адресной книге почты пользователя, затем среди сотрудников. Если найдено несколько совпадений или ни одного, метод вернет ошибку RESOLVE_RECIPIENTS_ERROR. Чтобы не зависеть от поиска, передавайте e-mail.

Адреса из адресной книги можно получить методом mail.recipient.listContacts, адреса сотрудников — методом mail.recipient.listEmployees

subject*
string

Тема письма. Пустая строка не допускается

body*
string

Текст письма. Пустая строка не допускается.

Можно передать обычный текст или HTML. Письмо отправляется в формате HTML

cc
array

Массив получателей копии. Формат элементов такой же, как у to.

Передавайте массив, даже для одного адреса

bcc
array

Массив получателей скрытой копии. Формат элементов такой же, как у to.

Передавайте массив, даже для одного адреса

mailboxId
integer

Идентификатор почтового ящика, через который нужно отправить письмо. Нужен, если адрес from доступен пользователю через несколько ящиков или отправителей. Если переданы mailboxId и senderId, метод учитывает mailboxId.

Значение должно быть положительным числом и соответствовать адресу from.

Идентификатор можно получить методом mail.mailbox.senders, поле mailboxId

senderId
integer

Идентификатор отправителя. Используйте, если адрес from доступен пользователю через несколько отправителей.

Значение должно быть положительным числом и соответствовать адресу from.

Идентификатор можно получить методом mail.mailbox.senders, поле senderId

Метод добавляет к письму заголовок In-Reply-To, чтобы почтовые программы показали ответ в одной цепочке с исходным письмом. Под текстом из body метод цитирует исходное письмо и прикладывает изображения, встроенные в его текст. Остальные вложения исходного письма в ответ не попадают.

Получателей, тему и отправителя метод не подставляет из исходного письма: передайте их в запросе. Префикс Re: в тему метод не добавляет.

Если адрес from принадлежит подключенному почтовому ящику пользователя, письмо уходит через этот ящик и сохраняется в его папке отправленных. Если адрес принадлежит отдельному отправителю без ящика, письмо уходит через почтовый сервис Битрикс24.

Перед отправкой метод проверяет лимиты Битрикс24:

  • общее количество получателей в to, cc и bcc ограничено тарифом. Если лимит не задан, допускается до 10 получателей
  • на демо-тарифе и тарифах без синхронизации почты в каждом из массивов to, cc и bcc может быть только один получатель
  • действуют дневной лимит отправителя, дневной и месячный лимиты писем Битрикс24

Если лимит превышен, письмо не отправляется, а метод возвращает ошибку с описанием лимита.

Примеры кода

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

Вызов нового API отличается добавлением параметра /api/ в запросе:

https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/mail.message.reply

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"replyToMessageId":15,"from":"user@example.com","to":["client@example.com"],"subject":"Re: Договор","body":"Спасибо, получили."}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/mail.message.reply
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"replyToMessageId":15,"from":"user@example.com","to":["client@example.com"],"subject":"Re: Договор","body":"Спасибо, получили.","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/mail.message.reply
// 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 ReplyResult = {
  success: boolean
  to: string[]
}

try {
  const response = await $b24.actions.v3.call.make<ReplyResult>({
    method: 'mail.message.reply',
    params: {
      replyToMessageId: 15,
      from: 'user@example.com',
      to: ['client@example.com'],
      subject: 'Re: Договор',
      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 sendReply() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v3.call.make({
        method: 'mail.message.reply',
        params: {
          replyToMessageId: 15,
          from: 'user@example.com',
          to: ['client@example.com'],
          subject: 'Re: Договор',
          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', sendReply)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

to = [
    "client@example.com",
]

try:
    bitrix_response = client.mail.message.reply(
        reply_to_message_id=15,
        from_='user@example.com',
        to=to,
        subject='Re: Договор',
        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.reply',
            [
                'replyToMessageId' => 15,
                'from' => 'user@example.com',
                'to' => ['client@example.com'],
                'subject' => 'Re: Договор',
                'body' => 'Спасибо, получили.'
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    print_r($result);
} catch (Throwable $e) {
    echo $e->getMessage();
}

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

BX24.callMethod(
    'mail.message.reply',
    {
        replyToMessageId: 15,
        from: 'user@example.com',
        to: ['client@example.com'],
        subject: 'Re: Договор',
        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.reply',
    [
        'replyToMessageId' => 15,
        'from' => 'user@example.com',
        'to' => ['client@example.com'],
        'subject' => 'Re: Договор',
        'body' => 'Спасибо, получили.'
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "mail.message.reply", b24.Params{
	"replyToMessageId": 15,
	"from":             "user@example.com",
	"to":               []string{"client@example.com"},
	"subject":          "Re: Договор",
	"body":             "Спасибо, получили.",
})
if err != nil {
	return fmt.Errorf("mail.message.reply: %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": [
            "client@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

Результат отправки. В успешном ответе всегда true: если письмо не отправлено, метод возвращает ошибку

to
array

Адреса получателей из to, на которые отправлено письмо. Имена получателей в этом массиве заменены найденными e-mail. Получатели копии и скрытой копии в массив не входят

time
time

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

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

HTTP-статус: 400

{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
        "message": "Ошибка при валидации объекта запроса",
        "validation": [
            {
                "message": "Original message not found or access denied.",
                "field": "MESSAGE_REPLY_FAILED"
            }
        ]
    }
}

Название
тип

Описание

error.code
string

Строковый код ошибки. Используйте для идентификации типа исключения

error.message
string

Текстовое описание ошибки

error.validation
array

Массив c деталями ошибки. Присутствует только в ошибках валидации данных BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

error.validation[].field
string

Название поля, в котором возникла ошибка валидации

error.validation[].message
string

Описание ошибки, связанной с указанным полем

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

Ошибки валидации запроса

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

В ответе с этим кодом поле field содержит не имя параметра, а код причины ошибки. Метод проверяет параметры по очереди и возвращает первую найденную ошибку.

Значение field

Описание ошибки

Как исправить

MISSING_REPLYTOMESSAGEID

Parameter "replyToMessageId" is required.

Передайте replyToMessageId в теле запроса

MISSING_FROM

Parameter "from" is required.

Передайте from непустой строкой

MISSING_SUBJECT

Parameter "subject" is required.

Передайте subject непустой строкой

MISSING_BODY

Parameter "body" is required.

Передайте body непустой строкой

MISSING_TO

Parameter "to" is required and must be a non-empty array.

Передайте to непустым массивом. Строка вместо массива тоже вызывает эту ошибку

RESOLVE_RECIPIENTS_ERROR

Recipient "zzqxnotexist987" not found in address book or among employees.

Получатель из to, cc или bcc не найден по имени. Передайте e-mail. Значение без @ и e-mail в неверном формате метод считает именем

RESOLVE_RECIPIENTS_ERROR

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_RECIPIENTS

No valid recipients provided.

В to только пустые строки или пробелы. Передайте хотя бы один адрес

MESSAGE_REPLY_FAILED

Original message not found or access denied.

Письмо replyToMessageId не найдено, у пользователя нет доступа к его почтовому ящику или вложения письма еще не загружены. Проверьте идентификатор методом mail.message.get и повторите запрос позже, если письмо только что пришло

MAILBOX_MIGRATION_ACTION_BLOCKED, MAILBOX_MIGRATION_STATUS_UNAVAILABLE

The mailbox action is unavailable while its migration status is active or unavailable.

Почтовый ящик переносится или статус переноса недоступен. Повторите запрос после завершения переноса

MESSAGE_REPLY_FAILED

Sender identifiers must be positive integers.

mailboxId или senderId меньше 1. Передайте значения из ответа mail.mailbox.senders

MESSAGE_REPLY_FAILED

Sender email is not available for this user.

Адреса from нет среди доступных пользователю отправителей. Проверьте адрес методом mail.mailbox.senders

MESSAGE_REPLY_FAILED

Sender is not available for this user.

Переданные mailboxId или senderId не соответствуют адресу from. Возьмите связанные значения из одной записи ответа mail.mailbox.senders

MESSAGE_REPLY_FAILED

Total number of recipients (to + cc + bcc) is 12, must not exceed 10.

Получателей больше лимита тарифа. Разделите отправку на несколько писем

MESSAGE_REPLY_FAILED

Tariff restriction: each of to, cc, bcc must contain at most 1 recipient(s).

На тарифе Битрикс24 в каждом массиве может быть только один получатель

MESSAGE_REPLY_FAILED

Daily sender email limit reached.

Исчерпан дневной лимит отправителя. Повторите отправку на следующий день или используйте другой адрес

MESSAGE_REPLY_FAILED

Daily portal mail limit reached.

Исчерпан дневной лимит писем Битрикс24. Повторите отправку на следующий день

MESSAGE_REPLY_FAILED

Monthly portal mail limit reached.

Исчерпан месячный лимит писем Битрикс24

MESSAGE_REPLY_FAILED

Mailbox authentication failed.

Почтовый ящик отправителя не прошел авторизацию на почтовом сервере. Проверьте настройки подключения ящика

MESSAGE_REPLY_FAILED

Failed to send email.

Письмо не удалось отправить. Повторите запрос позже

Если в cc или bcc передать строку вместо массива, Битрикс24 возвращает HTTP-статус 500 и ошибку INTERNAL_SERVER_ERROR. Передавайте эти параметры массивом.

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

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

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

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

403

FEATURE_NOT_AVAILABLE_ON_CURRENT_PLAN
Функция недоступна на текущем тарифе.

Приложение Маркетплейса заблокировано, потому что число установленных приложений превышает лимит тарифа. События такому приложению не доставляются. Приложения, освобожденные от лимита, не блокируются

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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