Email

8 методов

Методы

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

Параметры

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

Ответы

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

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

FlashCall

2 метода

Методы

POST Создание FlashCall —
POST Проверка кода FlashCall —
POST /api/v1/flashCall Создание FlashCall
URL запроса
POST https://app.sms.by/api/v1/flashCall

Параметры

Параметр Расположение Тип Обязательный Описание
token formData string Да Ваш API ключ
code formData integer Нет Код подтверждения (Если не указан сгенерируется автоматически)
phone formData string Да Номер телефона для FlashCall
attempt formData integer Нет Кол-во попыток для подтверждения кода (если не указано то 3)
time_valid formData integer Нет Время действия кода подтверждения в секундах (если не указано то 90)

Ответы

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

{
    "status": "success",
    "data": {
        "code": "557594",
        "phone": "375251234567",
        "time_valid": "90",
        "fclid": "261f72de286e1621b5100abae1c5239c",
        "attempt": 3
    }
}

400 — Некорректный запрос

421 — Данные не прошли проверку

500 — Сервер недоступен

POST /api/v1/confirmFlashCall Проверка кода FlashCall
URL запроса
POST https://app.sms.by/api/v1/confirmFlashCall

Параметры

Параметр Расположение Тип Обязательный Описание
token formData string Да Ваш API ключ
code formData integer Да Код подтверждения
phone formData string Да Номер телефона
fclid formData string Да fclid из метода flashCall при создании

Ответы

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

{
    "status": "success",
    "message": "Код подтвержден",
    "data": {
        "fclid": "91cc691561e564554f122a903ea2c762",
        "phone": "375257077727",
        "activated_at": "2021-04-28 14:26:33",
        "valid": 1,
        "quantity": 1
    }
}

400 — Некорректный запрос

421 — Данные не прошли проверку

500 — Сервер недоступен

Templates

5 методов

Методы

POST Получить все шаблоны сообщений —
POST Получить шаблон сообщения по ID —
POST Создание шаблона сообщения —
POST Измениеие шаблона сообщения —
POST Удаление шаблона сообщения —
POST /api/v2/getTemplateMessages Получить все шаблоны сообщений
URL запроса
POST https://app.sms.by/api/v2/getTemplateMessages

Параметры

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

Ответы

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

{
    "status": "OK",
    "result": [
        {
            "id": 11,
            "name": "Название шаблона"
        },
        {
            "id": 12,
            "name": "Название второго шаблона"
        }
    ]
}
POST /api/v2/getTemplateMessageById Получить шаблон сообщения по ID
URL запроса
POST https://app.sms.by/api/v2/getTemplateMessageById

Параметры

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

Ответы

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

{
    "status": "OK",
    "result": {
        "id": 12,
        "name": "Название шаблона",
        "message": "Текст сообщения",
        "parts": 1
    }
}
POST /api/v2/createTemplateMessage Создание шаблона сообщения
URL запроса
POST https://app.sms.by/api/v2/createTemplateMessage

Параметры

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

Ответы

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

{
    "status": "OK",
    "result": {
        "id": 16,
        "name": "Название нового шаблона",
        "message": "Текст нового сообщения",
        "parts": 1
    }
}
POST /api/v2/editTemplateMessage Измениеие шаблона сообщения
URL запроса
POST https://app.sms.by/api/v2/editTemplateMessage

Параметры

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

Ответы

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

{
    "status": "OK",
    "result": {
        "id": 16,
        "name": "Новое название шаблона",
        "message": "Новый текст сообщения",
        "parts": 1
    }
}
POST /api/v2/deleteTemplateMessage Удаление шаблона сообщения
URL запроса
POST https://app.sms.by/api/v2/deleteTemplateMessage

Параметры

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

Ответы

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

{
    "status": "OK"
}

Авторизация

4 метода

Методы

POST Получить токен авторизации (login) —
POST Получить api ключ (getApiKey) —
GET Восстановление пароля (recovery-password) —
POST Регистрация пользователя (register) —
POST /remote-api/login Получить токен авторизации (login)
URL запроса
POST https://app.sms.by/remote-api/login

Параметры

Параметр Расположение Тип Обязательный Описание
name formData string Да Логин от личного кабинета
password formData string Да Пароль от личного кабинета

Ответы

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

{
    "status": "ok",
    "token": "f75b3c62b5a6147eff499549e677319c"
}

400 — Некорректный запрос

404 — Api_key не найден

429 — Превышен лимит запросов

500 — Сервер недоступен

POST /remote-api/getApiKey Получить api ключ (getApiKey)
URL запроса
POST https://app.sms.by/remote-api/getApiKey

Параметры

Параметр Расположение Тип Обязательный Описание
token formData string Да Токен авторизации

Ответы

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

{
    "status": "ok",
    "api_key": "2f376acefc89c7c04c2424250e6258a7"
}

400 — Некорректный запрос

404 — Api_key не найден

429 — Превышен лимит запросов

500 — Сервер недоступен

GET /remote-api/recovery-password Восстановление пароля (recovery-password)
URL запроса
GET https://app.sms.by/remote-api/recovery-password

Параметры

Параметр Расположение Тип Обязательный Описание
email query string Да Ваш E-Mail адрес

Ответы

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

{
    "status": "OK",
    "message": "Вам отправлено письмо на почту для восстановления пароля"
}

400 — Некорректный запрос

404 — Страница не найдена

429 — Превышен лимит запросов

500 — Сервер недоступен

POST /remote-api/register Регистрация пользователя (register)
URL запроса
POST https://app.sms.by/remote-api/register

Параметры

Параметр Расположение Тип Обязательный Описание
email formData string Да Электронная почта
phone formData string Да Номер телефона
token formData string Да Токен доступа из метода (GET get-token)

Ответы

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

{
    "status": "success",
    "message": "Регистрация прошла успешно. На вашу почту будет выслано письмо с подтверждением и временным паролем"
}

400 — Некорректный запрос

422 — Данные не прошли проверку

429 — Превышен лимит запросов

500 — Сервер недоступен

Альфа-имя SMS

4 метода

Методы

GET Получить все доступные Альфа-имена —
GET Получить id Альфа-имени по его названию —
GET Получение категорий для Альфа-имени —
POST Создание нового Альфа-имени —
GET /api/v1/getAlphanames Получить все доступные Альфа-имена
URL запроса
GET https://app.sms.by/api/v1/getAlphanames

Параметры

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

Ответы

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

{
    "0": "Системное имя (SMS.by)",
    "1363": "VasheImya"
}

400 — Некорректный запрос

404 — Страница не найдена

429 — Превышен лимит запросов

500 — Сервер недоступен

GET /api/v1/getAlphanameId Получить id Альфа-имени по его названию
URL запроса
GET https://app.sms.by/api/v1/getAlphanameId

Параметры

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

Ответы

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

{
    "id": 1236
}

400 — Некорректный запрос

404 — Страница не найдена

429 — Превышен лимит запросов

500 — Сервер недоступен

GET /api/v1/getAlphanameCategory Получение категорий для Альфа-имени
URL запроса
GET https://app.sms.by/api/v1/getAlphanameCategory

Параметры

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

Ответы

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

{
    "status": "OK",
    "result": [
        {
            "id": 2,
            "name": "Авто (все,что касается автомобильной индустрии)"
        },
        {
            "id": 3,
            "name": "Банки\/займы"
        },
        {
            "id": 1,
            "name": "Выбрать"
        },
        {
            "id": 4,
            "name": "Гипермаркеты\/торговые сети\/торговые центры"
        },
        {
            "id": 5,
            "name": "Игры\/казино\/квесты"
        }
    ]
}

400 — Некорректный запрос

404 — Страница не найдена

429 — Превышен лимит запросов

500 — Сервер недоступен

POST /api/v1/createAlphaname Создание нового Альфа-имени
URL запроса
POST https://app.sms.by/api/v1/createAlphaname

Параметры

Параметр Расположение Тип Обязательный Описание
token formData string Да Ваш API ключ
name formData string Да Название Альфа имени
yur_name formData string Да Юридическое лицо
unp formData integer Да Учетный номер плательщика
country_id formData integer Да Для РБ country_id = 1
postcode formData integer Да Индекс (Можно узнать на сайте белпочты)
city formData string Да Город регистрации
address formData string Да Юридический адрес (Если вы ИП, можно указать адрес проживания)
name_category_id formData integer Да Сфера деятельности компании ID (берется из метода getAlphanameCategory)
traffic_type_id formData integer Да Тип рассылки: 1 - Сервисная, 2 - Рекламная
text_example formData string Да Пример текста рассылки

Ответы

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

{
    "status": "ok",
    "message": "Альфа-имя MyCom успешно добавлено"
}

400 — Некорректный запрос

404 — Страница не найдена

429 — Превышен лимит запросов

500 — Сервер недоступен

Альфа-имя Viber

2 метода

Методы

GET Получить все доступные Viber-имена —
GET Получить id Viber-имени по его названию —
GET /api/v1/getVibernames Получить все доступные Viber-имена
URL запроса
GET https://app.sms.by/api/v1/getVibernames

Параметры

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

Ответы

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

{
    "status": "OK",
    "result": {
        "391": "SMS.by"
    }
}

400 — Некорректный запрос

404 — Страница не найдена

429 — Превышен лимит запросов

500 — Сервер недоступен

GET /api/v1/getVibernameId Получить id Viber-имени по его названию
URL запроса
GET https://app.sms.by/api/v1/getVibernameId

Параметры

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

Ответы

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

{
    "status": "OK",
    "result": {
        "id": 260
    }
}

400 — Некорректный запрос

404 — Страница не найдена

429 — Превышен лимит запросов

500 — Сервер недоступен

Аудиозаписи

4 метода

Методы

GET Получить все аудиозаписи —
POST Создание/Загрузка аудиодорожки —
POST Подтверждение на создание аудиодорожки —
POST Удаление аудиодорожки —
GET /api/v1/getVoices Получить все аудиозаписи
URL запроса
GET https://app.sms.by/api/v1/getVoices

Параметры

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

Ответы

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

{
    "status": "success",
    "data": [
        {
            "id": 5,
            "name": "Audio",
            "file": "audio-file-5fdb19f0d51ce2.94277987.mp3",
            "status": "MODERATED"
        },
        {
            "id": 9,
            "name": "Audio_2",
            "file": null,
            "status": "NEW"
        }
    ],
    "url": "https:\/\/app.sms.by\/upload\/voice\/"
}

406 — Контент не найден

404 — Страница не найдена

429 — Превышен лимит запросов

500 — Сервер недоступен

POST /api/v1/createVoice Создание/Загрузка аудиодорожки
URL запроса
POST https://app.sms.by/api/v1/createVoice

Параметры

Параметр Расположение Тип Обязательный Описание
token formData string Да Ваш API ключ
name formData string Да Укажите имя аудиозаписи
type formData string Да Тип аудиозаписи, для файла (file) для конвертиции из текста в аудиозапись (text)
file formData file Нет Обязательно если выбран тип (file)
text formData string Нет Обязательно если выбран тип (text)
gender formData integer Нет Обязательно если выбран тип (text). Мужской голос (1), Женский (0)

Ответы

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

{
    "status": "success",
    "data": {
        "user_id": 2,
        "name": "375257077727",
        "file": "audio-file-605add1cd2d281.88203539.mp3",
        "time_sound": 8,
        "file_format": "MP3",
        "status": "TO_MODERATE",
        "type": "FILE",
        "updated_at": "2021-03-24 09:33:00",
        "created_at": "2021-03-24 09:33:00",
        "id": 10
    }
}

400 — Некорректный запрос

404 — Страница не найдена

421 — Параметры не прошли валидацию

429 — Превышен лимит запросов

500 — Сервер недоступен

POST /api/v1/confirmCreateVoice Подтверждение на создание аудиодорожки
URL запроса
POST https://app.sms.by/api/v1/confirmCreateVoice

Параметры

Параметр Расположение Тип Обязательный Описание
token formData string Да Ваш API ключ
confirm formData string Да Необходимо указать параметр true
voice_id formData string Да Укажите id аудиозаписи. Информация доступна в методе (getVoices)

Ответы

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

{
    "status": "success",
    "data": {
        "id": 9,
        "user_id": 2,
        "voice_id": null,
        "name": "asdasdasd",
        "file": null,
        "record_text": "Hello! Test record message",
        "time_sound": null,
        "file_format": null,
        "type": "TEXT",
        "gender": 0,
        "status": "TO_CREATE",
        "url": null,
        "cost": null,
        "completed": 0,
        "deleted": "0",
        "created_at": "2021-01-04 17:47:59",
        "updated_at": "2021-03-24 09:35:59"
    }
}

400 — Некорректный запрос

404 — Страница не найдена

421 — Параметры не прошли валидацию

429 — Превышен лимит запросов

500 — Сервер недоступен

POST /api/v1/deleteVoice Удаление аудиодорожки
URL запроса
POST https://app.sms.by/api/v1/deleteVoice

Параметры

Параметр Расположение Тип Обязательный Описание
token formData string Да Ваш API ключ
voice_id formData string Да Укажите id аудиозаписи. Информация доступна в методе (getVoices)

Ответы

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

{
    "status": "success",
    "message": "Аудиозапись успешно удалена"
}

400 — Некорректный запрос

404 — Страница не найдена

421 — Параметры не прошли валидацию

429 — Превышен лимит запросов

500 — Сервер недоступен

Настройки

2 метода

Методы

POST Измениение пароля —
POST Настройки уведомлений —
POST /api/v1/editPassword Измениение пароля
URL запроса
POST https://app.sms.by/api/v1/editPassword

Параметры

Параметр Расположение Тип Обязательный Описание
token formData string Да Ваш API ключ
password formData string Да Старый пароль
password_new formData string Да Новый пароль
re_password_new formData string Да Новый пароль

Ответы

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

400 — Некорректный запрос

421 — Данные не прошли проверку

500 — Сервер недоступен

POST /api/v1/editNotification Настройки уведомлений
URL запроса
POST https://app.sms.by/api/v1/editNotification

Параметры

Параметр Расположение Тип Обязательный Описание
token formData string Да Ваш API ключ
can_mailing formData integer Нет Вкл/Откл всех уведомлений
balance formData integer Нет Укажите минимальный баланс при котором будет уведомление
send_balance_email formData integer Нет Вкл/Откл уведомление о минимальном балансе

Ответы

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

400 — Некорректный запрос

421 — Данные не прошли проверку

500 — Сервер недоступен

Реализация 2-х факторной авторизации

6 методов

Методы

GET Создание объекта PasswordObject —
GET Получить все объекты PasswordObjects —
GET Получить объект PasswordObject по ID —
GET Редактирование объекта PasswordObject —
GET Удаление объекта PasswordObject —
GET Отправить SMS с кодом подтверждения —
GET /api/v1/createPasswordObject Создание объекта PasswordObject
URL запроса
GET https://app.sms.by/api/v1/createPasswordObject

Параметры

Параметр Расположение Тип Обязательный Описание
token query string Да Ваш API ключ
type_id query string Да Может принимать следующие значения: letters - только буквы латинского алфавита, numbers - только цифры, both - смешанный тип
len query integer Да Длина пароля от 1 до 16

Ответы

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

{
    "result": {
        "password_object_id": 243
    }
}

400 — Некорректный запрос

404 — Страница не найдена

429 — Превышен лимит запросов

500 — Сервер недоступен

GET /api/v1/getPasswordObjects Получить все объекты PasswordObjects
URL запроса
GET https://app.sms.by/api/v1/getPasswordObjects

Параметры

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

Ответы

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

400 — Некорректный запрос

404 — Страница не найдена

429 — Превышен лимит запросов

500 — Сервер недоступен

GET /api/v1/getPasswordObject Получить объект PasswordObject по ID
URL запроса
GET https://app.sms.by/api/v1/getPasswordObject

Параметры

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

Ответы

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

400 — Некорректный запрос

404 — Страница не найдена

429 — Превышен лимит запросов

500 — Сервер недоступен

GET /api/v1/editPasswordObject Редактирование объекта PasswordObject
URL запроса
GET https://app.sms.by/api/v1/editPasswordObject

Параметры

Параметр Расположение Тип Обязательный Описание
token query string Да Ваш API ключ
id query integer Да ID объекта возвращаемое из createPasswordObject
type_id query string Да Может принимать следующие значения: letters - только буквы латинского алфавита, numbers - только цифры, both - смешанный тип
len query integer Да Длина пароля от 1 до 16

Ответы

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

{
    "result": "1"
}

400 — Некорректный запрос

404 — Страница не найдена

429 — Превышен лимит запросов

500 — Сервер недоступен

GET /api/v1/deletePasswordObject Удаление объекта PasswordObject
URL запроса
GET https://app.sms.by/api/v1/deletePasswordObject

Параметры

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

Ответы

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

{
    "result": "1"
}

400 — Некорректный запрос

404 — Страница не найдена

429 — Превышен лимит запросов

500 — Сервер недоступен

GET /api/v1/sendSmsMessageWithCode Отправить SMS с кодом подтверждения
URL запроса
GET https://app.sms.by/api/v1/sendSmsMessageWithCode

Параметры

Параметр Расположение Тип Обязательный Описание
token query string Да Ваш API ключ
password_object_id query integer Да ID объекта возвращаемое из createPasswordObject
phone query string Да Номер телефона
message query string Да сообщение должно обязательно содержать переменную для подстановки %CODE%) Например: message = Ваш пароль: %CODE%
alphaname_id query integer Нет смотрите использование Альфа-имен

Ответы

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

{
    "status": "ok",
    "parts": 1,
    "len": 21,
    "sms_id": 2208471,
    "code": "GAYXILYZOX"
}

400 — Некорректный запрос

404 — Страница не найдена

429 — Превышен лимит запросов

500 — Сервер недоступен

Реквизиты

2 метода

Методы

POST Изменения/Добавления реквизитов —
GET Просмотр реквизитов —
POST /api/v1/requisites Изменения/Добавления реквизитов
URL запроса
POST https://app.sms.by/api/v1/requisites

Параметры

Параметр Расположение Тип Обязательный Описание
token formData string Да Ваш API ключ
name formData string Да Юридическое лицо
address formData string Да Юридический адрес
address_post formData string Да Почтовый адрес
responsible_person formData string Да Ответственное лицо
operates_basis formData string Да Действует на основании
unp formData string Да УНП
bank_name formData string Да Название банка
bank_account formData string Да Банковский счёт
bank_code formData string Да Код банка
bank_address formData string Да Адрес банка

Ответы

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

{
    "status": "success",
    "data": {
        "id": 328,
        "user_id": 2,
        "d_create": 1526034915,
        "name": "ООО Рога и Копыта 234",
        "address": "Минск, ул. Озерная 34 оф.234",
        "address_regist": "",
        "address_post": "Минск, ул. Озерная 34 оф.234",
        "responsible_person": "Иванов Иван Иванович",
        "operates_basis": "Доверенности №22",
        "unp": "1234567899",
        "okpo": "",
        "bank_name": "ЗАО Альфа Банк",
        "bank_account": "12345678901234567890123456",
        "bank_code": "A65S464S",
        "bank_address": "220013, Беларусь, г. Минск, ул. Сурганова, 433",
        "email": "client2@example.com",
        "phone": "375250002"
    }
}

400 — Некорректный запрос

421 — Данные прошли проветку

429 — Превышен лимит запросов

500 — Сервер недоступен

GET /api/v1/getRequisites Просмотр реквизитов
URL запроса
GET https://app.sms.by/api/v1/getRequisites

Параметры

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

Ответы

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

{
    "status": "success",
    "data": {
        "id": 328,
        "user_id": 2,
        "d_create": 1526034915,
        "name": "ООО Рога и Копыта 234",
        "address": "Минск, ул. Озерная 34 оф.234",
        "address_regist": "",
        "address_post": "Минск, ул. Озерная 34 оф.234",
        "responsible_person": "Иванов Иван Иванович",
        "operates_basis": "Доверенности №22",
        "unp": "1234567899",
        "okpo": "",
        "bank_name": "ЗАО Альфа Банк",
        "bank_account": "12345678901234567890123456",
        "bank_code": "A65S464S",
        "bank_address": "220013, Беларусь, г. Минск, ул. Сурганова, 433",
        "email": "client2@example.com",
        "phone": "375250002"
    }
}

400 — Некорректный запрос

404 — Страница не найдена

429 — Превышен лимит запросов

500 — Сервер недоступен

Сообщения SMS

14 методов

Методы

POST Отправка сообщения(-ий) на множество списков, а также персональные сообщения в пакетном режиме Если вам нужно отправить 1 сообщение на список номеров, тогда используйте параметр 'message_type': 'bulk', как в примере ниже, передавая массив номеров: 'delivery_list': [ '375297777777', '37529555555…
POST Получение статусов сообщений из рассылок, созданных методом sendBulkSms Для получения информации о рассылках, созданных методом sendBulkSms, необходимо использовать поле uuid из ответа метода sendBulkSms (это UUID запроса). Метод statusBulkSms вернет расширенную информаци…
POST Отправка одиночного сообщения —
POST Отправка кода подтверждения Telegram —
POST Отправка кода подтверждения WhatsApp —
GET Создание сообщения для массовой отправки —
GET Проверка статуса сообщения (статуса смс-рассылки в целом) —
GET Отправка сообщения —
GET Проверить статус SMS сообщения —
GET Получить список своих сообщений —
GET Получение списка рассылки по идентификатору сообщения —
POST Отправка сообщений выбранному списку —
POST Подтверждение / получение информации о рассылке —
GET Получить все рассылки WEB и API —
POST /api/v1/sendBulkSms Отправка сообщения(-ий) на множество списков, а также персональные сообщения в пакетном режиме
URL запроса
POST https://app.sms.by/api/v1/sendBulkSms
Если вам нужно отправить 1 сообщение на список номеров, тогда используйте параметр 'message_type': 'bulk', как в примере ниже, передавая массив номеров:
'delivery_list': [
    '375297777777',
    '375295555555',
 ]

Если вам требуется отправлять каждое сообщение на отдельный номер телефона, то используйте 'message_type': 'personal', передавая каждый раз текст сообщения и номер телефона:
'delivery_list': [
    {
       'phone': '375299999999',
       'text': 'personal message 1'
    },

Для планирование рассылки вы можете указывать время рассылки через параметр schedule_time, в формате YYYY-MM-DDTHH:mm:ss

Образец api запроса
{
 'token': 'eyJpdiI6IjJzOFlFcXBmOUZEcGJlYzlzeFJValE9PSIsInZhbHV...',
 'callback_url': '',
 'messages': [
    { 
       'alphaname_id': '123',
       'name': 'рассылка 1',
       'message_type': 'personal',
       'schedule_time': '2024-12-31T23:59:59',
       'delivery_list': [
         {
             'phone': '375299999999',
             'text': 'personal message 1'
          },
          { 
            'phone': '375298888888',
            'text': 'personal message 2' 
         } 
      ] 
   }, 
   {
       'alphaname_id': '234',
       'name': 'рассылка 2',
       'message_type': 'bulk',
       'text': 'message text 2',
       'schedule_time': '2024-12-31T23:59:59', 
       'delivery_list': [
         '375297777777', 
         '375295555555', 
       ]
    }
 ]
}

Параметры

Параметр Расположение Тип Обязательный Описание
token query string Да Ваш API ключ
callback_url query string Да URL, на который будут приходить ответ по работе метода в асинхронном режиме
messages query array Да Массив сообщения (Образец объекта в описаний запроса)

Ответы

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

{
    "uuid": "cc9c8043-8caf-11ef-b035-9e8f47954dec",
    "success": "OK"
}

400 — Некорректный запрос

404 — Страница не найдена

429 — Превышен лимит запросов

500 — Сервер недоступен

POST /api/v1/statusBulkSms Получение статусов сообщений из рассылок, созданных методом sendBulkSms
URL запроса
POST https://app.sms.by/api/v1/statusBulkSms
Для получения информации о рассылках, созданных методом sendBulkSms, необходимо использовать поле uuid из ответа метода sendBulkSms (это UUID запроса). Метод statusBulkSms вернет расширенную информацию о статусах сообщений и ошибках, если таковые имеются

Параметры

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

Ответы

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

[
    {
        "message_id": 1,
        "name": "mailing list 1",
        "alphaname_id": 1,
        "success": [
            {
                "delivery_id": 1,
                "phone": "375291111111",
                "status": "DELIVERED",
                "status_time": "2024-10-16 22:52:42.497994"
            },
            {
                "delivery_id": 2,
                "phone": "375292222222",
                "status": "DELIVERED",
                "status_time": "2024-10-16 22:52:43.379779"
            }
        ]
    },
    {
        "message_id": 2,
        "name": "mailing list 2",
        "alphaname_id": 1,
        "success": [
            {
                "delivery_id": 3,
                "phone": "375291111111",
                "status": "DELIVERED",
                "status_time": "2024-10-16 22:52:44.793377"
            },
            {
                "delivery_id": 4,
                "phone": "375292222222",
                "status": "DELIVERED",
                "status_time": "2024-10-16 22:52:43.008560"
            }
        ]
    }
]

400 — Некорректный запрос

404 — Страница не найдена

429 — Превышен лимит запросов

500 — Сервер недоступен

POST /api/v1/sendQuickSMS Отправка одиночного сообщения
URL запроса
POST https://app.sms.by/api/v1/sendQuickSMS

Параметры

Параметр Расположение Тип Обязательный Описание
token query string Да Ваш API ключ
message query string Да Сообщение
phone query string Да Номер телефона
alphaname_id query string Да —
show_cost query integer Нет Включить (1 - включить, 0 - не включать) стоимость за сообщение в ответ
forwarding_message formData integer Нет Включить переадресацию (1 - включить, 0 - не включать). Если в течение указанного времени отправленное сообщение не получит статус "Доставлено", оно будет отправлено в Viber
forwarding_time formData integer Нет Через сколько минут произойдёт переадресация, если она включена. По умолчанию 60 минут. Минимум 5 минут. Максимум 60 минут
vibername_id formData integer Нет ID viber-имени, от которого придёт сообщение, если forwarding_message=1 и сообщение на SMS не будет доставлено

Ответы

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

{
    "sms_id": 2197871,
    "status": "NEW",
    "parts": 1
}

400 — Некорректный запрос

404 — Страница не найдена

429 — Превышен лимит запросов

500 — Сервер недоступен

POST /api/v1/sendOtpTelegram Отправка кода подтверждения Telegram
URL запроса
POST https://app.sms.by/api/v1/sendOtpTelegram

Параметры

Параметр Расположение Тип Обязательный Описание
token query string Да Ваш API ключ
message query string Да Допустим ввод только цифр, максимум 16 символов
phone query string Да Номер телефона

Ответы

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

{
    "sms_id": 2197871,
    "status": "NEW",
    "parts": 1
}

400 — Некорректный запрос

404 — Страница не найдена

429 — Превышен лимит запросов

500 — Сервер недоступен

POST /api/v1/sendOtpWhatsApp Отправка кода подтверждения WhatsApp
URL запроса
POST https://app.sms.by/api/v1/sendOtpWhatsApp

Параметры

Параметр Расположение Тип Обязательный Описание
token query string Да Ваш API ключ
message query string Да Допустим ввод только цифр, максимум 16 символов
phone query string Да Номер телефона

Ответы

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

{
    "sms_id": 2197871,
    "status": "NEW",
    "parts": 1
}

400 — Некорректный запрос

404 — Страница не найдена

429 — Превышен лимит запросов

500 — Сервер недоступен

GET /api/v1/createSmsMessage Создание сообщения для массовой отправки
URL запроса
GET https://app.sms.by/api/v1/createSmsMessage

Параметры

Параметр Расположение Тип Обязательный Описание
token query string Да Ваш API ключ
name query string Нет Название рассылки
message query string Да Ваше сообщение
alphaname_id query integer Нет ID Вашего альфа имени
time query string Нет Дата и время отправки (Формат даты '2019-05-24 10:22')

Ответы

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

{
    "status": "ok",
    "parts": 1,
    "len": 31,
    "message_id": 2604834,
    "alphaname": "system",
    "time": 0
}

400 — Некорректный запрос

404 — Страница не найдена

429 — Превышен лимит запросов

500 — Сервер недоступен

GET /api/v1/checkSMSMessageStatus Проверка статуса сообщения (статуса смс-рассылки в целом)
URL запроса
GET https://app.sms.by/api/v1/checkSMSMessageStatus

Параметры

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

Ответы

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

400 — Некорректный запрос

404 — Страница не найдена

429 — Превышен лимит запросов

500 — Сервер недоступен

GET /api/v1/sendSMS Отправка сообщения
URL запроса
GET https://app.sms.by/api/v1/sendSMS

Параметры

Параметр Расположение Тип Обязательный Описание
token query string Да Ваш API ключ
message_id query integer Да ID сообщения из метода createSmsMessage
phone query string Да Номер телефона

Ответы

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

{
    "sms_id": 2204968,
    "status": "NEW"
}

400 — Некорректный запрос

404 — Страница не найдена

429 — Превышен лимит запросов

500 — Сервер недоступен

GET /api/v1/checkSMS Проверить статус SMS сообщения
URL запроса
GET https://app.sms.by/api/v1/checkSMS

Параметры

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

Ответы

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

{
    "sms_id": 2637396,
    "sent": 1616407661,
    "delivered": 1616407673
}

400 — Некорректный запрос

404 — Страница не найдена

429 — Превышен лимит запросов

500 — Сервер недоступен

GET /api/v1/getMessagesList Получить список своих сообщений
URL запроса
GET https://app.sms.by/api/v1/getMessagesList

Параметры

Параметр Расположение Тип Обязательный Описание
token query string Да Ваш API ключ
limit_offset query integer Нет Смещение выборки
limit_rows query integer Нет Ограничение выборки (обязателен, если используется limit_offset)

Ответы

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

{
    "result": [
        {
            "message_id": 2564327,
            "message": "68755",
            "parts": 1,
            "d_create": "2021-03-22 11:32:32",
            "status": "moderated"
        },
        {
            "message_id": 2564580,
            "message": "37271",
            "parts": 1,
            "d_create": "2021-03-22 11:32:32",
            "status": "moderated"
        }
    ]
}

400 — Некорректный запрос

429 — Превышен лимит запросов

500 — Сервер недоступен

GET /api/v1/getSmsDeliveryList Получение списка рассылки по идентификатору сообщения
URL запроса
GET https://app.sms.by/api/v1/getSmsDeliveryList

Параметры

Параметр Расположение Тип Обязательный Описание
token query string Да Ваш API ключ
message_id query integer Да ID сообщения
limit_offset query integer Нет Смещение выборки
limit_rows query integer Нет Ограничение выборки (обязателен, если используется limit_offset)

Ответы

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

{
    "result": [
        {
            "phone": 375293332211,
            "status": "delivered",
            "d_sent": "2021-03-22 11:32:32"
        },
        {
            "phone": 375293332212,
            "status": "sent",
            "d_sent": "2021-03-22 11:32:32"
        }
    ]
}

400 — Некорректный запрос

429 — Превышен лимит запросов

500 — Сервер недоступен

POST /api/v1/sendSmsList Отправка сообщений выбранному списку
URL запроса
POST https://app.sms.by/api/v1/sendSmsList

Параметры

Параметр Расположение Тип Обязательный Описание
token formData string Да Ваш API ключ
name formData string Да Название рассылки
message formData string Да Текст сообщения
d_schedule formData string Да Планируемое время отправки в формате ГГГГ-ММ-ДД ЧЧ:ММ
list_id formData integer Да ID списка с контактами из метода (getSubscriberLists)
alphaname_id formData integer Да ID альфа-имени (getAlphanameId)

Ответы

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

400 — Некорректный запрос

404 — Страница не найдена

429 — Превышен лимит запросов

500 — Сервер недоступен

POST /api/v1/confirmSendMessageByList Подтверждение / получение информации о рассылке
URL запроса
POST https://app.sms.by/api/v1/confirmSendMessageByList

Параметры

Параметр Расположение Тип Обязательный Описание
token formData string Да Ваш API ключ
message_id formData integer Да ID рассылки полученный в методе sendSmsList
confirm formData integer Да 0 - получить информацию о рассылке, 1 - подтвердить рассылку

Ответы

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

400 — Недостаточно средств для продолжения

500 — Сервер недоступен

GET /api/v1/getSMSMessages Получить все рассылки WEB и API
URL запроса
GET https://app.sms.by/api/v1/getSMSMessages

Параметры

Параметр Расположение Тип Обязательный Описание
token query string Да Ваш API ключ
type query string Нет Укажите тип сообщений WEB или API (Для получения всех параметров поле не передовать)

Ответы

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

{
    "status": "success",
    "data": [
        {
            "id": 1173020,
            "name": "Notifacation",
            "d_create": 1614154034,
            "d_schedule": 1645612020,
            "type": "API",
            "parts": "27631",
            "count_phones": 27631,
            "status": "NEW",
            "sms_delivered": "0",
            "cost": "718.40600",
            "alphaname": "SMS.by"
        }
    ]
}

406 — Контент не найден

404 — Страница не найдена

429 — Превышен лимит запросов

500 — Сервер недоступен

Сообщения Viber

11 методов

Методы

POST Отправка сообщения(-ий) на множество списков, а также персональные сообщения в пакетном режиме Если вам нужно отправить 1 сообщение на список номеров, тогда используйте параметр 'message_type': 'bulk', как в примере ниже, передавая массив номеров: 'delivery_list': [ '375291111111', '37529222222…
POST Получение статусов сообщений из рассылок, созданных методом sendBulkViber Для получения информации о рассылках, созданных методом sendBulkViber, необходимо использовать поле uuid из ответа метода sendBulkViber (это UUID запроса). Метод statusBulkViber вернет расширенную инф…
POST Отправка одиночного Viber сообщения (не требует предварительного создания) —
POST Получение данных о сообщении отправленном методом sendQuickViberMessage —
POST Отправка Viber-сообщения выбранному списку рассылки —
POST Подтвердить Viber-рассылку. С баланса будут списаны деньги. —
POST Получить список своих Viber-рассылок —
POST Получить данные о Viber-рассылке —
POST Получение списка телефонов по идентификатору Viber-рассылки —
POST Просмотр входящих сообщений для Viber-рассылки —
POST Пометить перечисленные входящие сообщения как прочитанные —
POST /api/v1/sendBulkViber Отправка сообщения(-ий) на множество списков, а также персональные сообщения в пакетном режиме
URL запроса
POST https://app.sms.by/api/v1/sendBulkViber
Если вам нужно отправить 1 сообщение на список номеров, тогда используйте параметр 'message_type': 'bulk', как в примере ниже, передавая массив номеров:
'delivery_list': [
    '375291111111',
    '375292222222',
 ]
Если вам требуется отправлять каждое сообщение на отдельный номер телефона, то используйте 'message_type': 'personal', передавая каждый раз текст сообщения и номер телефона. Например:
'delivery_list': [
    {
       'phone': '375291111111',
       'text': 'personal message 1'
    },
    {
       'phone': '375292222222',
       'text': 'personal message 2'
    } 
]
Для планирования рассылки вы можете указывать время рассылки через параметр schedule_time, в формате YYYY-MM-DDTHH:mm:ss

Особенностью отправки сообщения Viber является наличие трех вариантов: text, image или button.
Варианты заполнения приведены в образце api запроса.

Внимание!

Вариант image может быть использован только в рассылке с message_type = bulk.
В варианте button параметр button_link не должен превышать 150 символов.
Параметр image_url в вариантах button и image должен иметь ссылку на изображение, которое находится в открытом доступе.

Образец api запроса
{
  "token": "eyJpdiI6IjJzOFlFcXBmOUZEcGJlYzlzeFJValE9PSIsInZhbHV",
  "callback_url": "http://example-site.com/webhook.php",
  "messages": [
    {
      "alphaname_id": "444",
      "name": "mailing list 1",
      "message_type": "personal",
      "schedule_time": "2024-10-30T22:56:00",
      "content": {
        "type": "button",
        "image_url": "https://example-site.com/images/image.jpg",
        "caption": "Push me"
      },
      "delivery_list": [
        {
          "phone": "375291111111",
          "text": "personal message 1.1",
          "button_link": "https://example-site.com/some_action/1"
        },
        {
          "phone": "375292222222",
          "text": "personal message 1.2",
          "button_link": "https://example-site.com/some_action/2"
        }
      ]
    },
    {
      "alphaname_id": "444",
      "name": "mailing list 2",
      "message_type": "personal",
      "schedule_time": "2024-10-30T22:56:00",
      "content": {
        "type": "text"
      },
      "delivery_list": [
        {
          "phone": "375291111111",
          "text": "personal message 2.1"
        },
        {
          "phone": "375292222222",
          "text": "personal message 2.2"
        }
      ]
    },
    {
      "alphaname_id": "444",
      "name": "mailing list 3",
      "message_type": "bulk",
      "schedule_time": "2024-10-30T22:56:00",
      "content": {
        "type": "button",
        "image_url": "https://example-site.com/images/image.jpg",
        "button_link": "https://example-site.com/some_action",
        "caption": "Button",
        "text": "message text 3"
      },
      "delivery_list": [
        "375291111111",
        "375292222222"
      ]
    },
    {
      "alphaname_id": "444",
      "name": "mailing list 4",
      "message_type": "bulk",
      "schedule_time": "2024-10-30T22:56:00",
      "content": {
        "type": "text",
        "text": "message text 4"
      },
      "delivery_list": [
        "375291111111",
        "375292222222"
      ]
    },
    {
      "alphaname_id": "444",
      "name": "mailing list 5",
      "message_type": "bulk",
      "schedule_time": "2024-10-30T22:56:00",
      "content": {
        "type": "image",
        "image_url": "https://example-site.com/images/image.jpg"
      },
      "delivery_list": [
        "375291111111",
        "375292222222"
      ]
    }
  ]
}

Параметры

Параметр Расположение Тип Обязательный Описание
token query string Да Ваш API ключ
callback_url query string Нет URL, на который (если параметр задан) будет выслан ответ по работе метода в асинхронном режиме
messages query array Да Массив сообщения (Образец объекта в описании запроса)

Ответы

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

{
    "uuid": "cc9c8043-8caf-11ef-b035-9e8f47954dec",
    "success": "OK"
}

400 — Некорректный запрос

404 — Страница не найдена

429 — Превышен лимит запросов

500 — Сервер недоступен

POST /api/v1/statusBulkViber Получение статусов сообщений из рассылок, созданных методом sendBulkViber
URL запроса
POST https://app.sms.by/api/v1/statusBulkViber
Для получения информации о рассылках, созданных методом sendBulkViber, необходимо использовать поле uuid из ответа метода sendBulkViber (это UUID запроса). Метод statusBulkViber вернет расширенную информацию о статусах сообщений и ошибках, если таковые имеются

Параметры

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

Ответы

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

[
    {
        "message_id": 1,
        "name": "mailing list 1",
        "alphaname_id": 123,
        "success": [
            {
                "delivery_id": 1001,
                "phone": "375291111111",
                "status": "NEW",
                "status_time": "2024-10-16 22:52:42.497994"
            },
            {
                "delivery_id": 1002,
                "phone": "375292222222",
                "status": "NEW",
                "status_time": "2024-10-16 22:52:43.379779"
            }
        ]
    },
    {
        "message_id": 2,
        "name": "mailing list 2",
        "alphaname_id": 345,
        "success": [
            {
                "delivery_id": 1003,
                "phone": "375291111111",
                "status": "DELIVERED",
                "status_time": "2024-10-16 22:52:44.793377"
            },
            {
                "delivery_id": 1004,
                "phone": "375292222222",
                "status": "DELIVERED",
                "status_time": "2024-10-16 22:52:43.008560"
            }
        ]
    },
    {
        "errors": [
            "рассылка 3: Content url is not valid"
        ]
    },
    {
        "errors": [
            "рассылка 4: Optimal image size 800x800 px"
        ]
    }
]

400 — Некорректный запрос

404 — Страница не найдена

429 — Превышен лимит запросов

500 — Сервер недоступен

POST /api/v2/sendQuickViberMessage Отправка одиночного Viber сообщения (не требует предварительного создания)
URL запроса
POST https://app.sms.by/api/v2/sendQuickViberMessage

Параметры

Параметр Расположение Тип Обязательный Описание
token formData string Да Ваш API ключ
vibername_id formData integer Да ID Viber-имени из метода getVibernames
phone formData string Да Номер телефона для Viber-сообщения
type_message formData string Нет Тип сообщения: TEXT, IMAGE или BUTTON, по умолчанию = TEXT
message formData string Нет Текст Viber-сообщения (обязательный если type_message = TEXT)
image_url formData string Нет Передаваемая картинка (обязательный если type_message = IMAGE и image не передаётся). Передача картинки через image_url предпочтительней.
image formData file Нет Передаваемая картинка (обязательный если type_message = IMAGE и image_url не передаётся)
button formData string Нет Название кнопки (обязательный если type_message = BUTTON)
button_link formData string Нет Ссылка для перехода (обязательный если type_message = BUTTON)
forwarding_message formData integer Нет Включить переадресацию (1 - включить, 0 - не включать). Если в течение указанного времени отправленное сообщение не получит статус "Доставлено", оно будет отправлено как SMS
forwarding_time formData integer Нет Через сколько минут произойдёт переадресация, если она включена. По умолчанию 60 минут. Минимум 5 минут. Максимум 60 минут
alphaname_id formData integer Нет ID альфаимени, от которого придёт SMS при переадресации, если она включена

Ответы

200 — 

{
    "status": "OK",
    "result": {
        "message_id": 8484
    }
}
POST /api/v2/getViberDeliveryData Получение данных о сообщении отправленном методом sendQuickViberMessage
URL запроса
POST https://app.sms.by/api/v2/getViberDeliveryData

Параметры

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

Ответы

200 — 

{
    "status": "OK",
    "result": {
        "phone": "375293332211",
        "status": "READ",
        "error_code": 0
    }
}
POST /api/v2/sendViberMessageList Отправка Viber-сообщения выбранному списку рассылки
URL запроса
POST https://app.sms.by/api/v2/sendViberMessageList

Параметры

Параметр Расположение Тип Обязательный Описание
token formData string Да Ваш API ключ
name formData string Нет Название рассылки, если параметр не передан, название сформируется автоматически
vibername_id formData integer Да ID Viber-имени из метода getVibernames
list_id formData integer Да ID списка рассылки из метода getSubscriberLists
type_message formData string Нет Тип сообщения: TEXT, IMAGE или BUTTON, по умолчанию = TEXT
message formData string Нет Текст Viber-сообщения (обязательный если type_message = TEXT)
image_url formData string Нет Передаваемая картинка (обязательный если type_message = IMAGE и image не передаётся). Передача картинки через image_url предпочтительней.
image formData file Нет Передаваемая картинка (обязательный если type_message = IMAGE и image_url не передаётся)
button formData string Нет Название кнопки (обязательный если type_message = BUTTON)
button_link formData string Нет Ссылка для перехода (обязательный если type_message = BUTTON)
d_schedule formData string Нет Время отправки сообщения, указывается в формате 'ГГГГ-ММ-ДД ЧЧ:ММ'

Ответы

200 — 

{
    "status": "OK",
    "result": {
        "message_id": 4905,
        "count_subscribers": 4
    }
}
POST /api/v2/confirmViberMessage Подтвердить Viber-рассылку. С баланса будут списаны деньги.
URL запроса
POST https://app.sms.by/api/v2/confirmViberMessage

Параметры

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

Ответы

200 — 

{
    "status": "OK"
}
POST /api/v2/getViberMessages Получить список своих Viber-рассылок
URL запроса
POST https://app.sms.by/api/v2/getViberMessages

Параметры

Параметр Расположение Тип Обязательный Описание
token query string Да Ваш API ключ
limit_offset formData integer Нет Смещение выборки, по умолчанию 0
limit_rows formData integer Нет Количество элементов в выборке, по умолчанию 100

Ответы

200 — 

{
    "status": "OK",
    "result": [
        {
            "message_id": 8483,
            "message_type": "TEXT",
            "message": "Тестовое сообщение",
            "button_caption": "",
            "button_link": "",
            "image_file": "",
            "status": "SENT",
            "d_create": "2024-02-01 10:10:35",
            "d_schedule": "2024-02-01 10:10:35",
            "cost": "0.04900 EUR"
        },
        {
            "message_id": 8495,
            "message_type": "BUTTON",
            "message": "",
            "button_caption": "Перейти на сайт",
            "button_link": "https:\/\/site.by",
            "image_file": "",
            "status": "SENT",
            "d_create": "2024-02-02 09:30:00",
            "d_schedule": "2024-02-03 10:00:00",
            "cost": "0.04900 EUR"
        }
    ]
}
POST /api/v2/getViberMessageData Получить данные о Viber-рассылке
URL запроса
POST https://app.sms.by/api/v2/getViberMessageData

Параметры

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

Ответы

200 — 

{
    "status": "OK",
    "result": {
        "message_id": 8483,
        "message_type": "TEXT",
        "message": "Тестовое сообщение",
        "button_caption": "",
        "button_link": "",
        "image_file": "",
        "status": "SENT",
        "d_create": "2024-02-01 10:10:35",
        "d_schedule": "2024-02-01 10:10:35",
        "cost": "0.04900 EUR"
    }
}
POST /api/v2/getViberDeliveryList Получение списка телефонов по идентификатору Viber-рассылки
URL запроса
POST https://app.sms.by/api/v2/getViberDeliveryList

Параметры

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

Ответы

200 — 

{
    "status": "OK",
    "result": [
        {
            "delivery_id": 100,
            "phone": "375293332211",
            "status": "DELIVERED",
            "error_code": 0
        },
        {
            "delivery_id": 101,
            "phone": "375293332212",
            "status": "READ",
            "error_code": 0
        }
    ]
}
POST /api/v2/getNewIncomingMessages Просмотр входящих сообщений для Viber-рассылки
URL запроса
POST https://app.sms.by/api/v2/getNewIncomingMessages

Параметры

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

Ответы

200 — 

{
    "status": "OK",
    "result": [
        {
            "id": "1234",
            "phone": "375293332211",
            "message": "Ответ на полученное сообщение",
            "d_receiver": "2022-09-01 10:39:45"
        },
        {
            "id": "1236",
            "phone": "375293332212",
            "message": "Да",
            "d_receiver": "2022-09-01 11:29:50"
        }
    ]
}
POST /api/v2/readResponseStatus Пометить перечисленные входящие сообщения как прочитанные
URL запроса
POST https://app.sms.by/api/v2/readResponseStatus

Параметры

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

Ответы

200 — 

{
    "status": "OK",
    "result": "Количество помеченных сообщений: 3"
}

Сообщения Voice

5 методов

Методы

POST Создание голосовой рассылки —
GET Просмотр голосовой рассылки —
GET Просмотр голосовой рассылки по ID —
POST Создание параметризированной рассылки —
POST Подтверждение голосовой рассылки —
POST /api/v1/createVoiceMessage Создание голосовой рассылки
URL запроса
POST https://app.sms.by/api/v1/createVoiceMessage

Параметры

Параметр Расположение Тип Обязательный Описание
token formData string Да Ваш API ключ
voice_id formData string Да Укажите id аудиозаписи. Информация доступна в методе (getVoices)
name formData string Да Укажите имя рассылки
subscriber_list_id formData string Да Укажите ID список по которому произойдет рассылка. Можно посмотреть в методе (getSubscriberLists)
d_schedule formData string Да Планируемое время отправки в формате ГГГГ-ММ-ДД ЧЧ:ММ
key formData string Нет Ключевой тип для получения ответа. Может быть words или digits
word_answers formData string Нет Укажите ключевые слова через запятую. Обязателен, если key = words. Например да,нет
digit_answers formData string Нет Укажите ключевые цифры через запятую. Обязателен, если key = digits. Например 1,2,3

Ответы

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

{
    "status": "success",
    "data": {
        "voice_id": "10",
        "name": "375257077727",
        "subscriber_list_id": "6354",
        "d_schedule": "2025-01-01 00:00:00",
        "user_id": 2,
        "phone_numbers": 1,
        "status": "NEW",
        "type": "API",
        "ivrs": "[{\"keyWords\":\"да\"},{\"keyWords\":\"нет\"}]",
        "updated_at": "2021-10-08 11:56:39",
        "created_at": "2021-10-08 11:56:39",
        "id": 42
    }
}

400 — Некорректный запрос

404 — Страница не найдена

421 — Параметры не прошли валидацию

429 — Превышен лимит запросов

500 — Сервер недоступен

GET /api/v1/getVoiceMessages Просмотр голосовой рассылки
URL запроса
GET https://app.sms.by/api/v1/getVoiceMessages

Параметры

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

Ответы

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

{
    "status": "success",
    "data": {
        "total": 3,
        "per_page": 20,
        "current_page": 1,
        "last_page": 1,
        "next_page_url": null,
        "prev_page_url": null,
        "from": 1,
        "to": 3,
        "data": [
            {
                "id": 42,
                "user_id": 2,
                "name": "375257077727",
                "voice_id": 10,
                "status": "NEW",
                "ivrs": null,
                "phone_numbers": 1,
                "subscriber_list_id": 6354,
                "type": "API",
                "d_schedule": "2025-01-01 00:00:00",
                "created_at": "2021-03-24 09:48:34",
                "updated_at": "2021-03-24 09:48:34"
            }
        ]
    }
}

400 — Некорректный запрос

404 — Страница не найдена

421 — Параметры не прошли валидацию

429 — Превышен лимит запросов

500 — Сервер недоступен

GET /api/v1/getVoiceMessageById Просмотр голосовой рассылки по ID
URL запроса
GET https://app.sms.by/api/v1/getVoiceMessageById

Параметры

Параметр Расположение Тип Обязательный Описание
token query string Да Ваш API ключ
voice_message_id query integer Да Укажите Id голосовой рассылки, Можно посмотреть в методе (getVoiceMessage)
voice_delivery_list query boolean Нет Для получения дополнительной информации по номерам, укажите (bool) true

Ответы

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

{
    "status": "success",
    "data": {
        "id": 21,
        "user_id": 2,
        "name": "Voice Message",
        "voice_id": 5,
        "status": "SENT",
        "ivrs": "да|нет|Наверно",
        "phone_numbers": 1,
        "subscriber_list_id": 6354,
        "type": "API",
        "d_schedule": "3020-12-18 15:46:00",
        "created_at": "2020-12-18 15:46:37",
        "updated_at": "2020-12-18 15:52:15",
        "delivery_list": [
            {
                "id": 101735,
                "user_id": 2,
                "message_id": 21,
                "phone": "375257077727",
                "status": "DELIVERED",
                "d_sent": "2020-12-21 10:34:42",
                "d_delivered": "2020-12-21 10:34:42",
                "ivr_digit": null,
                "ivr_answers": null,
                "to_block": null,
                "record_file_path": null,
                "created_at": "2020-12-18 12:47:54",
                "updated_at": "2020-12-18 12:47:54"
            }
        ]
    }
}

400 — Некорректный запрос

404 — Страница не найдена

421 — Параметры не прошли валидацию

429 — Превышен лимит запросов

500 — Сервер недоступен

POST /api/v1/createVoiceMessageByParams Создание параметризированной рассылки
URL запроса
POST https://app.sms.by/api/v1/createVoiceMessageByParams

Параметры

Параметр Расположение Тип Обязательный Описание
token formData string Да Ваш API ключ
name formData string Да Имя рассылки
subscriber_list_id formData string Да ID Списка конактов
d_schedule formData string Да Планируемое время отправки в формате ГГГГ-ММ-ДД ЧЧ:ММ
text_to_voice formData string Да Введите текст, для конвертирования в голосовое сообщение
gender formData string Да Голос озвучки (0 - Женский, 1 - Мужской)

Ответы

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

{
    "status": "success",
    "data": {
        "name": "Voice",
        "subscriber_list_id": "7808",
        "d_schedule": "2021-04-06 13:55:00",
        "text_to_voice": "Голосовое сообщение",
        "gender": "0",
        "params": 1,
        "user_id": 2,
        "phone_numbers": 1,
        "status": "NEW",
        "type": "API",
        "updated_at": "2021-04-06 17:28:03",
        "created_at": "2021-04-06 17:28:03",
        "id": 25
    }
}

400 — Некорректный запрос

421 — Данные не прошли проверку

500 — Сервер недоступен

POST /api/v1/confirmVoiceMessage Подтверждение голосовой рассылки
URL запроса
POST https://app.sms.by/api/v1/confirmVoiceMessage

Параметры

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

Ответы

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

{
    "status": "success",
    "message": "Рассылка подтверждена, отправка произойдет в указанное время"
}

400 — Некорректный запрос

421 — Данные не прошли проверку

500 — Сервер недоступен

Списки рассылок

3 метода

Методы

POST Создание нового списка рассылки —
POST Импорт контактов в список рассылки За один вызов можно импортировать не более 500 контактов и количество пользовательских полей не должно превышать 30. В пользовательских полях обязательно должно присутствовать phone или email. Если в …
POST Получение списков рассылки —
POST /api/v2/createSubscriberList Создание нового списка рассылки
URL запроса
POST https://app.sms.by/api/v2/createSubscriberList

Параметры

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

Ответы

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

{
    "status": "OK",
    "result": {
        "list_id": 3434
    }
}
POST /api/v2/importContacts Импорт контактов в список рассылки
URL запроса
POST https://app.sms.by/api/v2/importContacts
За один вызов можно импортировать не более 500 контактов и количество пользовательских полей не должно превышать 30. В пользовательских полях обязательно должно присутствовать phone или email.
Если в списке уже есть контакт с передаваемым номером телефона или email-адресом, такой контакт не будет добавлен повторно, но обновятся его параметры, которые переданы в field_names.

Для примера добавим в список рассылки 2 контакта с пользовательскими полями phone, email и name. Запрос будет выглядеть так:
https://app.sms.by/api/v2/importContacts?token=***&list_id=123&field_names[0]=phone&field_names[1]=email&field_names[2]=name&data[0][0]=375291111111&data[0][1]=email1@example.by&data[0][2]=Алексей&data[1][0]=375291111112&data[1][1]=email2@example.by&data[1][2]=Ирина

В ответе в поле result метод возвратит массив со следующими данными:
inserted - сколько новых контактов было добавлено в список,
updated - сколько контактов было изменено,
invalid - сколько контактов не было импортировано,
log - ошибки и предупреждения импорта. Если количество invalid больше 0, будет содержать массив со следующими данными: index - номер контакта в массиве data, error_message - описание ошибки.

Параметры

Параметр Расположение Тип Обязательный Описание
token query string Да Ваш API ключ
list_id query integer Да ID списка рассылки
field_names[0] query string Да Название первого пользовательского поля
field_names[1] query string Нет Название второго пользовательского поля
field_names[2] query string Нет Название третьего пользовательского поля
data[0][0] query string Да Первый параметр для первого контакта
data[0][1] query string Нет Второй параметр для первого контакта
data[0][2] query string Нет Третий параметр для первого контакта
data[1][0] query string Нет Первый параметр для второго контакта
data[1][1] query string Нет Второй параметр для второго контакта
data[1][2] query string Нет Третий параметр для второго контакта

Ответы

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

{
    "status": "OK",
    "result": {
        "inserted": 10,
        "updated": 5,
        "invalid": 1,
        "log": [
            {
                "index": 13,
                "error_message": "Некорректный номер телефона"
            }
        ]
    }
}
POST /api/v2/getSubscriberLists Получение списков рассылки
URL запроса
POST https://app.sms.by/api/v2/getSubscriberLists

Параметры

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

Ответы

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

{
    "status": "OK",
    "result": [
        {
            "list_id": 3434,
            "name": "Список №1",
            "params": "PHONE, EMAIL"
        },
        {
            "list_id": 3440,
            "name": "Список №2",
            "params": "PHONE, EMAIL, NAME"
        }
    ]
}

Счета

3 метода

Методы

GET Получить все созданные счета —
POST Создание счета —
GET Скачать счет —
GET /api/v1/getBills Получить все созданные счета
URL запроса
GET https://app.sms.by/api/v1/getBills

Параметры

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

Ответы

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

{
    "status": "success",
    "data": {
        "total": 160,
        "per_page": 15,
        "current_page": 1,
        "last_page": 11,
        "next_page_url": "https:\/\/app.sms.by\/api\/v1\/getBills?page=1",
        "prev_page_url": null,
        "from": 1,
        "to": 15,
        "data": [
            {
                "id": 1449,
                "user_id": 2,
                "d_create": "1526034626",
                "d_payment": 0,
                "amount": "120.00",
                "manager_id": 0,
                "comment": "Пополнение счета на 120 рублей",
                "info": "0",
                "type": "SMS",
                "rent": "0",
                "number": "C11449\/20180511"
            }
        ]
    }
}

400 — Некорректный запрос

404 — Страница не найдена

429 — Превышен лимит запросов

500 — Сервер недоступен

POST /api/v1/createBill Создание счета
URL запроса
POST https://app.sms.by/api/v1/createBill

Параметры

Параметр Расположение Тип Обязательный Описание
token formData string Да Ваш API ключ
amount formData integer Да Сумма пополненния баланса
amount_type formData string Да Тип баланса. Может быть sms или viber
type formData string Нет Тип пополнения баланса (для Viber баланса обязательно). Может быть 'subscription' или 'replenishment'

Ответы

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

{
    "status": "success",
    "data": {
        "user_id": 2,
        "amount": "500",
        "d_create": "1616510192",
        "d_payment": 0,
        "manager_id": 0,
        "info": 0,
        "type": "sms",
        "rent": 0,
        "comment": "Пополнение SMS счета на 500 руб.",
        "id": 3294,
        "number": "C13294\/20210323"
    }
}

400 — Некорректный запрос

421 — Данные прошли проветку

429 — Превышен лимит запросов

500 — Сервер недоступен

GET /api/v1/downloadBill Скачать счет
URL запроса
GET https://app.sms.by/api/v1/downloadBill

Параметры

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

Ответы

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

400 — Некорректный запрос

404 — Страница не найдена

429 — Превышен лимит запросов

500 — Сервер недоступен

Финансовая статистика

2 метода

Методы

GET Получить остаток на балансе —
GET Финансовая статистика —
GET /api/v1/getBalance Получить остаток на балансе
URL запроса
GET https://app.sms.by/api/v1/getBalance

Параметры

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

Ответы

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

{
    "status": "OK",
    "currency": "EUR",
    "result": [
        {
            "balance": "2.86600",
            "viber_balance": "0.00000"
        }
    ]
}

400 — Некорректный запрос

404 — Страница не найдена

429 — Превышен лимит запросов

500 — Сервер недоступен

GET /api/v1/financialStatistics Финансовая статистика
URL запроса
GET https://app.sms.by/api/v1/financialStatistics

Параметры

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

Ответы

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

{
    "status": "success",
    "data": {
        "total": 367,
        "per_page": 15,
        "current_page": 1,
        "last_page": 25,
        "next_page_url": "https:\/\/localhost\/api\/v1\/financialStatistics?page=2",
        "prev_page_url": null,
        "from": 1,
        "to": 15,
        "data": [
            {
                "id": 393365,
                "user_id": 2,
                "balance": "-14.75838",
                "d_create": 1616407657,
                "d_update": 0,
                "comment": "[Списание] - [Беларусь, Life, 375257077727] количество частей: 1, стоимость за 1 часть: 14.75838",
                "manager_id": 2
            }
        ]
    }
}

400 — Некорректный запрос

404 — Страница не найдена

429 — Превышен лимит запросов

500 — Сервер недоступен