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

API веб-сервиса отправки сообщений

Обновлено: 1 октября 2025

API предоставляет методы для отправки сообщений в универсальный шлюз edna Prisma и получения статуса их доставки.

Описание API​

API представляет собой SOAP-веб-сервис, поддерживающий запросы и ответы в формате WSDL.

Поддерживаются следующие методы:

  • consumeOutMessage — отправка сообщений шлюзу для дальнейшей доставки адресату;
  • getOutMessage — получение информации об отправленных сообщениях;
  • getOutMessageDlvStatus — получение статуса доставки сообщений.

Запросы к API и получаемые в ответ данные представляют собой SOAP-конверты — XML-файлы определённой структуры. Параметры запросов передаются в виде тегов в теле XML-документа (<soapenv:Body>). Ответ на запрос также представляет собой SOAP-конверт.

Авторизация​

Каждый запрос содержит группу параметров, объединённых тегом auth, — параметры авторизации пользователя:

  • login — имя учетной записи пользователя;
  • password — пароль пользователя.
к сведению

Логин и пароль пользователя выдаются компанией edna.

Обработка ошибок​

В случае невозможности выполнить запрос возвращается WSDL-документ с элементом OutMessageServiceFaultCode, содержащим параметр faultCode с кодом ошибки.

Возможные значения кода ошибки:

  • error-system — внутренняя ошибка при обработке сообщения;
  • error-auth — ошибка авторизации (неверно указаны логин или пароль);
  • error-syntax — ошибка в синтаксисе запроса.
warning

Ошибки могут возникать также в процессе выполнения самого запроса или обработки сообщения шлюзом. В этом случае код ошибки возвращается в теле ответа.

Методы API​

File IconОтправка сообщений File IconПолучение информации об отправленных сообщениях File IconПолучение статуса доставки сообщений