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

Получение списка отправленных адресату сообщений (GET/POST)

Обновлено: 10 ноября 2026

Метод возвращает список отправленных адресату сообщений в хронологическом порядке, начиная с новых. Адресат задается либо идентификатором клиента (параметр clientId), либо номером абонента (параметр address). Возвращаются только те сообщения, которые были отправлены шлюзом в канал оператора.

warning

Сообщения, ожидающие отправки или не отправленные по причине ошибки, в список не включаются.

Возможно выполнение как GET-, так и POST-запросов. Параметры POST-запроса передаются в формате JSON или XML. В случае GET-запроса данные возвращаются в формате JSON.

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

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

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

к сведению

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

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

подсказка

Если запрос выполняется в формате XML, параметры помещаются в структуру query.

ПараметрТип данныхХарактерОписание
clientIdStringНеобязательный, если указан addressИдентификатор клиента, которому были отправлены сообщения
addressStringНеобязательный, если указан clientIdНомер абонента, которому были отправлены сообщения
messageTypeStringНеобязательныйОдин из зарегистрированных типов сообщений.

Если параметр задан — в ответ на запрос вернется список сообщений только указанного типа
offset StringНеобязательныйКоличество сообщений, которые необходимо пропустить, начиная с наиболее новых. По умолчанию — 0.

Например, если offset = 10, то десять последних отправленных сообщений (т. е. самых новых) будут пропущены, и выборка начнется с одиннадцатого сообщения
countStringНеобязательныйМаксимальное количество записей в ответе. По умолчанию — 20
channelStringНеобязательныйФильтр по каналу отправки сообщения. Возможные значения:

- sms — SMS-сообщения;

- push — Push-сообщения;

- im — сообщения в мессенджерах.

По умолчанию возвращаются сообщения из всех каналов
dateFromDateTimeНеобязательныйДата начала запрашиваемого периода (самого старого сообщения). По умолчанию — 1 января 2010 года
dateToDateTimeНеобязательныйДата конца запрашиваемого периода. По умолчанию — текущее время плюс один год

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

ПараметрТип данныхХарактерОписание
internalIdStringОбязательныйИдентификатор сообщения в edna Prisma
externalIdStringНеобязательныйИдентификатор сообщения во внешней системе
sentAtStringОбязательныйВремя отправки сообщения.

В JSON указывается как число миллисекунд, прошедших с 0 часов 1 января 1970 года (как UNIX time, только не в секундах, а миллисекундах).

В XML указывается в системе UTC. Пример: 2026-03-10T15:56:25+03:00
channelStringОбязательныйКод канала отправки
statusStringОбязательныйСтатус обработки сообщения
sourceCodeStringОбязательныйКод внешней системы
typeCodeStringОбязательныйКод типа сообщения
textStringОбязательныйТекст сообщения

Статусы обработки сообщений​

СтатусОписание
enqueuedСообщение в очереди в edna Prisma
declinedСообщение отклонено в edna Prisma — сработал фильтр
rejectedСообщение отклонено оператором
failedОшибка отправки сообщения в edna Prisma
sentСообщение отправлено
cancelledСообщение отменено на платформе или в edna Prisma
delayed Сообщение отложено на платформе
delivered Сообщение доставлено
undeliveredСообщение не доставлено
readСообщение прочитано. Статус возвращается не всеми мессенджерами
unknownСтатус сообщения неизвестен — ошибка на платформе

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

Пример GET-запроса​

http://gate.example.com:8282/history?clientId=111&address=79161234567& messageType=OTP&offset=0&count=10&channel=sms&dateFrom=2017-11- 01T17:00:00+03:00&dateTo=2017-11-02T23:00:00+03:00

Пример ответа на GET-запрос​

{
"history":[
{
"records":{
"internalId":"405239484993707534",
"sentAt":"1511524466478",
"channel":"sms",
"status":"sent",
"sourceCode":"lotus",
"typeCode":"marketing",
"text":"kupi slona"
},
{
"internalId":"405239484993707535",
"externalId":"100500",
"sentAt":"1511524466478",
"channel":"push",
"status":"delivered",
"sourceCode":"WS",
"typeCode":"OTP",
"text":"Your password is 1234"
}
]
}
}

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

<query>
<clientid>111</clientid>
<address>79161234567</address>
<messagetype>OTP</messagetype>
<offset>0</offset>
<datefrom>2017-10-01T17:00:00+03:00</datefrom>
<dateto>2022-11-02T23:00:00+03:00</dateto>
<count>10</count>
<channel>sms</channel>
</query>

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

<history>
<records>
<internalid>405239484993707534</internalid>
<sentat>2017-11-02T17:58:42+03:00</sentat>
<channel>sms</channel>
<status>sent</status>
<sourcecode>lotus</sourcecode>
<typecode>marketing</typecode>
<text>kupi slona!</text>
</records>
<records>
<internalid>405239484993707535</internalid>
<externalid>100500</externalid>
<sentat>2017-11-02T17:58:42+03:00</sentat>
<channel>push</channel>
<status>delivered</status>
<sourcecode>WS</sourcecode>
<typecode>OTP</typecode>
<text>Your password is 1234</text>
</records>
</history>

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

{
"clientId": "10",
"offset": "0",
"address": "79161234567",
"messageType": "OTP",
"count": "10",
"channel": "sms",
"dateFrom": "2017-10-01T17:00:00+03:00",
"dateTo": "2022-11-02T23:00:00+03:00"
}

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

{
"history": {
"records": {
"internalId": "405239484993707534",
"sentAt": "1511524466478",
"channel": "sms",
"status": "sent",
"sourceCode": "lotus",
"typeCode": "marketing",
"text": "kupi slona"
}
}
}