Сообщения SMS

Методы

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 — Сервер недоступен