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

ManualSendingCampaignCreate

Тело запроса для создания кампании ручной рассылки. Возвращает 202 с кампанией в очереди; рассылку выполняет обработчик.

product_idProduct Idrequired

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

name object

Необязательное человекочитаемое имя.

anyOf
string
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 objectrequired

Фильтр лидов, отбирающий получателей.

product_idProduct Idrequired

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

id object

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

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
created_at_from object
anyOf
date-time
created_at_to object
anyOf
date-time
has_started object
anyOf
boolean
batch_name object
anyOf
string
tag_idsinteger[]
contact object
anyOf
string
crm_fields_conditions object
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); прошедшее/null — запустить сразу. Редактируется, пока кампания в статусе queued.

    anyOf
    date-time
    daily_limit object

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

    anyOf
    integer

    Possible values: >= 1

    activate_leadsActivate Leads

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

    Default value: false
    activated_leads_grace_period_hoursActivated Leads Grace Period Hours

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

    Possible values: >= 0

    Default value: 72
    daily_send_from object

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

    anyOf
    time
    daily_send_until object

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

    anyOf
    time
    ManualSendingCampaignCreate
    {
      "product_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": {
        "product_id": 0,
        "id": 0,
        "lead_ids": [
          0
        ],
        "stage_ids": [
          0
        ],
        "name": "string",
        "crm_id": "string",
        "is_active": true,
        "is_test": true,
        "created_at_from": "2024-07-29T15:51:28.071Z",
        "created_at_to": "2024-07-29T15:51:28.071Z",
        "has_started": 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"
    }