Перейти к основному содержимому

Отправка сообщений (POST)

Обновлено: 10 августа 2026

В результате выполнения POST-запроса сообщение передаётся в edna Prisma для доставки адресату. В ответе возвращается идентификатор сообщения и статус обработки запроса.

Тип сообщения определяет параметр type. Для каждого типа задан способ доставки (например, SMS, Push) и шаблон сообщения.

к сведению

Push-сообщение отправляется, если известен активный deviceId (идентификатор устройства в облаке провайдера), связанный с номером телефона адресата. В противном случае будет отправлено SMS-сообщение.

URL-адрес подключения​

POST-запрос выполняется на URL-адрес следующего вида:

http://gate.example.com/port/send, где gate.example.com — адрес edna Prisma; port — номер порта для подключения к edna Prisma. Для облачной версии значение задается в настройках компонента и выбирается из диапазона 8081–8088.

к сведению

Если шлюз эксплуатируется в закрытом контуре, то вид URL зависит от способа развертывания. Например, при использовании Docker адрес будет иметь следующую структуру: https://gate.example.com:port/...

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

В теле запроса передаются параметры отправляемого сообщения. В XML они должны быть вложены в структуру message.

ПараметрТип данныхХарактерОписание
idStringНеобязательныйВнешний идентификатор сообщения. Если параметр не определен в запросе — система присвоит ему собственное значение
addressStringНеобязательныйНомер абонента
textStringОбязательныйТекст сообщения
subjectStringНеобязательныйПодпись сообщения
priorityStringНеобязательныйПриоритет сообщения, влияющий на скорость отправки:

- realtime — доставка в режиме реального времени;

- high — высокий приоритет;

- normal — средний приоритет;

- low — низкий приоритет
typeStringНеобязательныйТип сообщения, заданный в веб-интерфейсе шлюза. Поддерживается работа со всеми каналами, настроенными в edna Prisma: SMS (в т.ч. FreeSMS), PUSH (обычные, Web PUSH и голосовые PUSH), мессенджеры (Telegram, Whatsapp, Viber, VK_Notify, PUSH-уведомления в приложение Т-Банка и другие), Flashcall
tagStringНеобязательныйМетка ступени каскада, которая может задаваться для управления маршрутизацией. Поддерживается только при отправке сообщений через API
clientIdStringНеобязательныйИдентификатор клиента
channelStringНеобязательныйКод канала отправки
sourceStringНеобязательныйКод системы-источника
commentStringНеобязательныйКомментарий к сообщению. Отображается в детальном отчёте
encryptedBooleanНеобязательныйФлаг шифрования текста сообщения в БД
startTimeStringНеобязательныйВремя начала отправки в формате 2026-04-25T18:30:00
stopTimeStringНеобязательныйВремя завершения отправки. Формат — 2026-04-26T18:30:00
optionArray of objectsНеобязательныйМассив пар «ключ-значение» для атрибутов push-сообщений
metadataArray of objectsНеобязательныйМассив пар «ключ-значение» для метаданных сообщения
parameterArray of objectsНеобязательныйМассив пар «ключ-значение» для переменных в тексте сообщения.

Например: parameter":[ {"key":"shortPush","value":"testValue1"}, {"key":"fullPush" "value":"testValue2"} ]

Ключи должны быть заданы в шаблоне типа сообщения, определенного параметром type. Шаблоны настраиваются в веб-интерфейсе шлюза.

Для приведённого выше примера, если задан шаблон «Это тестовое сообщение типа shortPush», то адресату будет доставлено сообщение «Это тестовое сообщение типа testValue1»
instantMessagesArrayНеобязательныйМассив параметров сообщений в мессенджеры (IM-каналы). Вложенные параметры: DeliveryMethodKind, contentType, content, destination, subject
deliveryMethodKindStringНеобязательныйИдентификатор IM-канала:

- TELEGRAM;

- TELEGRAM_OTP;

- WHATSAPP;

- VIBER;

- VIBER_BOT;

- VK_PAGES;

- VK_NOTIFY;

- IMESSAGE;

- ROCKET_CHAT;

- EXPRESS;

- T_BANK
contentTypeStringНеобязательныйТип содержимого:

- text — текстовое сообщение;

- image — изображение;

- document — файл поддерживаемого мессенджером формата;

- audio — аудиофайл;

- voice — голосовое сообщение;

- video — видеофайл;

- button — кнопка-ссылка;

- location — данные геолокации;

- product — информация о продукте из каталога;

- product_list — информация о нескольких продуктах из каталога;

- list_picker — интерактивный список;

- authentication — одноразовый пароль.

Тип содержимого должен быть согласован с возможностями мессенджера
contentObjectНеобязательныйОбъект с содержимым сообщения — пары «ключ-значение». Ключи определяются типом содержимого
destinationStringНеобязательныйИдентификатор получателя — номер телефона или идентификатор в мессенджере
subjectStringНеобязательныйПодпись отправителя

Пример запроса в формате XML​

<message>
<id>12345</id>
<address>79161112222</address>
<subject>BANK</subject>
<text>test password 1234</text>
<priority>high</priority>
<source>http</source>
<tag>promo</tag>
<type>default</type>
<channel>sms</channel>
<clientId>333</clientId>
<encrypted>false</encrypted>
<comment>test-comment</comment>
<startTime>2026-03-10T12:56:25+03:00</startTime>
<stopTime>2026-03-10T15:56:25+03:00</stopTime>
<option>
<key>retryCount</key>
<value>3</value>
</option>
<metadata>
<key>campaignId</key>
<value>cmp-789</value>
</metadata>
<parameter>
<key>shortPush</key>
<value>value1</value>
</parameter>
<instantMessages>
<deliveryMethodKind>WHATSAPP</deliveryMethodKind>
<contentType>text</contentType>
<content>
<text>shortPush</text>
<button>Open</button>
</content>
<destination>791600000000</destination>
<subject>bot_name1</subject>
</instantMessages>
</message>

Пример запроса в формате JSON​

{
"id": "1234",
"address": "79160000000",
"subject": "subj1",
"text": "Hello, this is a test message",
"priority": "HIGH",
"type": "msg-type1",
"tag": "promo",
"clientId": "client-001",
"channel": "sms",
"source": "system",
"comment": "Optional comment",
"startTime": "2026-03-10T12:56:25+03:00",
"stopTime": "2026-03-10T15:56:25+03:00",
"encrypted": false,
"option": [
{
"key": "retryCount",
"value": "3"
}
],
"metadata": [
{
"key": "campaignId",
"value": "cmp-789"
}
],
"parameter": [
{
"key": "username",
"value": "Denis"
}
],
"instantMessages": [
{
"deliveryMethodKind": "WHATSAPP",
"contentType": "text",
"content": {
"text": "Hello from IM",
"button": "Open"
},
"destination": "791600000000",
"subject": "bot_name1"
},
{
"deliveryMethodKind": "TELEGRAM",
"contentType": "text",
"content": {
"text": "Hello from IM",
"button": "Open"
},
"destination": "4352352",
"subject": "bot_name2"
}
]
}

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

Ответ содержит идентификатор сообщения, переданный в запросе или присвоенный системой, и статус обработки запроса. Если запрос обработан с ошибкой, то в параметре detail передаётся описание её причины.

ПараметрТип данныхХарактерОписание
idStringОбязательныйИдентификатор сообщения. Если параметр не был определен в запросе — система возвращает присвоенное значение
statusStringОбязательныйСтатус обработки запроса. Возможные значения:

- ok — запрос обработан успешно;

- error-validation — отсутствуют необходимые параметры в запросе;

- error-duplicate-id — попытка отправки дубликата сообщения (неуникальное значение id);

- error-address — неверный формат номера телефона;

- error-subject — неверный формат подписи;

- error-template — ошибка форматирования текста сообщения;

- error-invalid-json — ошибка в теле JSON-запроса;

- error-invalid-xml — ошибка в теле XML-запроса
detailStringНеобязательныйОписание причины ошибки обработки запроса

Примеры ответов​

Пример ответа на корректный запрос в формате XML​

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reply>
<id>12345</id>
<status>OK</status>
</reply>

Пример сообщения об ошибке в ответ на запрос в формате XML​

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reply>
<id>12345</id>
<status>error-duplicate-id</status>
<detail>duplicate external ids: [12345]</detail>
</reply>

Пример ответа на корректный запрос в формате JSON​

{
"id": "12345",
"status": "OK"
}

Пример сообщения об ошибке в ответ на запрос в формате JSON​

{
"id": "12345",
"status": "error-duplicate-id",
"detail": "duplicate external ids: [123458]"
}