метод REST scope: mail

mail.mailbox.senders

Получить отправителей

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

Описание

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

Метод mail.mailbox.senders возвращает список отправителей, доступных текущему пользователю.

Параметры

pagination object необязательный

Параметры постраничной навигации:
- page — номер страницы
- limit — количество записей на страницу, по умолчанию 25, максимум 100
- offset — смещение записей. Если переданы page и limit, смещение вычисляется автоматически

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"pagination":{"page":1,"limit":20,"offset":0}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/mail.mailbox.senders

Ответ

HTTP-статус: 200

{
    "result": {
        "items": [
            {
                "email": "user@example.com",
                "name": "Иван Петров",
                "sender": "Иван Петров <user@example.com>"
            },
            {
                "email": "user@example.com",
                "name": "Рабочая почта",
                "sender": "Рабочая почта <user@example.com>"
            }
        ]
    },
    "time": {
        "start": 1779819427,
        "finish": 1779819427.356922,
        "duration": 0.356921911239624,
        "processing": 0,
        "date_start": "2026-05-26T21:17:07+03:00",
        "date_finish": "2026-05-26T21:17:07+03:00",
        "operating_reset_at": 1779820027,
        "operating": 0
    }
}

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

result object

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

items array

Массив объектов отправителей

items[] object

Объект отправителя

email string

Адрес электронной почты отправителя

name string

Имя отправителя

sender string

Строка отправителя в формате Имя <email>

time time

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

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

HTTP-статус: 400

{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_INVALIDPAGINATIONEXCEPTION",
        "message": "Не удается распознать параметр пагинации `{\"limit\":\"abc\"}`"
    }
}
Код Описание Значение
Поле Описание ошибки Как исправить
Доступ запрещен Проверьте права пользователя и scope mail

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

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