ManualSendingCampaignRead
Массовая рассылка, созданная оператором. API лишь создаёт артефакт в очереди; фоновый обработчик делает снимок подходящих лидов и планирует сообщения, после чего обновляет статистику.
Уникальный числовой идентификатор записи.
Идентификатор продукта (рабочего пространства), которому принадлежит запись. Большинство эндпоинтов разграничивают доступ по продукту.
created_by_user_id object
Идентификатор пользователя, создавшего кампанию.
- integer
- null
Человекочитаемое название кампании.
source objectrequired
Содержимое сообщения для отправки каждому целевому лиду.
text object
- string
- null
prompt_id object
- integer
- null
prompt_version_id object
- integer
- null
prepared_message_id object
- integer
- null
waba_template_id object
- integer
- null
caption object
- string
- null
filter_config objectrequired
Фильтр лидов, использованный для отбора получателей.
Идентификатор продукта (рабочего пространства), которому принадлежит запись. Большинство эндпоинтов разграничивают доступ по продукту.
id object
Найти одного лида по id.
- integer
- null
Найти заданный набор идентификаторов лидов.
Найти лидов на любом из этих этапов.
name object
Найти по имени лида.
- string
- null
crm_id object
Идентификатор соответствующей записи в подключённой внешней CRM, если есть.
- string
- null
is_active object
Найти по флагу активности.
- boolean
- null
is_test object
Найти по флагу теста.
- boolean
- null
batch_name object
Найти по имени партии импорта.
- string
- null
Найти лидов, имеющих любой из этих тегов.
contact object
Найти по значению контакта.
- string
- null
crm_fields_conditions object
Составные условия по CRM-полям (AND/OR с операторами для каждого поля).
- CRMFieldsConditionsConfig
- null
Possible values: [AND, OR]
ANDconditions object[]
Possible values: [EQUALS, NOT_EQUALS, IN, NOT_IN, STARTS_WITH, ENDS_WITH, CONTAINS, EXISTS, NOT_EXISTS, IS_EMPTY, IS_NOT_EMPTY]
split object
Разбивать ли длинные сообщения на части.
- boolean
- null
planned_start_at object
Отложить запуск кампании до этого времени (UTC). Пока поле не задано или время уже прошло, кампания стартует на ближайшем тике обработчика; до запуска она остаётся доступной для редактирования.
- date-time
- null
daily_limit object
Максимум лидов, планируемых в день (часовой пояс продукта/агента); null — без суточного ограничения.
- integer
- null
Если true — на момент отправки повторно активировать лида и снять mute с диалога, вместо того чтобы пропускать заглушённых/неактивных.
falseОкно ожидания ответа в часах для повторно активированных лидов после того, как кампания успешно запланировала хотя бы одно сообщение. В течение этого окна автоигнорирование устаревшего лида не срабатывает. 0 — реактивировать без такого окна.
72daily_send_from object
Местное время суток (часовой пояс продукта/агента), раньше которого сообщения за день не отправляются; null — с полуночи.
- time
- null
daily_send_until object
Местное время суток (часовой пояс продукта/агента), позже которого сообщения за день не отправляются; null — до конца суток.
- time
- null
next_eligible_at object
Только для чтения. Когда кампания на паузе (исчерпан суточный лимит или вне окна отправки) — время, когда она снова станет доступной для продолжения (UTC); иначе null.
- date-time
- null
Статус жизненного цикла — queued, running, completed, failed или cancelled.
Possible values: [queued, running, completed, failed, cancelled]
error object
Детали ошибки, если кампания завершилась неуспешно.
- string
- null
started_at object
Когда началась обработка (UTC).
- date-time
- null
finished_at object
Когда обработка завершилась (UTC).
- date-time
- null
Время создания (UTC, ISO 8601).
Время последнего изменения (UTC, ISO 8601).
stats object
Сводные счётчики кампании.
Различающихся лидов, попавших в снимок целей (каноничный размер кампании).
0Число целевых диалогов, в которых получен ответ.
0Всего входящих сообщений в целевых диалогах.
0Всего сообщений, созданных кампанией.
0Сообщения, которые не удалось отправить.
0Сообщения, запланированные, но ещё не отправленные.
0Сообщения, отменённые до отправки.
0Отправленные сообщения.
0Доставленные сообщения.
0{
"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
}
}