Skip to content

Latest commit

 

History

History
310 lines (256 loc) · 13.2 KB

crm-lead-add.md

File metadata and controls

310 lines (256 loc) · 13.2 KB
Raw

Создать новый лид crm.lead.add

{% note warning "Мы еще обновляем эту страницу" %}

Тут может не хватать некоторых данных — дополним в ближайшее время

{% endnote %}

Scope: crm

Кто может выполнять метод: любой пользователь с правом на создание лидов

Метод создает новый лид.

{% include Сноска о параметрах %}

#| || Название тип | Описание | Ревизия || || fields* object | В массиве необходимо указать значения конкретных полей лида ("field"=>"value"[, ...]). Перечень возможных полей | 1 || || options object | Необязательный массив опций ("optionName"=>"value"[, ...]). Перечень возможных полей описан ниже | 1 || |#

Параметр fields

#| || Поле / Тип | Описание || || ADDRESS string | Адрес контакта || || ADDRESS_2 string | Вторая страница адреса. В некоторых странах принято разбивать адрес на 2 части || || ADDRESS_CITY string | Город. || || ADDRESS_COUNTRY string | Страна. || || ADDRESS_COUNTRY_CODE string | Код страны. || || ADDRESS_POSTAL_CODE string | Почтовый индекс. || || ADDRESS_PROVINCE string | Область. || || ADDRESS_REGION string | Район. || || ADDRESS_LOC_ADDR_ID string | Используется только для внутренних целей. || || ASSIGNED_BY_ID user | Ответственный. || || BIRTHDATE date | Дата рождения. || || COMMENTS string | Комментарии. || || COMPANY_ID crm_company | Привязка лида к компании. || || COMPANY_TITLE string | Название компании, указанное в соответствующем поле лида. Для привязки существующей компании стоит передавать её id в поле COMPANY_ID. || || CONTACT_ID crm_contact | Привязка лида к контакту. || || CONTACT_IDS crm_contact | Идентификатор привязанного контакта. Множественный. При использовании crm.deal.update и crm.deal.add можно подать массив контактов. В методах crm.deal.list и crm.deal.get поля нет и необходимо использовать crm.deal.contact.items.get для получения списка контактов. Для очистки поля используйте crm.deal.contact.items.delete, для замены значения используйте crm.deal.contact.items.set. || || CURRENCY_ID crm_currency | Идентификатор валюты. || || EMAIL crm_multifield | Адрес электронной почты. Множественное. || || HONORIFIC crm_status | Вид обращения. || || IM crm_multifield | Мессенджер. Множественное. || || LINK crm_multifield | ID пользователя, привязанного через открытую линию. Множественное. || || LAST_NAME string | Фамилия || || NAME string | Имя || || OPENED char | Признак доступности лида для всех. Допустимые значения Y или N. || || OPPORTUNITY double | Сумма. || || IS_MANUAL_OPPORTUNITY char | Признак ручного режима расчёта суммы. Допустимые значения Y или N.|| || ORIGINATOR_ID string | Идентификатор источника данных.

Используется только для привязки к внешнему источнику || || ORIGIN_ID string | Идентификатор элемента в источнике данных. Используется только для привязки к внешнему источнику. || || PHONE crm_multifield | Телефон. Множественное. || || POST string | Должность. || || SECOND_NAME string | Отчество || || SOURCE_DESCRIPTION string | Описание источника. || || SOURCE_ID crm_status | Идентификатор источника. Значения по умолчанию:

#| ||SOURCE_ID|Название|| ||CALL|Звонок|| ||EMAIL|Электронная почта|| ||WEB|Веб-сайт|| ||ADVERTISING|Реклама|| ||PARTNER|Существующий клиент|| ||RECOMMENDATION|По рекомендации|| ||TRADE_SHOW|Выставка|| ||WEBFORM|CRM-форма|| ||CALLBACK|Обратный звонок|| ||RC_GENERATOR|Генератор продаж|| ||STORE|Интернет-магазин|| ||OTHER|Другое|| |#

Список всех возможных идентификаторов из справочника можно получить методом crm.status.list с фильтром filter[ENTITY_ID]=SOURCE || || STATUS_DESCRIPTION string | Дополнительно о стадии || || STATUS_ID crm_status | Идентификатор стадии лида. Стадии по умолчанию:

#| ||STATUS_ID|Название|| ||NEW | Не обработан|| ||IN_PROCESS | В работе|| ||PROCESSED | Обработан|| ||JUNK | Некачественный лид|| ||CONVERTED | Качественный лид|| |#

Список всех возможных стадий из справочника можно получить методом crm.status.list с фильтром filter[ENTITY_ID]=STATUS || || TITLE string | Название лида. || || UTM_CAMPAIGN string | Обозначение рекламной кампании. || || UTM_CONTENT string | Содержание кампании. Например, для контекстных объявлений. || || UTM_MEDIUM string | Тип трафика. CPC (объявления), CPM (баннеры). || || UTM_SOURCE string | Рекламная система. Yandex-Direct, Google-Adwords и другие. || || UTM_TERM string | Условие поиска кампании. Например, ключевые слова контекстной рекламы. || || WEB crm_multifield | Сайт. Множественное. || || ufCrm_ххх | пользовательские поля. Смотри раздел {#T} || |#

{% note info %}

Так же, чтобы узнать требуемый формат полей, можно выполнить метод crm.lead.fields и посмотреть формат пришедших значений этих полей.

{% endnote %}

{% note info %}

При добавлении лида нельзя явно установить признак повторного лида (поле IS_RETURN_CUSTOMER), однако, это поле автоматически принимает значение Y, если при добавлении лида указать значение для COMPANY_ID или CONTACT_ID

{% endnote %}

Параметр options

#| || Параметр / Тип | Описание | Ревизия || || REGISTER_SONET_EVENT boolean | произвести регистрацию события добавления лида в живой ленте. Дополнительно будет отправлено уведомление ответственному за лид. | 1 || |#

{% include Сноска о параметрах %}

Примеры

{% list tabs %}

  • cURL (Webhook)

    // пример для cURL (Webhook)

  • cURL (OAuth)

    // пример для cURL (OAuth)

  • JS

    BX24.callMethod(
    "crm.lead.add",
    {
        fields:
        {
            TITLE: "ИП Титов",
            NAME: "Глеб",
            SECOND_NAME: "Егорович",
            LAST_NAME: "Титов",
            STATUS_ID: "NEW",
            OPENED: "Y",
            ASSIGNED_BY_ID: 1,
            CURRENCY_ID: "USD",
            OPPORTUNITY: 12500,
            PHONE: [
                { 
                    VALUE: "555888",
                    VALUE_TYPE: "WORK",
                },
            ] ,
            WEB: [
                    {
                    VALUE: "www.mysite.com",
                    VALUE_TYPE: "WORK",
                    }
            ],
        },
        params: {
            REGISTER_SONET_EVENT: "Y",
        }
    },
    (result) => {
        if (result.error())
        {
            console.error(result.error());
            
            return;
        }
        
        console.info(`Создан лид с ID ${result.data()}`);
    }
);

  • PHP

    // пример для php

{% endlist %}

{% include Сноска о примерах %}

Ответ в случае успеха

200 OK

{
    "result": 3465,
    "time": {
        "start": 1705764932.998683,
        "finish": 1705764937.173995,
        "duration": 4.1753120422363281,
        "processing": 3.3076529502868652,
        "date_start": "2024-01-20T18:35:32+03:00",
        "date_finish": "2024-01-20T18:35:37+03:00",
        "operating_reset_at": 1705765533,
        "operating": 3.3076241016387939
    }
}

Возвращаемые данные

#| || Значение / Тип | Описание || || result integer| Идентификатор созданного лида || || time array | Информация о времени выполнения запроса || || start double | Timestamp момента инициализации запроса || || finish double | Timestamp момента завершения выполнения запроса || || duration double | Как долго в миллисекундах выполнялся запрос (finish - start) || || date_start string | Строковое представление даты и времени момента инициализации запроса || || date_finish double | Строковое представление даты и времени момента завершения запроса || || operating_reset_at timestamp | Timestamp момента, когда будет сброшен лимит на ресурсы REST API. Читайте подробности в статье лимит на операции || || operating double | Через сколько миллисекунд будет сброшен лимит на ресурсы REST API? Читайте подробности в статье лимит на операции || |#

Ответ в случае ошибки

HTTP-статус: 40x, 50x Error

{
    "error": "",
    "error_description": "Access denied."
}

{% include notitle обработка ошибок %}

Возможные ошибки

#|
|| Код | Текст ошибки | Описание || || Пустое значение | Access denied. | У пользователя нет прав на добавление лида || |#

{% include системные ошибки %}

Продолжите изучение