метод REST scope: mail

mail.message.field.get

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

Кто может выполнять: любой пользователь

Описание

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

Метод mail.message.field.get возвращает описание поля письма по имени.

Параметры

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

Имя поля, описание которого нужно получить.

Доступные поля:

  • id — идентификатор письма
  • mailboxId — идентификатор почтового ящика
  • mailboxEmail — электронная почта почтового ящика
  • subject — тема письма
  • from — отправитель
  • to — получатели
  • cc — получатели копии
  • date — дата письма
  • isSeen — признак прочтения
  • hasAttachments — признак вложений
  • url — ссылка на письмо
  • bindings — связи письма
  • body — текст письма
select array необязательный

Список полей описания, которые нужно вернуть в ответе.

Доступные поля:

  • name — имя поля
  • type — тип данных
  • title — заголовок
  • description — описание
  • validationRules — правила валидации
  • requiredGroups — группы обязательности
  • filterable — признак доступности в фильтре
  • sortable — признак доступности в сортировке
  • editable — признак редактируемости
  • multiple — признак множественного значения
  • elementType — тип элемента для составных полей

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"name":"subject","select":["name","type","title"]}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/mail.message.field.get

Ответ

HTTP-статус: 200

{
    "result": {
        "item": {
            "name": "subject",
            "type": "string",
            "title": "subject"
        }
    },
    "time": {
        "start": 1769780771,
        "finish": 1769780771.081992,
        "duration": 0.08199191093444824,
        "processing": 0,
        "date_start": "2026-05-25T16:46:11+03:00",
        "date_finish": "2026-05-25T16:46:11+03:00",
        "operating_reset_at": 1769781371,
        "operating": 0
    }
}

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

result object

Объект с данными ответа

item object

Объект с описанием поля. Структура ответа зависит от select

time time

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

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

HTTP-статус: 400

{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
        "message": "Ошибка при валидации объекта запроса",
        "validation": [
            {
                "message": "Обязательное поле `name` не указано",
                "field": "name"
            }
        ]
    }
}
Код Описание Значение
Поле Описание ошибки Как исправить
Доступ запрещен Проверьте права пользователя и scope mail

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

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