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

ProductCRMIntegrationCreate

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

product_idProduct Idrequired

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

crm_integration_idCrm Integration Idrequired

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

config objectrequired

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

import_enabledImport Enabled
Default value: true
import_to_stage_id object
anyOf
integer
import_interval_secondsImport Interval Seconds
Default value: 86400
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, 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
  • ]
    • contact_duplicates_allowedContact Duplicates Allowed
    Default value: false
    derive_phone_number_from_lead_titleDerive Phone Number From Lead Title
    Default value: true
    allow_empty_amocrm_salesbot_contactsAllow Empty Amocrm Salesbot Contacts

    Если включено для импорта amoCRM Salesbot, контакты без телефона, email, username или chat id импортируются как Salesbot-only placeholder-контакты типа chat_id, привязанные к идентификатору контакта amoCRM.

    Default value: false
    allow_empty_bitrix24_openlines_contactsAllow Empty Bitrix24 Openlines Contacts

    Если включено для импорта Bitrix24, CRM-объекты без обычных контактных данных импортируются с синтетическим контактом типа chat_id, чтобы исходящие сообщения могли использовать активный чат Открытых линий.

    Default value: false
    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
    pipelines object[]
  • Array [
    • is_activeIs Active
    Default value: true
    pipeline_idPipeline Id
    Default value:
    stages object
    property name* ProductCRMIntegrationStageConfig
    crm_idCrm Idrequired

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

    is_import_stageIs Import Stage
    Default value: false
  • ]
    • last_import_at object

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

    anyOf
    date-time
    last_sync_at object

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

    anyOf
    date-time
    ProductCRMIntegrationCreate
    {
      "product_id": 0,
      "crm_integration_id": 0,
      "config": {
        "import_enabled": true,
        "import_to_stage_id": 0,
        "import_interval_seconds": 86400,
        "contacts_from_custom_fields": {},
        "enum_fields": {},
        "crm_fields": {},
        "contact_duplicates_allowed": false,
        "derive_phone_number_from_lead_title": true,
        "allow_empty_amocrm_salesbot_contacts": false,
        "allow_empty_bitrix24_openlines_contacts": false,
        "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,
        "pipelines": [
          {
            "is_active": true,
            "pipeline_id": "",
            "stages": {}
          }
        ]
      },
      "last_import_at": "2024-07-29T15:51:28.071Z",
      "last_sync_at": "2024-07-29T15:51:28.071Z"
    }