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, до которой продолжать выборку сообщений

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

Параметр Тип Описание
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 тип мессенджера (сейчас поддерживается только 1 = SMS)
status enum Status общий статус, объединяет в себе статус доставки и биллинга сообщения

Direction

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

DeliveryStatus

Параметр Тип Описание
DELIVERY_STATUS_QUEUED = 1 string сообщение ожидает отправки в SMS-центр
DELIVERY_STATUS_TRANSMITTED = 2 string сообщение отправлено в SMS-центр, SMS-центр назначил ему идентификатор (internal_id)
DELIVERY_STATUS_DELIVERED = 3 string сообщение доставлено получателю (SMS-центр отправил уведомление о доставке)
DELIVERY_STATUS_FAILED = 4 string сообщение не может быть доставлено получателю (SMS-центр отправил уведомление о недоставке)
DELIVERY_STATUS_RETRIES_EXCEEDED = 5 string превышено количество попыток отправки сообщения
DELIVERY_STATUS_PROHIBITED = 6 string прием и отправка сообщений заблокированы

BillingStatus

Параметр Тип Описание
BILLING_STATUS_PREBILLED = 1 string сообщение предоплачено
BILLING_STATUS_BILLED = 2 string сообщение оплачено
BILLING_STATUS_UNDERFUNDED = 4 string недостаточно средств для отправки сообщения
BILLING_STATUS_FAILED = 6 string оплата за сообщение не прошла
BILLING_STATUS_AUTHORIZED = 7 string оплата авторизована

Status

Параметр Тип Описание
STATUS_QUEUED = 1 string сообщение в очереди на отправку
STATUS_TRANSMITTED = 2 string сообщение отправлено
STATUS_DELIVERED = 3 string сообщение доставлено
STATUS_FAILED = 4 string не удалось отправить сообщение
STATUS_UNDERFUNDED = 5 string недостаточно средств на балансе для отправки сообщения
STATUS_PROHIBITED = 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": "DIRECTION_OUTGOING",
    "delivery_status": "DELIVERY_STATUS_DELIVERED",
    "billing_status": "BILLING_STATUS_BILLED",
    "status":"STATUS_DELIVERED",
    "date_gte":"2023-01-20T11:30:01.335Z",
    "date_lte":"2023-01-20T11:39:01.335Z"
}

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

{
    "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
        }
    ]
}

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