Описание полей метода POST/leads

Общая структура запроса¶

json
{
  "item": { ... },
  "bucket": { ... },
  "call_scheduler": { ... },
  "check_config": { ... }
}

Поле `bucket`¶

Корзина для лида.

id (string, UUID)

Описание: ID бакета, в который помещается лид
Обязательное: Нет
Использование: Определяет кампанию и настройки обзвона

external_id (string)

Описание: Внешний ID бакета
Использование: Для связи с внешними системами

Передается одно из полей. В случае, когда заполнены оба поля, более приоритетным будет external_id.

Поле `call_scheduler`¶

Планировщик звонков

id (string, UUID)

Описание: ID планировщика звонков
Обязательное: Нет
Использование: Определяет расписание и стратегию звонков

external_id (string)

Описание: Внешний ID планировщика
Использование: Для связи с внешними системами

step (integer)

Описание: Текущий шаг в расписании
По умолчанию: 0
Использование: Для многошаговых стратегий

Поле `check_config`¶

Настройки проверки

normalize (boolean)

Описание: Нормализовать ли телефонные номера
По умолчанию: false
Использование: Приведение номеров к единому формату

duplicate_check (object)

Описание: Настройки проверки дубликатов

Структура:

{
  "filter_field": "bucket_id" (или "campaign_id"),
  "filter_value": "string"
}

Поля:
filter_field - поле для проверки дубликатов
filter_value - значение для фильтрации

Пример полного запроса с обязательными полями¶

{
  "item": {
    "name": "Иван Петров",
    "timezone": 180,
    "phones": [
      {
        "external_id": "phone_1",
        "active": true,
        "type": "mobile",
        "phone": "+79001234567",
        "priority": 100,
        "data": {
          "verified": true
        }
      },
      {
        "external_id": "phone_2",
        "active": true,
        "type": "work",
        "phone": "+74951234567",
        "priority": 50,
        "data": {
          "extension": "123"
        }
      }
    ]
}

Ответ API

Успешный ответ (200)

{
  "success": true,
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "active": true,
    "name": "Иван Петров",
    "priority": 100,
    "timezone": 180,
    "created_at": "2025-08-06T12:38:59.808Z",
    "updated_at": "2025-08-06T12:38:59.808Z"
  }
}

Ошибка (400/422)

{
  "success": false,
  "message": "Validation error",
  "details": "Field 'name' is required"
}

Важные замечания¶

Обязательные поля: name, timezone, phones
UUID форматы: Все ID должны быть в формате UUID v4
Временные зоны: timezone указывается в часах от UTC
Телефоны: Номера должны быть в международном формате
Приоритеты: Чем выше приоритет, тем раньше будет обзвон
Дубликаты: Система автоматически проверяет дубликаты по настройкам