Отправка сообщений в канал SMS

Обновлено: 27 октября 2026

Для отправки сообщений в канал SMS используется метод api/v1/out-messages/sms.

Вызов метода

Чтобы отправить сообщение в канал SMS по методу api/v1/out-messages/sms, отправьте POST-запрос на URL-адрес https://app.edna.by/api/v1/out-messages/sms.

Примеры запросов

Сообщение с минимальным набором параметров

{
  "sender": "sms_test",
  "phone": "+375299000000",
  "content": "Добрый день! Используйте наши новые методы API для отправки сообщений."
}

Сообщение с отложенной отправкой

{
  "sender": "sms_test",
  "phone": "+375299000000",
  "content": "Добрый день! Используйте наши новые методы API для отправки сообщений.",
  "options": {
    "sendDelay": "PT30M"
  }
} 

Сообщение с максимальным набором параметров

{
  "outMessageId": "0198adb2-74ee-7583-894b-fd2aa8fff639",
  "sender": "sms_test",
  "phone": "+375299000000",
  "content": "Добрый день! Используйте наши новые методы API для отправки сообщений.",
  "options": {
    "comment": "Комментарий к сообщению: промо-рассылка",
    "priority": "NORMAL",
    "sendDelay": "PT30M"
  }
} 

Параметры запроса

Параметр	Тип данных	Характер	Описание
outMessageId	string	Необязательный	Внутренний идентификатор исходящего сообщения. Генерируется внешней системой клиента или edna Pulse при отправке сообщения. Максимальная длина строки — 256 символов.
sender	string	Обязательный	Название канала. Чтобы узнать название канала, используйте метод API для получения списка каналов — параметр subject. Получение списка каналов
phone	string	Обязательный	Адрес получателя — номер телефона в соответствии с форматом стандарта E.164. Паттерн стандарта: ^+[1-9]\d{1,14}$. Международный телекоммуникационный план нумерации E.164 Чтобы узнать адрес получателя, используйте метод API для запроса данных получателей — параметр addresses.address. Запрос данных получателей
content	string	Обязательный	Текст сообщения. Может содержать эмодзи. Максимальная длина — 4096 символов. Специальные символы не допускаются, кроме: - \n — перевод строки: последующий текст начинается с новой строки; - \t — табуляция; - \r — возврат каретки в начало строки.
options	object	Необязательный	Объект с информацией о дополнительных параметрах настройки сообщения.
options.sendDelay	string	Необязательный	Период времени в формате ISO 8601 (например, PT10H15M48S), раньше которого сообщение не будет отправлено. Используется при отложенной отправке. Допустимое значение — не более 2 недель. ISO 8601 - Durations
options.comment	string	Необязательный	Любой комментарий к сообщению. Максимальная длина — 256 символов. Не отображается на устройстве получателя. Отображается в отчёте по сообщениям в личном кабинете и в ответе метода API для получения истории сообщений — параметр comment. Получение истории сообщений
options.priority	string	Необязательный	Приоритет сообщения. Возможные значения: - LOW — низкий приоритет; - NORMAL — средний приоритет; - HIGH — высокий приоритет; - REALTIME — доставка в режиме реального времени.

Формат ответа

{
    "outMessageId": "string",
    "phone": "string"
} 

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

{
    "outMessageId": "0198adb2-74ee-7583-894b-fd2aa8fff639",
    "phone": "+375299000000"
}

Параметры ответа

Параметр	Тип данных	Описание
outMessageId	string	Внутренний идентификатор исходящего сообщения. Был сгенерирован внешней системой клиента или edna Pulse при отправке сообщения.
phone	string	Адрес получателя — номер телефона в соответствии с форматом стандарта E.164. Паттерн стандарта: ^+[1-9]\d{1,14}$. Международный телекоммуникационный план нумерации E.164