Перейти к основному содержимому

PaginatedResponse[ManualSendingCampaignRead]

items object[]required
  • Array [
  • idIdrequired

    Уникальный числовой идентификатор записи.

    product_idProduct Idrequired

    Идентификатор продукта (рабочего пространства), которому принадлежит запись. Большинство эндпоинтов разграничивают доступ по продукту.

    created_by_user_id object

    Идентификатор пользователя, создавшего кампанию.

    anyOf
    integer
    nameNamerequired

    Человекочитаемое название кампании.

    source objectrequired

    Содержимое сообщения для отправки каждому целевому лиду.

    text object
    anyOf
    string
    prompt_id object
    anyOf
    integer
    prompt_version_id object
    anyOf
    integer
    prepared_message_id object
    anyOf
    integer
    waba_template_id object
    anyOf
    integer
    file_idsinteger[]
    caption object
    anyOf
    string
    filter_config objectrequired

    Фильтр лидов, использованный для отбора получателей.

    product_idProduct Idrequired

    Идентификатор продукта (рабочего пространства), которому принадлежит запись. Большинство эндпоинтов разграничивают доступ по продукту.

    id object

    Найти одного лида по id.

    anyOf
    integer
    lead_idsinteger[]

    Найти заданный набор идентификаторов лидов.

    stage_idsinteger[]

    Найти лидов на любом из этих этапов.

    name object

    Найти по имени лида.

    anyOf
    string
    crm_id object

    Идентификатор соответствующей записи в подключённой внешней CRM, если есть.

    anyOf
    string
    is_active object

    Найти по флагу активности.

    anyOf
    boolean
    is_test object

    Найти по флагу теста.

    anyOf
    boolean
    batch_name object

    Найти по имени партии импорта.

    anyOf
    string
    tag_idsinteger[]

    Найти лидов, имеющих любой из этих тегов.

    contact object

    Найти по значению контакта.

    anyOf
    string
    crm_fields_conditions object

    Составные условия по CRM-полям (AND/OR с операторами для каждого поля).

    anyOf
    operatorCRMFieldsConditionsOperator

    Possible values: [AND, OR]

    Default value: AND
    conditions object[]
  • Array [
  • fieldFieldrequired
    operatorCRMFieldConditionOperatorrequired

    Possible values: [EQUALS, NOT_EQUALS, IN, NOT_IN, STARTS_WITH, ENDS_WITH, CONTAINS, EXISTS, NOT_EXISTS, IS_EMPTY, IS_NOT_EMPTY]

    valueValue
  • ]
  • split object

    Разбивать ли длинные сообщения на части.

    anyOf
    boolean
    planned_start_at object

    Отложить запуск кампании до этого времени (UTC). Пока поле не задано или время уже прошло, кампания стартует на ближайшем тике обработчика; до запуска она остаётся доступной для редактирования.

    anyOf
    date-time
    daily_limit object

    Максимум лидов, планируемых в день (часовой пояс продукта/агента); null — без суточного ограничения.

    anyOf
    integer
    activate_leadsActivate Leads

    Если true — на момент отправки повторно активировать лида и снять mute с диалога, вместо того чтобы пропускать заглушённых/неактивных.

    Default value: false
    activated_leads_grace_period_hoursActivated Leads Grace Period Hours

    Окно ожидания ответа в часах для повторно активированных лидов после того, как кампания успешно запланировала хотя бы одно сообщение. В течение этого окна автоигнорирование устаревшего лида не срабатывает. 0 — реактивировать без такого окна.

    Default value: 72
    daily_send_from object

    Местное время суток (часовой пояс продукта/агента), раньше которого сообщения за день не отправляются; null — с полуночи.

    anyOf
    time
    daily_send_until object

    Местное время суток (часовой пояс продукта/агента), позже которого сообщения за день не отправляются; null — до конца суток.

    anyOf
    time
    next_eligible_at object

    Только для чтения. Когда кампания на паузе (исчерпан суточный лимит или вне окна отправки) — время, когда она снова станет доступной для продолжения (UTC); иначе null.

    anyOf
    date-time
    statusManualSendingCampaignStatusrequired

    Статус жизненного цикла — queued, running, completed, failed или cancelled.

    Possible values: [queued, running, completed, failed, cancelled]

    error object

    Детали ошибки, если кампания завершилась неуспешно.

    anyOf
    string
    started_at object

    Когда началась обработка (UTC).

    anyOf
    date-time
    finished_at object

    Когда обработка завершилась (UTC).

    anyOf
    date-time
    created_atdate-timerequired

    Время создания (UTC, ISO 8601).

    updated_atdate-timerequired

    Время последнего изменения (UTC, ISO 8601).

    stats object

    Сводные счётчики кампании.

    target_leads_countTarget Leads Count

    Различающихся лидов, попавших в снимок целей (каноничный размер кампании).

    Default value: 0
    dialogues_with_responses_countDialogues With Responses Count

    Число целевых диалогов, в которых получен ответ.

    Default value: 0
    messages_received_totalMessages Received Total

    Всего входящих сообщений в целевых диалогах.

    Default value: 0
    messages_created_totalMessages Created Total

    Всего сообщений, созданных кампанией.

    Default value: 0
    messages_failed_totalMessages Failed Total

    Сообщения, которые не удалось отправить.

    Default value: 0
    messages_scheduled_totalMessages Scheduled Total

    Сообщения, запланированные, но ещё не отправленные.

    Default value: 0
    messages_cancelled_totalMessages Cancelled Total

    Сообщения, отменённые до отправки.

    Default value: 0
    messages_sent_totalMessages Sent Total

    Отправленные сообщения.

    Default value: 0
    messages_delivered_totalMessages Delivered Total

    Доставленные сообщения.

    Default value: 0
  • ]
  • pagePagerequired
    limitLimitrequired
    totalTotalrequired
    pagesPagesrequired
    PaginatedResponse[ManualSendingCampaignRead]
    {
    "items": [
    {
    "id": 0,
    "product_id": 0,
    "created_by_user_id": 0,
    "name": "string",
    "source": {
    "text": "string",
    "prompt_id": 0,
    "prompt_version_id": 0,
    "prepared_message_id": 0,
    "waba_template_id": 0,
    "file_ids": [
    0
    ],
    "caption": "string"
    },
    "filter_config": {
    "product_id": 0,
    "id": 0,
    "lead_ids": [
    0
    ],
    "stage_ids": [
    0
    ],
    "name": "string",
    "crm_id": "string",
    "is_active": true,
    "is_test": true,
    "batch_name": "string",
    "tag_ids": [
    0
    ],
    "contact": "string",
    "crm_fields_conditions": {
    "operator": "AND",
    "conditions": [
    {
    "field": "string",
    "operator": "EQUALS"
    }
    ]
    }
    },
    "split": true,
    "planned_start_at": "2024-07-29T15:51:28.071Z",
    "daily_limit": 0,
    "activate_leads": false,
    "activated_leads_grace_period_hours": 72,
    "daily_send_from": "string",
    "daily_send_until": "string",
    "next_eligible_at": "2024-07-29T15:51:28.071Z",
    "status": "queued",
    "error": "string",
    "started_at": "2024-07-29T15:51:28.071Z",
    "finished_at": "2024-07-29T15:51:28.071Z",
    "created_at": "2024-07-29T15:51:28.071Z",
    "updated_at": "2024-07-29T15:51:28.071Z",
    "stats": {
    "target_leads_count": 0,
    "dialogues_with_responses_count": 0,
    "messages_received_total": 0,
    "messages_created_total": 0,
    "messages_failed_total": 0,
    "messages_scheduled_total": 0,
    "messages_cancelled_total": 0,
    "messages_sent_total": 0,
    "messages_delivered_total": 0
    }
    }
    ],
    "page": 0,
    "limit": 0,
    "total": 0,
    "pages": 0
    }