Получить текст письма v 3.0 crm.activity.mail.getContent

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

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

Scope: crm

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

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

Метод crm.activity.mail.getContent возвращает письмо CRM: тему, отправителя, получателей, текст и элементы CRM, к которым привязано письмо. Текст приходит без HTML-разметки, длинный текст обрезается.

Метод работает только с письмами — делами с providerId равным CRM_EMAIL. Найти письма можно методом crm.<тип>.activity.list с условием ["providerId","=","CRM_EMAIL"].

Имя метода пишется с заглавной буквой C: crm.activity.mail.getContent. На имя в нижнем регистре метод отвечает ошибкой «Метод не найден».

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

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

Название
тип

Описание

activityId*
integer

Идентификатор письма — дела с providerId равным CRM_EMAIL.

Идентификатор можно получить методом crm.<тип>.activity.list

Примеры кода

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

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

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

Примеры получают письмо с идентификатором 747.

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"activityId":747}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/crm.activity.mail.getContent

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"activityId":747,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/crm.activity.mail.getContent

Методы CRM пока не входят в список методов REST 3.0, который знает $b24.actions.v3.call.make: такой вызов вернет ошибку SDK JSSDK_CORE_METHOD_NOT_SUPPORT_IN_API_V3. Вызывайте метод через HTTP-клиент REST 3.0 — $b24.getHttpClient(ApiVersion.v3).call.

import { ApiVersion, Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

type MailContentResult = {
  id: number
  subject: string
  from: string
  to: string[]
  body: string
  isBodyTruncated: boolean
}

try {
  const response = await $b24.getHttpClient(ApiVersion.v3).call<MailContentResult>(
    'crm.activity.mail.getContent',
    {
      activityId: 747,
    },
    Text.getUuidRfc4122()
  )

  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Email:', result.subject, result.body)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}

Методы CRM пока не входят в список методов REST 3.0, который знает $b24.actions.v3.call.make. Вызывайте метод через HTTP-клиент REST 3.0 — $b24.getHttpClient(B24Js.ApiVersion.v3).call.

<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function getMailContent() {
    try {
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.getHttpClient(B24Js.ApiVersion.v3).call(
        'crm.activity.mail.getContent',
        {
          activityId: 747,
        },
        B24Js.Text.getUuidRfc4122()
      )

      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Email:', result.subject, result.body)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

У методов CRM нет готовых оберток в b24pysdk, и SDK отправляет в REST 3.0 только методы из списка Config().api_v3_methods. Добавьте метод в этот список и вызовите его через bitrix_token.call_method с prefer_version=3.

from b24pysdk import Config
from b24pysdk.errors import BitrixSDKException
from b24pysdk.errors.v3 import BitrixAPIError

method = "crm.activity.mail.getContent"
Config().configure(api_v3_methods=Config().api_v3_methods | {method})

try:
    response = bitrix_token.call_method(
        api_method=method,
        params={
            "activityId": 747,
        },
        prefer_version=3,
    )
    result = response["result"]
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"code: {error.code}",
        f"message: {error.error.message}",
        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(
            'crm.activity.mail.getContent',
            [
                'activityId' => 747,
            ]
        );

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

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

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

BX24.callMethod(
    'crm.activity.mail.getContent',
    {
        activityId: 747,
    },
    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(
    'crm.activity.mail.getContent',
    [
        'activityId' => 747,
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.activity.mail.getContent", b24.Params{
	"activityId": 747,
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("crm.activity.mail.getContent: %w", err)
}

var result struct {
	ID              int      `json:"id"`
	Subject         string   `json:"subject"`
	From            string   `json:"from"`
	To              []string `json:"to"`
	Body            string   `json:"body"`
	IsBodyTruncated bool     `json:"isBodyTruncated"`
}
if err := json.Unmarshal(res.Result, &result); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(result.ID, result.Subject, result.From)

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

HTTP-статус: 200

{
    "result": {
        "id": 747,
        "subject": "Коммерческое предложение",
        "dateTime": "2026-10-28T12:19:18+03:00",
        "isIncoming": true,
        "from": "client@example.com",
        "to": [
            "sales@example.com"
        ],
        "cc": [],
        "bcc": [],
        "body": "Добрый день! Направляем коммерческое предложение.",
        "isBodyTruncated": false,
        "bindings": [
            {
                "entityTypeId": 2,
                "entityId": 4061
            },
            {
                "entityTypeId": 3,
                "entityId": 373
            }
        ]
    },
    "time": {
        "start": 1793711360,
        "finish": 1793711360.764732,
        "duration": 0.7647318840026855,
        "processing": 0,
        "date_start": "2026-11-03T16:09:20+03:00",
        "date_finish": "2026-11-03T16:09:20+03:00",
        "operating_reset_at": 1793711940,
        "operating": 0
    }
}

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

Данные письма приходят прямо в result, без вложенного ключа item.

Название `тип`	Описание
result `object`	Данные письма
result.id `integer`	Идентификатор письма
result.subject `string`	Тема письма
result.dateTime `datetime`	Дата и время письма
result.isIncoming `boolean`	`true` — входящее письмо, `false` — исходящее
result.from `string`	Адрес отправителя
result.to `string[]`	Адреса получателей
result.cc `string[]`	Адреса копии
result.bcc `string[]`	Адреса скрытой копии
result.body `string`	Текст письма без HTML-разметки
result.isBodyTruncated `boolean`	`true`, если текст длиннее 50 000 символов и обрезан
result.bindings `object[]`	Элементы CRM, к которым привязано письмо: `entityTypeId` — тип объекта, `entityId` — идентификатор элемента
time `time`	Информация о времени выполнения запроса

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

HTTP-статус: 404

{
    "error": {
        "code": "CRM_EMAIL_ACTIVITY_NOT_FOUND",
        "message": "CRM email activity not found."
    }
}

Название `тип`	Описание
error.code `string`	Строковый код ошибки. Используйте для идентификации типа исключения
error.message `string`	Текстовое описание ошибки
error.validation `array`	Массив c деталями ошибки. Присутствует только в ошибках валидации данных `BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION`
error.validation[].field `string`	Название поля, в котором возникла ошибка валидации
error.validation[].message `string`	Описание ошибки, связанной с указанным полем

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

Ошибки запроса

Код	Описание ошибки	Как исправить
`CRM_EMAIL_INVALID_REQUEST`	activityId must be a positive integer.	Передайте `activityId` положительным целым числом. HTTP-статус 400
`BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION`	В поле `activityId` требуется тип данных `int` для такого запроса	Передайте `activityId` числом, а не строкой. HTTP-статус 400

Письмо не найдено

Код	Описание ошибки	Как исправить
`CRM_EMAIL_ACTIVITY_NOT_FOUND`	CRM email activity not found.	Письма нет или дело с этим идентификатором не письмо. Проверьте, что у дела `providerId` равен `CRM_EMAIL`. HTTP-статус 404
`CRM_EMAIL_ACCESS_DENIED`	Access denied to the CRM email activity.	Нет права на просмотр письма: нет доступа к элементам CRM, к которым оно привязано. HTTP-статус 403

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

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

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

Была ли статья полезна?

Получить привязки дела

Получить цепочку писем

Получить текст письма v 3.0 crm.activity.mail.getContent

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

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

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

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

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

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

Ошибки запросаОшибки запроса

Письмо не найденоПисьмо не найдено

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

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

Была ли статья полезна?

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

Примеры кода

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

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

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

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

Ошибки запроса

Письмо не найдено

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

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