Метод GetList Примените метод GetList, чтобы получить информацию об исходящих и входящих сообщениях по заданным параметрам.
Точка подключения : Выполните POST-запрос с входными параметрами к точке подключения:
POST: https://api.exolve.ru/messaging/v1/GetList
Авторизация Передайте следующие Заголовки HTTP для успешной авторизации.
Имя Тип Описание Authorization string API-ключ приложения с Bearer перед ним. Пример: Bearer e***s0, где e***s0 замените на API-ключ вашего приложения
Входные параметры Передайте следующие параметры в теле запроса в JSON-формате. Можно передать пустой запрос — тогда вы получите информацию обо всех SMS этого приложения без применения фильтров поиска.
Параметр Тип Описание message_id int64 идентификатор сообщения (указывается, если нужна информация по одному сообщению) limit uint32 лимит выводимых строк, по умолчанию — 100, максимальное значение — 2 000 offset uint64 номер строки, с которой начинать выборку (начинается с 0) number string номер телефона / имя отправителя direction enum Direction направление сообщения delivery_status enum DeliveryStatus статус доставки сообщения billing_status enum BillingStatus статус оплаты сообщения status enum Status (объединяет в себе доставку и оплату) channel enum Channel канал отправки сообщения date_gte string дата последнего изменения статуса сообщения в формате RFC-3339 / ISO-8601 , с которой начинать выборку сообщений date_lte string дата последнего изменения статуса сообщения в формате RFC-3339 / ISO-8601 , до которой продолжать выборку сообщений date_sent_received_gte string дата отправки исходящего/получения входящего сообщения в формате RFC-3339 / ISO-8601 , с которой начинать выборку сообщений date_sent_received_lte string дата отправки исходящего/получения входящего сообщения в формате RFC-3339 / ISO-8601 , до которой продолжать выборку сообщений receiver string номер получателя sender string номер отправителя / имя отправителя receiver_mcc string MCC-код оператора получателя, формат: 250 receiver_mnc string MNC-код оператора получателя, формат: 42 receiver_mobile_operator string оператор получателя, формат: MTT category enum CategoryType категория сообщения, подробнее sort enum SortOrder сортировка по дате отправки сообщения или по количеству сегментов (можно применить только один тип сортировки) campaign_id string идентификатор рассылки, в рамках которой было отправлено сообщение campaign_name string название рассылки, в рамках которой было отправлено сообщение price_gte float стоимость сообщения, с которой начинать выборку сообщений price_lte float стоимость сообщения, до которой продолжать выборку сообщений
MCC/MNC коды оператора
MCC (Mobile Country Code) — код страны, в которой находится оператор мобильной связи. Состоит из 3 цифр. MNC (Mobile Network Code) — код мобильной сети (оператора), следует после MCC. Состоит из 2 или 3 цифр, уникален для каждого оператора он уникален. Комбинация MCC + MNC + наименование оператора позволяет однозначно определить сеть. Эти коды унифицированы — вы можете воспользоваться любым справочником, чтобы найти нужный код.
Channel Параметр Тип Описание 1 enum SMS 4 enum Telegram Verify 5 enum Умная проверка номеров (УПН) → SMS, подробнее
CategoryType Параметр Тип Описание 0 enum категория не указана 1 enum SMS с мобильного номера 2 enum рекламное SMS от имени отправителя 3 enum авторизационное SMS от имени отправителя 4 enum сервисное SMS от имени отправителя 5 enum транзакционное SMS от имени отправителя
SortOrder Параметр Тип Описание order_by_date Array OrderByDate сортировка по дате отправки order_by_segments_count Array OrderBySegmentsCount сортировка по количеству сегментов в сообщении
OrderByDate/OrderBySegmentsCount Параметр Тип Описание 1 enum ascending order (по возрастанию) 2 enum descending order (по убыванию) — по умолчанию для даты
Выходные параметры Параметр Тип Описание messages JSON Array список сообщений message_id int64 идентификатор сообщения application_uuid string идентификатор приложения, с / на номер которого отправляли / получали сообщения date string дата и время последнего изменения статуса сообщения в формате RFC-3339 / ISO-8601 date_sent_received string дата и время отправки исходящего/получения входящего сообщения в формате RFC-3339 / ISO-8601 number string номер телефона / имя отправителя sender string номер отправителя / имя отправителя receiver string номер получателя text string текст сообщения direction enum Direction направление сообщения segments_count uint32 количество сегментов в сообщении billing_status enum BillingStatus статус оплаты сообщения delivery_status enum DeliveryStatus статус доставки сообщения status enum Status общий статус, объединяет в себе статус доставки и оплаты сообщения channel enum Channel канал, в котором отправлено / получено сообщение category enum CategoryType категория сообщения, подробнее sender_mobile_operator string оператор отправителя сообщения, формат: MTT sender_mcc string MCC-код оператора отправителя сообщения, формат: 250 sender_mnc string MNC-код оператора отправителя сообщения, формат 42 receiver_mobile_operator string оператор получателя сообщения, формат: MTT receiver_mcc string MCC-код оператора получателя сообщения, формат: 250 receiver_mnc string MNC-код оператора получателя сообщения, формат: 42 campaign_id string идентификатор рассылки, в рамках которой было отправлено SMS campaign_name string название рассылки, в рамках которой было отправлено SMS price float стоимость сообщения, обновляется в течение часа с момента отправки сообщения. Присутствует только для СМС-сообщений, отправленных от имени отправителя activity_score string для УПН → SMS (channel=5), переданный порог активности номера получателя от 0 до 1 activity_result string для УПН → SMS (channel=5), полученная оценка активности в сети номера получателя
Direction Параметр Тип Описание 1 enum входящее сообщение 2 enum исходящее сообщение
BillingStatus Параметр Тип Описание 0 enum неизвестный статус оплаты 1, 9 enum сообщение поставлено в очередь на обработку и оплату 2, 10 enum сообщение оплачено 4 enum недостаточно средств на балансе для отправки сообщения 6 enum ошибка оплаты сообщения 7 enum плата за сообщение зарезервирована 8 enum ошибка — закончились попытки оплаты сообщения
DeliveryStatus Параметр Тип Описание 0 enum неизвестный статус доставки 1 enum сообщение поставлено в очередь на отправку 2 enum сообщение доставлено в SMS-центр 3 enum сообщение доставлено получателю 4 enum сообщение не может быть доставлено получателю 5 enum ошибка — закончились попытки переотправки сообщения 6 enum приём и отправка сообщений заблокированы
Status Параметр Тип Описание 1 enum сообщение в очереди на отправку 2 enum сообщение отправлено 3 enum сообщение доставлено 4 enum сообщение не отправлено или не доставлено по техническим или сетевым причинам, а также если номер получателя указан неверно или недоступен 5 enum недостаточно средств на балансе для отправки сообщения 6 enum прием и отправка сообщений заблокированы 7 enum сообщение не отправлено
Channel Параметр Тип Описание 1 enum SMS 4 enum Telegram Verify 5 enum УПН → SMS
CategoryType Параметр Тип Описание 0 enum категория не указана 1 enum SMS с мобильного номера 2 enum рекламное SMS от имени отправителя 3 enum авторизационное SMS от имени отправителя 4 enum сервисное SMS от имени отправителя 5 enum транзакционное 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"
}
Возможные ошибки Код Статус Пример сообщения Описание 400 Bad Request unknown field невалидный параметр 400 Bad Request syntax error синтаксическая ошибка 400 Bad Request invalid value невалидное значение в параметре 404 Not Found page not found некорректно введен URL запроса 401 Unauthorized authorization token is invalid неправильно указан токен (API-ключ приложения)