GetRecipients

CampaignRecipient

Модель, описывающая получателя рассылки

Название Тип данных Описание
id Int64 ID получателя рассылки
campaign_id Int64 ID рассылки
recipient String Номер телефона или Telegram аккаунт
state Enum Статус отправки: <New | 0> - Только добавлен в список, еще не отправлено, <Sended | 1> - Сообщение отправлено (например, ушло в SMS шлюз или в Telegram API), <Delivered | 2> - Подтверждена доставка (если есть обратная связь от канала), <Error | 3> - Ошибка при отправке сообщения
last_update Int64 Время последнего изменения параметров в формате Unix time в секундах

[POST] …/v1/Campaign/GetRecipients

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

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

Название Тип данных Обязательность Описание
campaign_id Int64 Обязательный ID рассылки
limit Int32 Необязательный Количество возвращаемых элементов выборки
offset Int32 Необязательный Смещение от начала выборки

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

{
    "campaign_id": 1,
    "limit": 1,
    "offset": 1
}

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

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

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

{
    "ok": true,
    "result": [
        {
            "id": 1,
            "campaign_id": 1,
            "recipient": "example",
            "state": "New",
            "last_update": 171234568
        }
    ],
    "next_offset": 2,
    "total": 1
}