Email

Методы

POST Отправка письма на указанный адрес —
POST Отправка письма по списку рассылки —
POST Просмотр списка получателей рассылки со статусами доставки —
POST Отправка письма на множество адресов, а также персональные письма в пакетном режиме Если вам нужно отправить одно письмо на множество адресов, тогда установите параметр 'message_type': 'bulk' и передайте массив адресов: 'delivery_list': [ 'email1@mail.com', 'email2@mail.com', ] Если …
POST Получение статусов писем и ошибок, если таковые имеются, из рассылки, созданной методом sendBulkEmail —
POST Добавление адреса в список отписавшихся от email-рассылок —
POST Удаление адреса из списка отписавшихся от email-рассылок —
POST Темплейтс —
POST /api/v2/sendEmail Отправка письма на указанный адрес
URL запроса
POST https://app.sms.by/api/v2/sendEmail

Параметры

Параметр Расположение Тип Обязательный Описание
token formData string Да Ваш API ключ
sender_email formData string Да Email-адрес отправителя, от которого будет отправлено письмо
sender_name formData string Нет Имя отправителя
subject formData string Да Заголовок письма
message formData string Да Содержимое письма
attachment formData file Нет Прикреплённый файл
email formData string Да Email-адрес получателя
d_schedule formData string Нет Если вы хотите отложить отправку письма, укажите здесь дату отправки в формате 'ГГГГ-ММ-ДД ЧЧ:ММ'
track_open formData number Нет 0: не отслеживать открытие письма, 1: отслеживать. Если не задано, установится в 1
track_click formData number Нет 0: не отслеживать переход по ссылкам из письма, 1: отслеживать. Если не задано, установится в 1

Ответы

200 — Выполнено успешно

{
    "status": "OK",
    "result": {
        "email_id": 1234567
    }
}
POST /api/v2/sendEmailByList Отправка письма по списку рассылки
URL запроса
POST https://app.sms.by/api/v2/sendEmailByList

Параметры

Параметр Расположение Тип Обязательный Описание
token formData string Да Ваш API ключ
name formData string Нет Имя рассылки. Если не задано, будет сформировано автоматически.
list_id formData number Да ID списка рассылки
sender_email formData string Да Email-адрес отправителя, от которого будет отправлено письмо
sender_name formData string Нет Имя отправителя
subject formData string Да Заголовок письма
message formData string Да Содержимое письма
attachment formData file Нет Прикреплённый файл
d_schedule formData string Нет Время отправки сообщения, указывается в формате 'ГГГГ-ММ-ДД ЧЧ:ММ'. Если не задано, отправка писем начнётся сразу.
track_open formData number Нет 1: отслеживать открытие письма, 0: не отслеживать. Если не задано, установится в 1.
track_click formData number Нет 1: отслеживать переход по ссылкам из письма, 0: не отслеживать. Если не задано, установится в 1.

Ответы

200 — Выполнено успешно

{
    "status": "OK",
    "result": {
        "message_id": 1234,
        "count_emails": 100
    }
}
POST /api/v2/getEmailDeliveryList Просмотр списка получателей рассылки со статусами доставки
URL запроса
POST https://app.sms.by/api/v2/getEmailDeliveryList

Параметры

Параметр Расположение Тип Обязательный Описание
token formData string Да Ваш API ключ
message_id formData number Да ID рассылки

Ответы

200 — Выполнено успешно

{
    "status": "OK",
    "result": [
        {
            "email_id": "654321",
            "email": "email1@email.by",
            "status": "DELIVERED",
            "error": ""
        },
        {
            "email_id": "654322",
            "email": "email2@emailby",
            "status": "UNDELIVERED",
            "error": "Bad recipient address syntax"
        }
    ]
}
POST /api/v2/sendBulkEmail Отправка письма на множество адресов, а также персональные письма в пакетном режиме
URL запроса
POST https://app.sms.by/api/v2/sendBulkEmail
Если вам нужно отправить одно письмо на множество адресов, тогда установите параметр 'message_type': 'bulk' и передайте массив адресов:

'delivery_list': [
   'email1@mail.com',
   'email2@mail.com',
]

Если вам требуется отправлять каждое письмо на отдельный адрес, используйте 'message_type': 'personal', передавая каждый раз заголовок, содержимое письма и адрес:

'delivery_list': [
   {
      'email': 'email1@mail.com',
      'subject': 'Заголовок письма 1',
      'message': 'Письмо 1'
   },
   {
      'email': 'email2@mail.com',
      'subject': 'Заголовок письма 2',
      'message': 'Письмо 2'
   }


Примеры api запроса
{
  'token': 'eyJpdiI6Ij...',
  'name': 'Рассылка №1',
  'sender_email': 'from@test.com',
  'sender_name': 'SENDER',
  'message_type': 'bulk',
  'subject': 'Заголовок письма',
  'message': 'Письмо',
  'd_schedule': '2024-12-31 12:00',
  'track_open': '1',
  'track_click': '1',
  'delivery_list': [
    'email1@mail.com',
    'email2@mail.com'
  ]
}

{
  'token': 'eyJpdiI6Ij...',
  'name': 'Рассылка №2',
  'sender_email': 'from@test.com',
  'sender_name': 'SENDER',
  'message_type': 'personal',
  'd_schedule': '2024-12-31 12:00',
  'track_open': '1',
  'track_click': '1',
  'delivery_list': [
    {
      'email': 'email1@mail.com',
      'subject': 'Заголовок письма 1',
      'message': 'Письмо 1'
    },
    {
      'email': 'email2@mail.com',
      'subject': 'Заголовок письма 2',
      'message': 'Письмо 2'
    }
  ]
}

Параметры

Параметр Расположение Тип Обязательный Описание
token formData string Да Ваш API ключ
name formData string Нет Имя рассылки. Если не задано, будет сформировано автоматически.
sender_email formData string Да Email-адрес отправителя, от которого будет отправлено письмо
sender_name formData string Нет Имя отправителя
message_type formData string Нет Тип множественной отправки, по-умолчанию bulk
subject formData string Да Заголовок письма
message formData string Да Содержимое письма
d_schedule formData string Нет Время отправки сообщения, указывается в формате 'ГГГГ-ММ-ДД ЧЧ:ММ'. Если не задано, отправка писем начнётся сразу.
track_open formData number Нет 1: отслеживать открытие письма, 0: не отслеживать. Если не задано, установится в 1.
track_click formData number Нет 1: отслеживать переход по ссылкам из письма, 0: не отслеживать. Если не задано, установится в 1.
delivery_list[0] formData string Нет Адрес первого получателя
delivery_list[1] formData string Нет Адрес второго получателя

Ответы

200 — Выполнено успешно

{
    "status": "OK",
    "result": {
        "uuid": "cc9c8043-8caf-11ef-b035-9e8f47954dec"
    }
}
POST /api/v2/statusBulkEmail Получение статусов писем и ошибок, если таковые имеются, из рассылки, созданной методом sendBulkEmail
URL запроса
POST https://app.sms.by/api/v2/statusBulkEmail

Параметры

Параметр Расположение Тип Обязательный Описание
token formData string Да Ваш API ключ
uuid formData string Да UUID, полученный в ответе метода sendBulkEmail

Ответы

200 — Выполнено успешно

{
    "status": "OK",
    "result": [
        {
            "message_id": "12345",
            "name": "Название рассылки",
            "sender_email": "from@test.com",
            "sender_name": "SENDER",
            "success": [
                {
                    "email_id": "654321",
                    "recipient": "email1@mail.com",
                    "status": "DELIVERED",
                    "error": null
                },
                {
                    "email_id": "654322",
                    "recipient": "email2@mail.com",
                    "status": "OPEN",
                    "error": null
                }
            ],
            "errors": [
                {
                    "email": "email3@mail",
                    "error": "Электронный адрес получателя задан некорректно"
                }
            ]
        }
    ]
}
POST /api/v2/unsubscribeEmail Добавление адреса в список отписавшихся от email-рассылок
URL запроса
POST https://app.sms.by/api/v2/unsubscribeEmail

Параметры

Параметр Расположение Тип Обязательный Описание
token formData string Да Ваш API ключ
email formData string Да Отписываемый email-адрес
list_ids formData string Нет ID списков рассылки через запятую, от которых email-адрес будет отписан. Если параметр не передан, email-адрес будет отписан от всех списков рассылки.
reason formData string Нет Комментарий к отписке

Ответы

200 — Выполнено успешно

{
    "status": "OK"
}
POST /api/v2/subscribeEmail Удаление адреса из списка отписавшихся от email-рассылок
URL запроса
POST https://app.sms.by/api/v2/subscribeEmail

Параметры

Параметр Расположение Тип Обязательный Описание
token formData string Да Ваш API ключ
email formData string Да Email-адрес
list_ids formData string Нет ID списков рассылки через запятую, для которых будет отменена отписка. Если параметр не передан, отписка email-адреса будет отменена для всех списков рассылки.

Ответы

200 — Выполнено успешно

{
    "status": "OK"
}
POST /api/v2/getEmailTemplates Темплейтс
URL запроса
POST https://app.sms.by/api/v2/getEmailTemplates

Параметры

Параметр Расположение Тип Обязательный Описание
token query string Да Ваш API ключ

Ответы

200 — Выполнено успешно

{
    "status": "OK",
    "result": [
        {
            "id": 11,
            "title": "Название шаблона"
        },
        {
            "id": 12,
            "title": "Название второго шаблона"
        }
    ]
}