WT Amo CRM library - Документация
Категория: Библиотеки
Проект Версии Документация GitHub

Метод getLeadsCustomFields

Метод для получения списка полей для сделок AmoCRM

Реализуемый метод API

GET /api/v4/leads/custom_fields

Официальная документация метода

Описание

  • Метод позволяет получить список полей сущности в аккаунте.

Ограничения

  • Метод возвращает до 50 полей за один запрос.
  • Метод доступен всем пользователям аккаунта.
  • В отличие от официальной документации, метод данной библиотеки пока что не принимает дополнительные параметры запроса.

Параметры ответа

ПараметрТип данныхОписание
id int ID поля
name string Название поля
code string Код поля, по которому можно обновлять значение в сущности, без передачи ID поля
sort int Сортировка поля
type string Тип поля. Список доступных полей
entity_type string Тип сущности (leads, contacts, companies, segments, customers, catalogs)
is_computed bool Параметр отвечает за определение типа поля как "вычисляемое" (computed) поле. Данный ключ возвращается только при получении списка полей сделки
is_predefined bool Является ли поле предустановленным. Данный ключ возвращается только при получении списка полей контактов и компаний
is_deletable bool Доступно ли поле для удаления. Данный ключ возвращается только при получении списка полей контактов и компаний
is_visible bool Отображается ли поле в интерфейсе списка. Данный ключ возвращается только при получении списка полей списков (каталогов)
is_deletable bool Можно ли удалить поле из интерфейса. Данный ключ возвращается только при получении списка полей списков (каталогов)
is_required bool Обязательно ли поле для заполнения при создании элемента списка. Данный ключ возвращается только при получении списка полей списков (каталогов)
settings array
null		 Настройки поля. Данный ключ возвращается только при получении списка полей списков (каталогов)
remind string
null		 Когда напоминать о дне рождения (never – никогда, day – за день, week – за неделю, month – за месяц). Значение данного поля доступно только для поля типа birthday. Данный ключ возвращается только при получении списка полей контактов, сделок и компаний
currency string(3)
null		 Код валюты поля. Применимо только для типа поля – monetary. Для других типов полей – null.
enums array
null		 Доступные значения для поля. Значение данного поля доступно только для полей с поддержкой enum
enums[0] object Доступное значение для поля
enums[0][id] int ID значения
enums[0][value] string Значение
enums[0][sort] int Сортировка значения
enums[0][code] string
null		 Символьный код значения
nested array
null		 Вложенные значения. Данные ключ возвращается только при получении списка полей каталогов и значение доступно только для поля category
nested[0] object Модель вложенного значения. Данные ключ возвращается только при получении списка полей каталогов и значение доступно только для поля category
nested[0][id] int ID вложенного значения. Данные ключ возвращается только при получении списка полей каталогов и значение доступно только для поля category
nested[0][parent_id] int ID родительского вложенного значения. Данные ключ возвращается только при получении списка полей каталогов и значение доступно только для поля category
nested[0][value] string Значение вложенного значения. Данные ключ возвращается только при получении списка полей каталогов и значение доступно только для поля category
nested[0][sort] int Сортировка вложенного значения. Данные ключ возвращается только при получении списка полей каталогов и значение доступно только для поля category
is_api_only bool Доступно ли поле для редактирования только через API. Данный ключ возвращается только при получении списка полей контактов, сделок и компаний
group_id string
null		 ID группы полей, в которой состоит данное поле. Данный ключ возвращается только при получении списка полей контактов, сделок, покупателей и компаний
required_statuses array
null		 Обязательные поля для смены этапов. Данный ключ возвращается только при получении списка полей контактов, сделок и компаний
required_statuses[0] object Модель обязательного поля для смены этапов. Данный ключ возвращается только при получении списка полей контактов, сделок и компаний
required_statuses[0][status_id] int ID статуса, для перехода в который данное поле обязательно к заполнению. Данный ключ возвращается только при получении списка полей контактов, сделок и компаний
required_statuses[0][pipeline_id] int ID воронки, для перехода в который данное поле обязательно к заполнению. Данный ключ возвращается только при получении списка полей контактов, сделок и компаний
hidden_statuses array Настройка скрытия полей. Поля скрываются в интерфейсе в зависимости от статуса. Данный ключ возвращается только при получении списка полей сделок.
hidden_statuses[0] object Модель настройки скрытия полей.
hidden_statuses[0][status_id] int ID статуса, в котором поле скрыто
hidden_statuses[0][pipeline_id] int ID воронки, в котором поле скрыто
chained_lists array
null		 Настройка поля типа chained_list. Данный ключ возвращается только при получении списка полей сделок и покупателей.
chained_lists[0] object Модель настройки связанного списка.
chained_lists[0][title] string
null		 Название связанного списка, которое отображается в карточке
chained_lists[0][catalog_id] int ID каталога
chained_lists[0][parent_catalog_id] int ID родительского каталога
tracking_callback string Сallback js-функция, которая будет выполнена на странице с CRM Plugin и формой amoCRM при отправке данных. Данное значение возвращается для полей типа tracking_data
search_in string
null		 ID списка или символьный код (contacts, companies, contacts_and_companies) для поля типа Связь с другим элементов (linked_entity).

Возвращаемые значения

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

Возвращаемое значение соответствует документации AmoCRM для этого метода.

Пример ответа

Пример ответа AmoCRM на запрос списка воронок продаж:

stdClass Object
(
    [_total_items] => 25
    [_page] => 1
    [_page_count] => 1
    [_links] => stdClass Object
        (
            [self] => stdClass Object
                (
                    [href] => https://yourdomain.amocrm.ru/api/v4/leads/custom_fields?page=1&limit=250
                )

        )

    [_embedded] => stdClass Object
        (
            [custom_fields] => Array
                (
                    [0] => stdClass Object
                        (
                            [id] => 776243
                            [name] => utm_source
                            [type] => tracking_data
                            [account_id] => 29145994
                            [code] => UTM_SOURCE
                            [sort] => 509
                            [is_api_only] => 1
                            [enums] => 
                            [group_id] => statistic
                            [required_statuses] => Array
                                (
                                )

                            [is_deletable] => 
                            [is_predefined] => 1
                            [entity_type] => leads
                            [tracking_callback] => 
                            [remind] => 
                            [triggers] => Array
                                (
                                )

                            [currency] => 
                            [hidden_statuses] => Array
                                (
                                )

                            [chained_lists] => 
                            [_links] => stdClass Object
                                (
                                    [self] => stdClass Object
                                        (
                                            [href] => https://yourdomain.amocrm.ru/api/v4/leads/custom_fields/776243?page=1&limit=250
                                        )

                                )

                        )

                    [1] => stdClass Object
                        (
                            [id] => 776245
                            [name] => utm_medium
                            [type] => tracking_data
                            [account_id] => 29145994
                            [code] => UTM_MEDIUM
                            [sort] => 510
                            [is_api_only] => 1
                            [enums] => 
                            [group_id] => statistic
                            [required_statuses] => Array
                                (
                                )

                            [is_deletable] => 
                            [is_predefined] => 1
                            [entity_type] => leads
                            [tracking_callback] => 
                            [remind] => 
                            [triggers] => Array
                                (
                                )

                            [currency] => 
                            [hidden_statuses] => Array
                                (
                                )

                            [chained_lists] => 
                            [_links] => stdClass Object
                                (
                                    [self] => stdClass Object
                                        (
                                            [href] => https://yourdomain.amocrm.ru/api/v4/leads/custom_fields/776245?page=1&limit=250
                                        )

                                )

                        )

                    [2] => stdClass Object
                        (
                            [id] => 776247
                            [name] => utm_campaign
                            [type] => tracking_data
                            [account_id] => 29145994
                            [code] => UTM_CAMPAIGN
                            [sort] => 511
                            [is_api_only] => 1
                            [enums] => 
                            [group_id] => statistic
                            [required_statuses] => Array
                                (
                                )

                            [is_deletable] => 
                            [is_predefined] => 1
                            [entity_type] => leads
                            [tracking_callback] => 
                            [remind] => 
                            [triggers] => Array
                                (
                                )

                            [currency] => 
                            [hidden_statuses] => Array
                                (
                                )

                            [chained_lists] => 
                            [_links] => stdClass Object
                                (
                                    [self] => stdClass Object
                                        (
                                            [href] => https://yourdomain.amocrm.ru/api/v4/leads/custom_fields/776247?page=1&limit=250
                                        )

                                )

                        )

                    [3] => stdClass Object
                        (
                            [id] => 776249
                            [name] => utm_term
                            [type] => tracking_data
                            [account_id] => 29145994
                            [code] => UTM_TERM
                            [sort] => 512
                            [is_api_only] => 1
                            [enums] => 
                            [group_id] => statistic
                            [required_statuses] => Array
                                (
                                )

                            [is_deletable] => 
                            [is_predefined] => 1
                            [entity_type] => leads
                            [tracking_callback] => 
                            [remind] => 
                            [triggers] => Array
                                (
                                )

                            [currency] => 
                            [hidden_statuses] => Array
                                (
                                )

                            [chained_lists] => 
                            [_links] => stdClass Object
                                (
                                    [self] => stdClass Object
                                        (
                                            [href] => https://yourdomain.amocrm.ru/api/v4/leads/custom_fields/776249?page=1&limit=250
                                        )

                                )

                        )
                )

        )

)

HTTP 40x Неудачный ответ

Официальная документация говорит о возможном коде ответа 401 Пользователь не авторизован. Библиотека WT Amocrm возвращает объект ошибки следующей структуры:

stdClass Object
(
    [error_code] => 404
    [error_message] => getLeadsCustomFields function: Error while trying to get leads custom fields list from Amo CRM. Amo CRM API response: title: Not Found
type: https://httpstatus.es/404
status: 404
detail: Cannot GET https://yourdomain.amocrm.ru/leads/custom_fields1!

)

В данном примере в названии метода AmoCRM API специально допущена опечатка для демонстрации ответа с ошибкой.

Пример использования в коде

<?php
use Webtolk\Amocrm\Amocrm;
defined('_JEXEC') or die;

$amocrm         = new Amocrm();
$result_amo_crm = $amocrm->getLeadsCustomFields();

Расширения Joomla WebTolk

90 Всего расширений
11 Категорий
401 Выпущено версий
396982 Всего скачиваний

Личный кабинет

Корзина
Корзина пуста
Сумма 0 ₽
В корзину Оформить