Skip to content

Создание рекламной кампании

Метод create.campaigns
Описание Создание рекламной кампании.
Можно создать только рекламную кампания с типом 'basic'.
Кому доступен Агент, Клиент
Доступное количество рекламных кампаний регулируется на уровне тарифного плана

Параметры запроса

Название Тип Обязательный Допустимые значения Описание
access_token string да Ключ сессии аутентификации
user_id number нет Уникальный идентификатор пользователя клиента агента от имени которого делается запрос
Является обязательным для агента
Для получения списка пользователей клиента необходимо использовать метод "get.customer_users"
name string да Название рекламной кампании
description string нет Максимум 255 символов Описание рекламной кампании
status enum нет
  • active
  • inactive
 Статус рекламной кампании
site_id number да Уникальный идентификатор сайта
campaign_conditions object нет Условия рекламной кампании.
Настройки привязки номера к блоку на сайте
site_blocks array нет Настройки привязки номера к блоку на сайте
Если блоки номеров сайта не указаны, то они не настраиваются, т.е. считаются не настроенными
Если site_blocks задан одновременно с status = inactive, то будет возвращаться ошибка `invalid_parameters_combination`
site_block_id number да Уникальный идентификатор блока номеров
phone_number_id number да Уникальный идентификатор виртуального номера. Чтобы получить список доступных виртуальных номеров необходимо использовать метод get.campaign_available_phone_numbers
Если указан id который не возвращается методом get.campaign_available_phone_numbers, то будет возвращена ошибка с мнемоникой "entity_not_found".
Номер с type = call_tracking может использоваться только в одной рекламной кампании. Если номер уже используется в другой рекламной кампании, то будет возвращена ошибка `already_in_use`
redirection_phone_number_id number нет Уникальный идентификатор номера переадресации. Номер переадресации используется только в том случае, если параметр phone_number_id имеет тип `call_tracking`. Список доступных номеров можно получить методом get.campaign_available_redirection_phone_numbers.
Обязателен для заполнения, если в параметре phone_number_id указан виртуальный номер с типом "call_tracking". Если это не так, то будет возвращена ошибка с мнемоникой "required_parameter_missed".
Если параметр задан и в phone_number_id указан виртуальный номер с типом "va", то будет возвращаться ошибка `invalid_parameters_combination`
В параметре могут быть указаны только номера переадресации, которые возвращаются методом get.campaign_available_redirection_phone_numbers. Если это не так, то будет возвращаться ошибка с мнемоникой "invalid_parameter_value"
Доступен, если подключен компонент "va". Если параметр будет заполнен и у вас отсутствует компонент "va", то будет возвращена ошибка с мнемоникой "parameter_component_disabled"
dynamic_call_tracking_enabled boolean нет true, false Активация динамический коллтрекинг. В пул динамического коллтрекинга можно подключить только свободные номера без флага "Использовать в ВАТС" в том же коде, что и номер блока рекламной кампании по умолчанию. При отсутствии необходимого количества номеров они будут автоматически куплены. Звонки на номера из пула динамического коллтрекинга будут обрабатываться по правилам обработки звонков на номер блока рекламной кампании по умолчанию.
Может принимать значение "true", если параметр phone_number_id = va | call_tracking. Если это не так, то будет возвращена ошибка с мнемоникой "invalid_parameters_combination"
Если Вы используете этот параметр, но у вас не подключен компонент "dynamic_call_tracking", то Вам вернется ошибка с мнемоникой "parameter_component_disabled"
Если задан одновременно status = inactive, то будет возвращена ошибка `invalid_parameters_combination`
Если параметр dynamic_call_tracking_enabled имеет значение "true", то параметр dynamic_call_tracking обязателен к заполнению. Будет возвращена ошибка "invalid_parameters_combination".
Динамический коллтрекинг
dynamic_call_tracking object нет Настройка динамический коллтрекинг.
Обязателен к заполнению, если параметр dynamic_call_tracking_enabled у хоть одного блока имеет значение "true" иначе будет возвращена ошибка с мнемоникой "invalid_parameters_combination"
Если Вы используете этот параметр, но у вас не подключен компонент "dynamic_call_tracking", то Вам вернется ошибка с мнемоникой "parameter_component_disabled"
reservation_time enum нет
  • 5m
  • 10m
  • 15m
  • 20m
  • 30m
  • 1h
  • 2h
  • 4h
  • 8h
  • 1d
  • 1w
 Значение по умолчанию "15m".
Период, на который номер закрепляется за посетителем сайта. По истечении указанного времени номер закрепляется за новым посетителем (или остается за текущим в случае наличия свободных номеров коллтрекинга).
count_virtual_numbers number да минимальное значение 1 Количество номеров необходимое для работы динамического коллтрекинга в одном блоке. Указанное количество номеров будет куплено.
count_visits number да минимальное значение 1 Количество посещений по рекламной кампании в сутки
Настройки групп условий
group_conditions array да Максимальное количество групп 30 Группа условий рекламной кампании
Настройки условий
conditions array да Максимальное количество условий для группы 50 Условия рекламной кампании в группе условий
type enum да
  • include
  • exclude
 Условия рекламной кампании в группе условий
  • include - включает
  • exclude - исключает
campaign_parameter enum да Список допустимых значений и возможных операторов см. в таблице "Список параметров и их операторов"
value string да Значение. Для некоторых campaign_parameter может быть свой список допустимых значений см. в таблице "Список параметров и их операторов"
operator enum да =, sub, ~ Оператор в условии. Зависит от используемого параметра campaign_parameter см. в таблице "Список параметров и их операторов"
  • "=" - точно соответствует
  • "sub" - включает
  • "~" - регулярное выражение

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

Название Тип Обязательный Описание
id number да Уникальный идентификатор рекламной кампании

JSON структура запроса

{
  "jsonrpc": "2.0",
  "id": "number",
  "method": "create.campaigns",
  "params": {
    "access_token": "string",
    "user_id": "number",
    "description": "string",
    "name": "string",
    "status": "enum",
    "site_id": "number",
    "site_blocks": [
      {
        "site_block_id": "number",
        "phone_number_id": "number",
        "redirection_phone_number_id": "number",
        "dynamic_call_tracking_enabled": "boolean"
      }
    ],
    "dynamic_call_tracking": {
      "reservation_time": "enum",
      "count_virtual_numbers": "number",
      "count_visits": "number"
    },
    "campaign_conditions": {
      "group_conditions": [
        {
          "conditions": [
            {
              "type": "enum",
              "campaign_parameter": "enum",
              "operator": "enum",
              "value": "string"
            }
          ]
        }
      ]
    }
  }
}

JSON структура ответа

{
  "jsonrpc": "2.0",
  "id": "number",
  "result": {
    "data": {
      "id": "number"
    },
    "metadata": {

    }
  }
}

Список возвращаемых ошибок

Смотрим раздел "Список ошибок для методов с глаголом create"