#Адреса отправителя ящика

GET /v1/mail/mailboxes/:id/senders

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

#Параметры

Параметр В Тип Обяз. По умолч. Описание
id path number да — Идентификатор почтового ящика (из списка ящиков)

#Примеры

#curl — личный ключ

Terminal 
curl "https://vibecode.bitrix24.tech/v1/mail/mailboxes/1/senders" \
  -H "X-Api-Key: YOUR_API_KEY"

#curl — OAuth-приложение

Terminal 
curl "https://vibecode.bitrix24.tech/v1/mail/mailboxes/1/senders" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

#JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/mail/mailboxes/1/senders', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { success, data } = await res.json()
console.log(data.items)

#JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/mail/mailboxes/1/senders', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { success, data } = await res.json()

#Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.items array Список адресов отправителя
data.items[].email string Адрес электронной почты отправителя
data.items[].name string Отображаемое имя отправителя
data.items[].sender string Строка для заголовка From в формате "Имя <email>"

#Пример ответа

JSON 
{
  "success": true,
  "data": {
    "items": [
      {
        "email": "info@example.com",
        "name": "Рабочая почта",
        "sender": "Компания <info@example.com>"
      },
      {
        "email": "support@example.com",
        "name": "Поддержка",
        "sender": "Служба поддержки <support@example.com>"
      },
      {
        "email": "sales@example.com",
        "name": "Отдел продаж",
        "sender": "Отдел продаж <sales@example.com>"
      }
    ]
  }
}

#Пример ответа при ошибке

400 — нечисловой ID:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "id must be a positive integer"
  }
}

#Ошибки

HTTP Код Описание
400 INVALID_PARAMS id не является положительным целым числом
403 SCOPE_DENIED API-ключ не имеет скоупа mail
401 TOKEN_MISSING API-ключ не имеет настроенных токенов
429 RATE_LIMITED Превышен лимит запросов
502 BITRIX_UNAVAILABLE Портал Битрикс24 недоступен
422 BITRIX_ERROR Битрикс24 вернул ошибку

Полный список общих ошибок API — Ошибки.

#Известные особенности

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

#Смотрите также