Page tree
Skip to end of metadata
Go to start of metadata

Выполняет отправку электронного письма на указанный в запросе адрес

Должен быть установлен и настроен сервис отправки электронной почты


Запрос

Адрес запроса

POST: {{url}}/email/send

Заголовки запроса

ЗаголовокЗначение (тип/формат значения)ОписаниеОбязательный
AuthorizationBasic {key} (без скобок и через пробел после Basic)Данные базовой авторизации (строка "логин:пароль" в формате Base64)+

Тело запроса

ПолеТип данныхОписаниеОбязательный
fromNamestringИмя отправителя+
subjectstringТема письма+
bodystringТело письма+
toEmailstringПолучатель письма+

Пример тела запроса

{
    "fromName": "Имя отправителя длинной до 100 символов",
    "subject": "Тема моего сообщения длинной до 200 символов",
    "body": "Тело моего сообщения",
    "toEmail": "123@123.ru"
}


Ответ сервера

В случае успешного выполнения сервер вернет ответ в формате JSON со следующими данными:

Модель: 

ПолеТип данныхОписание

message

stringСодержимое ответа ( для успешно выполненого запроса всегда "Отправлено")


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

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


  • No labels