GetList

Метод GetList

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

Точка подключения:

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

Авторизация

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

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

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

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

Параметр Тип Описание
message_id string уникальный идентификатор сообщения (указывается, если нужна информация по одному сообщению)
limit uint32 лимит выводимых строк
offset uint64 номер строки, с которой начинать выборку (начинается с 0)
number string номер телефона / имя отправителя
direction enum Direction направление сообщения
delivery_status enum DeliveryStatus статус доставки сообщения
billing_status enum BillingStatus статус оплаты сообщения
status enum Status (объединяет в себе доставку и оплату)
date_gte string дата в формате RFC-3339 / ISO-8601, с которой начинать выборку сообщений
date_lte string дата в формате RFC-3339 / ISO-8601, до которой продолжать выборку сообщений
sort Array OrderBy сортировка по дате отправки сообщения или по количеству сегментов (можно применить только один тип сортировки)
receiver_mcc string MCC-код оператора получателя сообщения, формат: 250
receiver_mnc string MNC-код оператора получателя сообщения, формат: 42
receiver_mobile_operator string оператор получателя сообщения, формат: MTT
category enum CategoryType категория сообщения, подробнее
receiver string номер получателя сообщения

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

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

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

CategoryType

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

OrderBy

Параметр Тип Описание
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
number string номер телефона / имя отправителя
sender string номер отправителя / имя отправителя
receiver string номер получателя
text string текст сообщения
direction enum Direction направление сообщения
segments_count uint32 количество сегментов в сообщении
billing_status enum BillingStatus статус оплаты сообщения
delivery_status enum DeliveryStatus статус доставки сообщения
channel enum канал, в котором отправлено или получено сообщение
status enum Status общий статус, объединяет в себе статус доставки и оплаты сообщения
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

Direction

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

BillingStatus

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

DeliveryStatus

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

Status

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

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

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

Примеры

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

{
    "message_id": "444067567615608452",
    "limit": "10000",
    "offset": "0",
    "number": "79678880033",
    "direction": "2",
    "delivery_status": "3",
    "billing_status": "2",
    "status":"3",
    "date_gte":"2023-01-20T11:30:01.335Z",
    "date_lte":"2023-01-20T11:39:01.335Z",
    "sort": {
        "order_by_segments_count": 1
        },
    "receiver_mobile_operator": "MTT",
    "receiver_mcc": "250",
    "receiver_mnc": "42",
    "category ": "1",
    "receiver": "79678880033"
}

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

{
    "messages": [
        {
            "message_id": "444067567615608452",
            "application_id": "74caefbc-5615-49db-aca1-07ba829e728c",
            "date": "2023-01-20T11:35:01.335Z",
            "number": "79679990044",
            "sender": "79679990044",
            "receiver": "79678880033",
            "text": "Test message",
            "direction": 2,
            "segments_count": 1,
            "billing_status": 2,
            "delivery_status": 3,
            "channel": 1,
            "status": 3,
            "category ": "1",
            "receiver_mobile_operator": "MTT",
            "receiver_mcc": "250",
            "receiver_mnc": "42"
        }
    ]
}

Содержание статьи