метод REST scope: mail

mail.message.get

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

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

Описание

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

Метод mail.message.get возвращает письмо по идентификатору.

Параметры

id integer обязательный

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

Идентификатор можно получить методом mail.message.list

select array необязательный

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

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

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":15,"select":["id","mailboxId","mailboxEmail","subject","from","to","cc","date","isSeen","hasAttachments","url","bindings","body"]}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/mail.message.get

Ответ

HTTP-статус: 200

{
    "result": {
        "item": {
            "id": 15,
            "mailboxId": 1,
            "mailboxEmail": "user@example.com",
            "subject": "Тема письма",
            "from": "client@example.com",
            "to": "user@example.com",
            "cc": null,
            "date": "2026-05-25T10:00:00+03:00",
            "isSeen": true,
            "hasAttachments": false,
            "url": "/mail/message/15",
            "bindings": [],
            "body": "Текст письма"
        }
    },
    "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

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

item object

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

time time

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

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

HTTP-статус: 400

{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION",
        "message": "Запись с ID = `15` не найдена"
    }
}
Код Описание Значение
Поле Описание ошибки Как исправить
id Обязательное поле id не указано Добавьте id в тело запроса

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

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