Get

[POST] …/v1/Campaign/Get

Возвращает информацию о рассылках.

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

Название Тип данных Обязательность Описание
ids Array of Int64 Необязательный Массив ID рассылок
status Enum Необязательный Статус рассылки: <New | 1> - Рассылка создана, но ещё не запущена, <Waiting | 2> - Рассылка ожидает времени расслки, <Progress | 3> - Рассылка начата, но не завершена, <Completed | 4> - Рассылка завершена, <Error | 5> - Рассылка завершилась с ошибкой
type Enum Необязательный Тип рассылки: <SMS | 1> - Рассылка по SMS, <Telegram | 2> - Рассылка в Telegram
search String Необязательный Поиск по значениям параметров: name - Название рассылки
sort_orders Array of SortOrders Необязательный Сортировака выходных параметров
limit Int32 Необязательный Количество возвращаемых элементов выборки
offset Int32 Необязательный Смещение от начала выборки
SortOrders

Модель сортировки выходных параметров.

Название Тип данных Обязательность Описание
column Enum Необязательный Параметр для сортировки: <Id | 1> - ID, <Name | 2> - Название, <Type | 3> - Тип, <Date | 4> - Дата создания, <RunDate | 5> - Дата запуска, <RunImmediately | 6> - Запустить сразу после создания, <Message | 7> - Текст СМС сообщения, <Image_url | 8> - Ссылка на изображение, <RecipientCount | 9> - Количество получателей, <State | 10> - Статус, <LastUpdate | 11> - Время последнего изменения
direction Enum Необязательный Порядок сортировки: <ASC | 1> - По возростанию, <DESC | 2> - По убыванию

Пример запроса

{
    "ids": [
        1
    ],
    "status": "New",
    "type": "SMS",
    "search": "Рассылка",
    "sort_orders": [
        {
            "column": "Name",
            "direction": "ASC"
        }
    ],
    "limit": 1,
    "offset": 1
}

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

Название Тип данных Описание
result Array of Campaign Массив рассылок
next_offset Int32 Смещение для следующей выборки данных
total Int32 Общее количество элементов

Пример ответа

{
    "ok": true,
    "result": [
        {
            "id": 1,
            "name": "Рассылка",
            "type": "SMS",
            "date": 1712345678,
            "run_date": 1712345678,
            "run_immediately": true,
            "message": "Example",
            "image_url": "https://dev-cdn.regos.uz/folder/image.png",
            "recipient_count": 9,
            "status": "New",
            "scheduler_uuid": "886313E1-3B8A-5372-9B90-0C9AEE199E5D",
            "last_update": 171234568
        }
    ],
    "next_offset": 2,
    "total": 1
}