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

LeadWithContactsResponse

Результат создания лида с контактами — созданный лид и его созданные контакты.

lead objectrequired

Лид — потенциальный клиент, который ведётся по воронке. Лид принадлежит ровно одному продукту, находится на одном этапе воронки и объединяет один или несколько контактов (адреса, по которым с человеком связываются). Лиды создаются через API или импортируются из подключённой CRM.

idIdrequired

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

product_idProduct Idrequired

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

customer_id object

Канонический идентификатор клиента на уровне компании, связывающий лид с эпизодами общения в других продуктах и каналах; null для ещё не сопоставленных записей.

anyOf
integer
stage_idStage Idrequired

Идентификатор этапа воронки.

stage_set_at objectrequired

Когда лид перешёл на текущий этап (UTC).

anyOf
date-time
start_modeLeadStartModerequired

Как лид попал в систему. "outbound" — лид уже существовал в базе, и по нему запустили исходящую рассылку. "inbound" — лида раньше не было, он создан из входящего сообщения в известном канале, у привязки которого к агенту включён приём входящих (AgentChannelConfig.inbound_enabled).

Possible values: [inbound, outbound]

started_at object

Когда у лида впервые появилась значимая активность в диалоге (неизменяемая точка отсчёта когорты, UTC).

anyOf
date-time
started_dialogue_id object

Идентификатор диалога, с которого началась активность по лиду (неизменяемая точка отсчёта).

anyOf
integer
first_outreach_dialogue_id object

Идентификатор первого исходящего (outreach) диалога по лиду (неизменяемая точка отсчёта).

anyOf
integer
first_reply_dialogue_id object

Идентификатор первого диалога, в котором лид ответил (неизменяемая точка отсчёта).

anyOf
integer
name objectrequired

Отображаемое имя лида.

anyOf
string
crm_id objectrequired

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

anyOf
string
crm_fields objectrequired

Произвольные пары ключ/значение, синхронизируемые с внешней CRM в обе стороны.

property name* object
anyOf
string
created_atdate-timerequired

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

updated_atdate-timerequired

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

is_testIs Test

Помечает тестового лида; исключается из продуктовых метрик.

Default value: false
batch_name objectrequired

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

anyOf
string
timezone objectrequired

Часовой пояс IANA (например, "Europe/Moscow"), используемый для планирования отправки в рабочие часы.

anyOf
string
status objectrequired

Необязательная произвольная строка статуса.

anyOf
string
is_activeIs Activerequired

Активен ли лид. Деактивированные лиды исключаются из рассылок и автоматизаций.

from_crm_integration_id objectrequired

Идентификатор интеграции с CRM, из которой импортирован лид, если применимо.

anyOf
integer
from_pipeline_id objectrequired

Идентификатор исходной воронки CRM, из которой импортирован лид, если применимо.

anyOf
string
crm_missing_since object

Заполняется, когда соответствующую запись в CRM больше не удаётся найти (UTC); null, пока запись в CRM существует.

anyOf
date-time
crm_external_takeover_since object

Заполняется, когда запись в CRM переходит в несопоставленную воронку или этап (UTC); null, пока лид остаётся в сопоставленном состоянии CRM.

anyOf
date-time
merged_into_lead_id object

Заполняется, когда сделка лида была объединена с другой сделкой на стороне CRM: идентификатор лида, за которым закреплена уцелевшая сделка. Сам лид сохраняет тот crm_id, с которым был импортирован (эта сделка больше не существует), деактивируется, а его диалоги отключаются. Для обычных лидов — null.

anyOf
integer
merged_at object

Когда лид был объединён с другим лидом (UTC); для обычных лидов — null.

anyOf
date-time
contacts object[]required
  • Array [
    • idIdrequired

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

    lead_idLead Idrequired

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

    product_idProduct Idrequired

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

    customer_id object

    Канонический идентификатор клиента на уровне компании, общий для контактов и диалогов, сопоставленных с одним реальным клиентом; null для ещё не сопоставленных записей.

    anyOf
    integer
    contactContactrequired

    Само значение адреса — например, номер телефона, username, chat_id или email.

    contact_typeContactTyperequired

    Вид адреса — phone, username, chat_id или email.

    Possible values: [phone, username, chat_id, email]

    channel_type objectrequired

    Мессенджер, в котором действителен адрес. null означает универсальный адрес (обычно номер телефона).

    anyOf
    string

    Possible values: [telegram, whatsapp, waba, max, viber, instagram, fasttrack, usedesk, salebot, avito, vk, yandex_messenger, email, sms, pinbox, linkedin, amocrm_salesbot, bitrix24_openlines, sip, webrtc, bothelp]

    ext_channel_id objectrequired

    Необязательная привязка к конкретному внешнему каналу; сужает область применения адреса.

    anyOf
    string
    channel_vendor objectrequired

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

    anyOf
    string

    Possible values: [wazzup24, self_wz, chatpush, greenapi, wappi, chatapp, yandex_messenger, salebot, bothelp, radist, fasttrack, usedesk, amocrm_salesbot, bitrix24_openlines, twilio, mail.ru, gmail, pinbox, unipile, voice]

    created_atdate-timerequired

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

    is_mainIs Mainrequired

    Является ли контакт основным для лида.

    crm_id object

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

    anyOf
    string
    contact_sourceContactSourcerequired

    Источник появления контакта (например, api, custom_field, default_field, derived_title).

    Possible values: [custom_field, default_field, derived_title, api, unknown]

    source_name object

    Произвольная метка, описывающая происхождение контакта.

    anyOf
    string
    last_dialogue_id objectrequired

    Идентификатор последнего диалога, который вёлся через этот контакт.

    anyOf
    integer
    skip_routingSkip Routingrequired

    Если true, контакт исключается из автоматической маршрутизации исходящих рассылок.

    waba_window_open_until objectrequired

    Для контактов WhatsApp Business API — когда закрывается текущее 24-часовое окно свободной переписки (UTC).

    anyOf
    date-time
    waba_windows_openedWaba Windows Openedrequired

    Сколько окон переписки WABA уже было открыто для этого контакта.

  • ]
    • LeadWithContactsResponse
    {
      "lead": {
        "id": 0,
        "product_id": 0,
        "customer_id": 0,
        "stage_id": 0,
        "stage_set_at": "2024-07-29T15:51:28.071Z",
        "start_mode": "inbound",
        "started_at": "2024-07-29T15:51:28.071Z",
        "started_dialogue_id": 0,
        "first_outreach_dialogue_id": 0,
        "first_reply_dialogue_id": 0,
        "name": "string",
        "crm_id": "string",
        "crm_fields": {},
        "created_at": "2024-07-29T15:51:28.071Z",
        "updated_at": "2024-07-29T15:51:28.071Z",
        "is_test": false,
        "batch_name": "string",
        "timezone": "string",
        "status": "string",
        "is_active": true,
        "from_crm_integration_id": 0,
        "from_pipeline_id": "string",
        "crm_missing_since": "2024-07-29T15:51:28.071Z",
        "crm_external_takeover_since": "2024-07-29T15:51:28.071Z",
        "merged_into_lead_id": 0,
        "merged_at": "2024-07-29T15:51:28.071Z"
      },
      "contacts": [
        {
          "id": 0,
          "lead_id": 0,
          "product_id": 0,
          "customer_id": 0,
          "contact": "string",
          "contact_type": "phone",
          "channel_type": "telegram",
          "ext_channel_id": "string",
          "channel_vendor": "wazzup24",
          "created_at": "2024-07-29T15:51:28.071Z",
          "is_main": true,
          "crm_id": "string",
          "contact_source": "custom_field",
          "source_name": "string",
          "last_dialogue_id": 0,
          "skip_routing": true,
          "waba_window_open_until": "2024-07-29T15:51:28.071Z",
          "waba_windows_opened": 0
        }
      ]
    }