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

ProductCRMIntegrationRead

Связывает продукт с CRM-интеграцией компании и хранит конфигурацию маппинга, используемую для импорта и синхронизации лидов этого продукта. Идентифицируется парой (product_id, crm_integration_id). Отслеживает время последнего импорта и синхронизации.

product_idProduct Idrequired

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

crm_integration_idCrm Integration Idrequired

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

created_atdate-timerequired

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

last_import_at objectrequired

Когда для этого продукта в последний раз импортировали лиды из CRM (UTC).

anyOf
date-time
last_sync_at objectrequired

Когда данные этого продукта в последний раз синхронизировали в CRM (UTC).

anyOf
date-time
config objectrequired

Конфигурация маппинга CRM для продукта (маппинг этапов, маппинг полей, опции синхронизации).

import_enabledImport Enabled

Выполняет ли планировщик регулярный импорт новых лидов с этапов импорта этой CRM. Настройка управляет только массовым импортом: канал, отвечающий на входящие диалоги, импортирует нужный лид по мере необходимости, независимо от неё.

Default value: true
import_to_stage_id object
anyOf
integer
import_interval_secondsImport Interval Seconds
Default value: 86400
pin_import_note_enabledPin Import Note Enabled

Если включено для amoCRM или Kommo, примечание, созданное после импорта лида, закрепляется в сделке. Другие CRM игнорируют эту настройку.

Default value: false
contacts_from_custom_fields object
property name* ProductCRMIntegrationContactFromCustomFieldConfig

Определяет, как одно пользовательское поле CRM импортируется в качестве контакта.

guess_contact_typeGuess Contact Type
Default value: true
contact_type object
anyOf
ContactType

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

channel_type object
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 object
anyOf
string
channel_vendor object
anyOf
string

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

channel_alias object

Необязательное точное имя другого поля CRM, значение которого выбирает канал продукта для этого контакта типа chat_id. Поддерживается только для контактов chat_id и несовместимо с ext_channel_id.

anyOf
string
enum_fields object
property name* ProductCRMIntegrationEnumFieldConfig
typeTyperequired

Possible values: [select, multiselect]

optionsstring[]
crm_fields object
property name* ProductCRMIntegrationFieldConfig
crm_code object
anyOf
string
field_typeField Type
Default value: text
sourceSource

Possible values: [custom, system]

Default value: custom
is_multipleIs Multiple
Default value: false
import_enabledImport Enabled
Default value: false
is_read_onlyIs Read Only
Default value: false
options object[]
  • Array [
    • labelLabelrequired

    Вариант в том виде, в каком его читает человек.

    valueValuerequired

    Вариант в том виде, в каком он хранится и сравнивается.

    ext_id object

    Собственный идентификатор варианта в CRM, если она его предоставляет. Именно он записывается обратно в CRM, поэтому переименование варианта не ломает сопоставление. Заполняется платформой.

    anyOf
    string
  • ]
    • contact_duplicates_allowedContact Duplicates Allowed
    Default value: false
    contact_crm_id_duplicates_allowedContact Crm Id Duplicates Allowed

    Когда contact_duplicates_allowed равно true, разрешает импортировать один внешний CRM ID контакта в контакты разных локальных лидов при первичном импорте и дальнейшей синхронизации контактов. По умолчанию false; при выключенном contact_duplicates_allowed настройка не действует.

    Default value: false
    crm_fields_conditions object

    Необязательный фильтр импорта: лид из CRM, поля которого не проходят условия, не импортируется. Пропуск нигде не фиксируется, поэтому после смягчения условий лид импортируется на одном из следующих запусков, пока он остаётся на этапе импорта. В проверку попадают только поля с import_enabled, поэтому условие по любому другому полю не совпадёт ни с чем и отсеет все лиды.

    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
  • ]
    • derive_phone_number_from_lead_titleDerive Phone Number From Lead Title
    Default value: true
    amocrm_allowed_inbound_source_idsstring[]

    Только для amoCRM. Из каких подключённых источников чатов клиент может начать диалог с агентом — по идентификатору источника amoCRM. Оставьте пустым, чтобы принимать любой источник. Проверяется только для лида, который ещё ни разу не импортировался: если лид уже есть, диалог с ним уже начат, и эта настройка не помешает агенту отвечать.

    amocrm_inbound_max_lead_age_secondsAmocrm Inbound Max Lead Age Seconds

    Только для amoCRM. Насколько недавно лид должен быть создан в amoCRM, чтобы агент начал отвечать в его чате. Без ограничения включение входящих подключило бы агента ко всем давним диалогам источника — по мере того, как каждый клиент написал бы в следующий раз. Укажите 0, чтобы снять ограничение. Как и список источников, применяется только к лиду, который ещё ни разу не импортировался.

    Possible values: >= 0

    Default value: 3600
    sync_enabledSync Enabled
    Default value: false
    sync_interval_secondsSync Interval Seconds
    Default value: 86400
    deactivate_on_external_moveDeactivate On External Move
    Default value: false
    merged_lead_stage_id object

    Этап, на который переводятся лиды, чья сделка объединена с другой (см. POST /leads/crm-merge). Этап должен принадлежать этому продукту. Если не задан, присоединённые лиды деактивируются и их диалоги отключаются без смены этапа. Перевод выполняется только локально и никогда не отправляется обратно в CRM.

    anyOf
    integer
    classification_fields_resync_requested_at object
    anyOf
    date-time
    classification_fields_last_resynced_at object
    anyOf
    date-time
    classification_fields_last_resync_failed_at object
    anyOf
    date-time
    classification_fields_last_resync_failures_countClassification Fields Last Resync Failures Count
    Default value: 0
    dump_message_enabledDump Message Enabled
    Default value: true
    dump_manager_messages_enabledDump Manager Messages Enabled
    Default value: true
    create_crm_lead_for_new_inboundCreate Crm Lead For New Inbound

    Включает автоматическое создание сделки или лида в Bitrix24 для подходящего нового входящего лида, у которого ещё нет записи в CRM. Тип создаваемого объекта определяется настройкой lead_mode, а попадает он в воронку и на этап из inbound_crm_lead_pipeline_id / inbound_crm_lead_stage_id; по умолчанию выключено.

    Default value: false
    inbound_crm_lead_pipeline_id object

    Воронка, в которой создаётся запись из create_crm_lead_for_new_inbound, и одновременно воронка, которая записывается лиду как исходная. Должна быть среди воронок, указанных в pipelines, иначе запись не создаётся: лид с несопоставленной исходной воронкой никогда не сможет синхронизировать переходы по этапам. По умолчанию «0» — воронка сделок по умолчанию в CRM и единственная воронка, о которой сообщает интеграция, работающая с лидами, а не со сделками.

    anyOf
    string
    inbound_crm_lead_stage_id object

    Этап, на котором создаётся запись из create_crm_lead_for_new_inbound. Если не задан, используется первый этап этой воронки.

    anyOf
    string
    generate_summary_on_conversionGenerate Summary On Conversion

    При конвертации лида в сделку составить резюме переписки и добавить его комментарием к новой сделке. Резюме формируется в момент конвертации, а не берётся из сохранённых, поэтому отражает тот разговор, в котором сделка была выиграна.

    Default value: false
    summary_on_conversion_additional_instructions object

    Дополнительные указания для этого резюме — что важно прочитать менеджеру, который берёт сделку в работу. Резюме кэшируются отдельно для каждого набора указаний, поэтому при заданном значении резюме для конвертации всегда формируется отдельно от резюме самого агента.

    anyOf
    string
    pipelines object[]
  • Array [
    • is_activeIs Active
    Default value: true
    pipeline_idPipeline Id
    Default value:
    stages object
    property name* ProductCRMIntegrationStageConfig

    Сопоставляет этап платформы с этапом в CRM и описывает, что ещё происходит, когда лид попадает на этот этап.

    crm_idCrm Idrequired

    Идентификатор этапа в CRM, которому соответствует этап платформы.

    is_import_stageIs Import Stage

    Импортировать ли в платформу лидов, находящихся на этом этапе CRM.

    Default value: false
    convert_lead_to_dealConvert Lead To Deal

    При переходе лида на этот этап дополнительно создать сделку, в которую он конвертируется. Только для Bitrix24, работающего с лидами: в остальных случаях лид и есть сделка. Настройка задаётся для каждого этапа, поэтому разные этапы могут конвертировать в разные воронки. Этап при этом всё равно должен быть сопоставлен со статусом CRM, на котором лид должен оказаться: конвертация создаёт сделку, но сама лид не перемещает.

    Default value: false
    converted_deal_category_id object

    Воронка, в которой создаётся сделка. Если не задана, используется воронка CRM по умолчанию.

    anyOf
    string
    converted_deal_stage_id object

    Этап, на котором создаётся сделка. Если не задан, используется первый этап воронки.

    anyOf
    string
    openlines_transfer_to_operatorOpenlines Transfer To Operator
    Default value: false
  • ]
    • ProductCRMIntegrationRead
    {
      "product_id": 0,
      "crm_integration_id": 0,
      "created_at": "2024-07-29T15:51:28.071Z",
      "last_import_at": "2024-07-29T15:51:28.071Z",
      "last_sync_at": "2024-07-29T15:51:28.071Z",
      "config": {
        "import_enabled": true,
        "import_to_stage_id": 0,
        "import_interval_seconds": 86400,
        "pin_import_note_enabled": false,
        "contacts_from_custom_fields": {},
        "enum_fields": {},
        "crm_fields": {},
        "contact_duplicates_allowed": false,
        "contact_crm_id_duplicates_allowed": false,
        "crm_fields_conditions": {
          "operator": "AND",
          "conditions": [
            {
              "field": "string",
              "operator": "EQUALS"
            }
          ]
        },
        "derive_phone_number_from_lead_title": true,
        "amocrm_allowed_inbound_source_ids": [
          "string"
        ],
        "amocrm_inbound_max_lead_age_seconds": 3600,
        "sync_enabled": false,
        "sync_interval_seconds": 86400,
        "deactivate_on_external_move": false,
        "merged_lead_stage_id": 0,
        "classification_fields_resync_requested_at": "2024-07-29T15:51:28.071Z",
        "classification_fields_last_resynced_at": "2024-07-29T15:51:28.071Z",
        "classification_fields_last_resync_failed_at": "2024-07-29T15:51:28.071Z",
        "classification_fields_last_resync_failures_count": 0,
        "dump_message_enabled": true,
        "dump_manager_messages_enabled": true,
        "create_crm_lead_for_new_inbound": false,
        "inbound_crm_lead_pipeline_id": "string",
        "inbound_crm_lead_stage_id": "string",
        "generate_summary_on_conversion": false,
        "summary_on_conversion_additional_instructions": "string",
        "pipelines": [
          {
            "is_active": true,
            "pipeline_id": "",
            "stages": {}
          }
        ]
      }
    }