GetList

Метод GetList

Примените метод GetList, чтобы получить информацию об исходящих и входящих сообщениях по заданным параметрам.

Точка подключения: Выполните POST-запрос с входными параметрами к точке подключения:

POST: https://api.exolve.ru/messaging/v1/GetList

Авторизация

Передайте следующие Заголовки HTTP для успешной авторизации.

ИмяТипОписание
AuthorizationstringAPI-ключ приложения с Bearer перед ним. Пример: Bearer e***s0, где e***s0 замените на API-ключ вашего приложения

Входные параметры

Передайте следующие параметры в теле запроса в JSON-формате. Можно передать пустой запрос — тогда вы получите информацию обо всех SMS этого приложения без применения фильтров поиска.

ПараметрТипОписание
message_idint64идентификатор сообщения (указывается, если нужна информация по одному сообщению)
limituint32лимит выводимых строк, по умолчанию — 100, максимальное значение — 2 000
offsetuint64номер строки, с которой начинать выборку (начинается с 0)
numberstringномер телефона / имя отправителя
directionenum Directionнаправление сообщения
delivery_statusenum DeliveryStatusстатус доставки сообщения
billing_statusenum BillingStatusстатус оплаты сообщения
statusenum Status(объединяет в себе доставку и оплату)
channelenum Channelканал отправки сообщения
date_gtestringдата последнего изменения статуса сообщения в формате RFC-3339 / ISO-8601, с которой начинать выборку сообщений
date_ltestringдата последнего изменения статуса сообщения в формате RFC-3339 / ISO-8601, до которой продолжать выборку сообщений
date_sent_received_gtestringдата отправки исходящего/получения входящего сообщения в формате RFC-3339 / ISO-8601, с которой начинать выборку сообщений
date_sent_received_ltestringдата отправки исходящего/получения входящего сообщения в формате RFC-3339 / ISO-8601, до которой продолжать выборку сообщений
receiverstringномер получателя
senderstringномер отправителя / имя отправителя
receiver_mccstringMCC-код оператора получателя, формат: 250
receiver_mncstringMNC-код оператора получателя, формат: 42
receiver_mobile_operatorstringоператор получателя, формат: MTT
categoryenum CategoryTypeкатегория сообщения, подробнее
sortenum SortOrderсортировка по дате отправки сообщения или по количеству сегментов (можно применить только один тип сортировки)
campaign_idstringидентификатор рассылки, в рамках которой было отправлено сообщение
campaign_namestringназвание рассылки, в рамках которой было отправлено сообщение
price_gtefloatстоимость сообщения, с которой начинать выборку сообщений
price_ltefloatстоимость сообщения, до которой продолжать выборку сообщений

MCC/MNC коды оператора

  • MCC (Mobile Country Code) — код страны, в которой находится оператор мобильной связи. Состоит из 3 цифр.
  • MNC (Mobile Network Code) — код мобильной сети (оператора), следует после MCC. Состоит из 2 или 3 цифр, уникален для каждого оператора он уникален.

Комбинация MCC + MNC + наименование оператора позволяет однозначно определить сеть. Эти коды унифицированы — вы можете воспользоваться любым справочником, чтобы найти нужный код.


Channel

ПараметрТипОписание
1enumSMS
4enumTelegram Verify
5enumУмная проверка номеров (УПН) → SMS, подробнее

CategoryType

ПараметрТипОписание
0enumкатегория не указана
1enumSMS с мобильного номера
2enumрекламное SMS от имени отправителя
3enumавторизационное SMS от имени отправителя
4enumсервисное SMS от имени отправителя
5enumтранзакционное SMS от имени отправителя

SortOrder

ПараметрТипОписание
order_by_dateArray OrderByDateсортировка по дате отправки
order_by_segments_countArray OrderBySegmentsCountсортировка по количеству сегментов в сообщении

OrderByDate/OrderBySegmentsCount

ПараметрТипОписание
1enumascending order (по возрастанию)
2enumdescending order (по убыванию) — по умолчанию для даты

Выходные параметры

ПараметрТипОписание
messagesJSON Arrayсписок сообщений
message_idint64идентификатор сообщения
application_uuidstringидентификатор приложения, с / на номер которого отправляли / получали сообщения
datestringдата и время последнего изменения статуса сообщения в формате RFC-3339 / ISO-8601
date_sent_receivedstringдата и время отправки исходящего/получения входящего сообщения в формате RFC-3339 / ISO-8601
numberstringномер телефона / имя отправителя
senderstringномер отправителя / имя отправителя
receiverstringномер получателя
textstringтекст сообщения
directionenum Directionнаправление сообщения
segments_countuint32количество сегментов в сообщении
billing_statusenum BillingStatusстатус оплаты сообщения
delivery_statusenum DeliveryStatusстатус доставки сообщения
statusenum Statusобщий статус, объединяет в себе статус доставки и оплаты сообщения
channelenum Channelканал, в котором отправлено / получено сообщение
categoryenum CategoryTypeкатегория сообщения, подробнее
sender_mobile_operatorstringоператор отправителя сообщения, формат: MTT
sender_mccstringMCC-код оператора отправителя сообщения, формат: 250
sender_mncstringMNC-код оператора отправителя сообщения, формат 42
receiver_mobile_operatorstringоператор получателя сообщения, формат: MTT
receiver_mccstringMCC-код оператора получателя сообщения, формат: 250
receiver_mncstringMNC-код оператора получателя сообщения, формат: 42
campaign_idstringидентификатор рассылки, в рамках которой было отправлено SMS
campaign_namestringназвание рассылки, в рамках которой было отправлено SMS
pricefloatстоимость сообщения, обновляется в течение часа с момента отправки сообщения. Присутствует только для СМС-сообщений, отправленных от имени отправителя
activity_scorestringдля УПН → SMS (channel=5), переданный порог активности номера получателя от 0 до 1
activity_resultstringдля УПН → SMS (channel=5), полученная оценка активности в сети номера получателя

Direction

ПараметрТипОписание
1enumвходящее сообщение
2enumисходящее сообщение

BillingStatus

ПараметрТипОписание
0enumнеизвестный статус оплаты
1, 9enumсообщение поставлено в очередь на обработку и оплату
2, 10enumсообщение оплачено
4enumнедостаточно средств на балансе для отправки сообщения
6enumошибка оплаты сообщения
7enumплата за сообщение зарезервирована
8enumошибка — закончились попытки оплаты сообщения

DeliveryStatus

ПараметрТипОписание
0enumнеизвестный статус доставки
1enumсообщение поставлено в очередь на отправку
2enumсообщение доставлено в SMS-центр
3enumсообщение доставлено получателю
4enumсообщение не может быть доставлено получателю
5enumошибка — закончились попытки переотправки сообщения
6enumприём и отправка сообщений заблокированы

Status

ПараметрТипОписание
1enumсообщение в очереди на отправку
2enumсообщение отправлено
3enumсообщение доставлено
4enumсообщение не отправлено или не доставлено по техническим или сетевым причинам, а также если номер получателя указан неверно или недоступен
5enumнедостаточно средств на балансе для отправки сообщения
6enumприем и отправка сообщений заблокированы
7enumсообщение не отправлено

Channel

ПараметрТипОписание
1enumSMS
4enumTelegram Verify
5enumУПН → SMS

CategoryType

ПараметрТипОписание
0enumкатегория не указана
1enumSMS с мобильного номера
2enumрекламное SMS от имени отправителя
3enumавторизационное SMS от имени отправителя
4enumсервисное SMS от имени отправителя
5enumтранзакционное SMS от имени отправителя

Примеры

Входные параметры (для SMS и УПН → SMS):

{
   "message_id": 535103102366598674,
   "limit": 100,
   "offset": 0,
   "number": "79813330013",
   "sender": "79813340013",
   "direction": 2,
   "delivery_status": 3,
   "billing_status": 2,
   "status": 3,
   "date_gte": "2024-10-01T10:00:56.759Z",
   "date_lte": "2024-12-10T10:00:56.759Z",
   "date_sent_received_gte":"2023-01-20T11:30:01.335Z",
   "date_sent_received_lte":"2023-01-20T11:39:01.335Z",
   "receiver": "79873558880",
   "receiver_mcc": "250",
   "receiver_mnc": "1",
   "receiver_mobile_operator": "MTS",
   "category": 1,
   "campaign_id": "12345",
   "campaign_name": "test",
   "sort": {
       "order_by_date": 1
   },
   "price_gte": 1.5,
   "price_lte": 10.12,
}

Входные параметры (для Telegram Verify):

{
   "message_id": 582622948376971821,
   "limit": 100,
   "offset": 0,
   "delivery_status": 3,
   "billing_status": 2,
   "status": 3,
   "date_gte": "2025-09-02T06:00:03Z",
   "date_lte": "2025-09-02T08:00:03Z",
   "sort": {
       "order_by_date": 1
   }
}

Выходные параметры (для SMS и УПН → SMS):

{
   "messages": [
       {
           "message_id": "535103152366598674",
           "application_uuid": "6cb49297-8cd2-4f34-8e8b-856679a82437",
           "date": "2024-10-09T12:12:18.303Z",
           "date_sent_received": "2024-10-09T12:12:18.303Z",
           "number": "79813330013",
           "sender": "79813340013",
           "receiver": "79873558880",
           "text": "МТС Exolve — конструктор омниканальных диалогов для бизнеса",
           "direction": 2,
           "segments_count": 1,
           "billing_status": 2,
           "delivery_status": 3,
           "channel": 1,
           "status": 3,
           "sender_mcc": "250",
           "sender_mnc": "42",
           "sender_mobile_operator": "MTT",
           "receiver_mcc": "250",
           "receiver_mnc": "1",
           "receiver_mobile_operator": "MTS",
           "campaign_id": "12345",
           "campaign_name": "test",
           "category": 1,
           "price": 1.5
       }
   ]
}

Выходные параметры (для Telegram Verify):

{
    "message_id": "582622948376971821",
    "application_uuid": "6cb49297-8cd2-4f34-8e8b-856679a82437",
    "date": "2025-09-02T07:59:03Z",
    "receiver": "79873558881",
    "text": "1234",
    "direction": 2,
    "segments_count": 1,
    "billing_status": 2,
    "delivery_status": 3,
    "channel": 4,
    "status": 3,
    "date_sent_received": "2025-09-02T07:58:58.823Z"
}

Возможные ошибки

КодСтатусПример сообщенияОписание
400Bad Requestunknown fieldневалидный параметр
400Bad Requestsyntax errorсинтаксическая ошибка
400Bad Requestinvalid valueневалидное значение в параметре
404Not Foundpage not foundнекорректно введен URL запроса
401Unauthorizedauthorization token is invalidнеправильно указан токен (API-ключ приложения)