getMailings

Возвращает рассылки аккаунта, подходящие под фильтр (https://getcourse.ru/blog/276146)

Параметры

• ctx:app.Ctx
  Контекст приложения, предоставляющий доступ к различным компонентам и настройкам приложения.

• params:GetMailingsParams
  Объект с параметрами для получения рассылок.

Свойства params

• title: string (необязательно)
  Название рассылки.

• category: number (необязательно)
  Категория рассылки.

• transport: GcMailingTransport (необязательно)
  Транспорт для рассылки.

• type: GcMailingType (необязательно)
  Тип рассылки.

• ids: number[] (необязательно)
  Массив идентификаторов рассылок.

• parentId: number (необязательно)
  Идентификатор родительской рассылки.

• limit: number (необязательно)
  Лимит на количество возвращаемых результатов.

• offset: number (необязательно)
  Смещение для пагинации.

• content: boolean (необязательно)
  Флаг для включения содержимого в ответ.

• sort: 'asc' | 'desc' (необязательно)
  Порядок сортировки результатов.

• showInfo: boolean (необязательно)
  Флаг для включения дополнительной информации в ответ.

Возвращаемое значение

• Promise<GcMailing[]>
  Возвращает массив объектов GcMailing, содержащих информацию о рассылках.

Свойства GcMailing

• id: number
  Идентификатор рассылки (например, 11729467)
• title: string
  Заголовок рассылки (например, 'Рекомендуем зарегистрироваться на веб!')
• group_name: string | null
  Название группы (необязательное свойство)
• type: GcMailingType
  Тип рассылки
• transport: GcMailingTransport
  Транспорт рассылки
• category_id: number
  Идентификатор категории
• created_at: GcDateString
  Дата и время создания (например, '2023-09-05 13:36:11')
• deleted_at: GcDateString | null
  Дата и время удаления (если удалена)
• from_user_id: number
  Идентификатор пользователя, отправившего рассылку
• parent_id: number | null
  Идентификатор родительской рассылки (если есть)
• object_type: GcMailingObjectType
  Тип объекта рассылки
• params: object
  Дополнительные параметры рассылки:
  • design_type: GcMailingDesignType (необязательное свойство)
  • recipients_type: string (например, 'nobody')
  • send_to: string (например, 'confirmed_address')
  • send_from: string (например, 'testchatium1')
  • content_update: boolean (обновление контента)
  • content_update_at: GcDateString (дата обновления контента)
  • template_id: string (например, '101365')
  • templateBodyCssBgColor: string (цвет фона шаблона)
  • templateBodyCssBgImage: string (изображение фона шаблона)
  • mailruSpamDetect: -1 | 1 (детектирование спама)
  • tested: boolean (тестирование)
  • wrap_links: boolean (оборачивание ссылок)
  • click_wrap_links: boolean (оборачивание кликов по ссылкам)
  • disable_links_preview: boolean (отключение предпросмотра ссылок)
  • confirm: 0 | 1 (подтверждение)
  • queue_shift: string (например, '0')
  • queue_shift_unit: string (например, 'hours')
  • queue_shift_source: string (например, 'previous')
  • wait_for: object (ожидание)
    • enabled: string (например, '0')
    • weekday: string (например, '0')
    • hour: string (например, '0')
    • minute: string (например, '0')
• content: string
  Контент рассылки
• subject: string
  Тема рассылки
• files: string
  Файлы в формате JSON (например, '{"files":[]}')
• info: object
  Информация о рассылке:
  • id: number
    Идентификатор рассылки (например, 11729467)
  • ACCOUNT_ID: number
    Идентификатор аккаунта (например, 163699)
  • created_at: GcDateString
    Дата и время создания
  • updated_at: GcDateString
    Дата и время обновления
  • calculated_at: GcDateString | null
    Дата и время вычисления (если вычислено)
  • state: 1 | 0
    Состояние (активно/неактивно)
  • deleted: 1 | 0
    Удалено (да/нет)
  • deleted_at: null
    Дата и время удаления (если удалено)
  • cnt_total: number
    Общее количество
  • cnt_sent: number
    Количество отправленных
  • cnt_in_queue: number
    Количество в очереди
  • cnt_in_progress: number
    Количество в процессе
  • cnt_cancelled: number
    Количество отмененных
  • cnt_restricted: number
    Количество ограниченных
  • cnt_answered: number
    Количество ответивших
  • cnt_errors: number
    Количество с ошибками
  • cnt_viewed: number
    Количество просмотренных
  • cnt_clicked: number
    Количество кликов
  • cnt_new: number
    Количество новых
  • cnt_unsubscribed: number
    Количество отписавшихся
  • transport_id: number
    Идентификатор транспорта
• category: string
  Категория