Получить список адресов по фильтру crm.address.list

Scope: crm

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

Метод возвращает список адресов по фильтру.

Адреса перемещены в реквизиты. В карточке CRM они имеют отображение в виде отдельного поля.

К объекту CRM могут быть привязаны несколько реквизитов. Внутри реквизита может быть несколько адресов (каждый своего типа).

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

Название `тип`	Описание
select `array`	Массив со списком полей, которые необходимо выбрать (смотрите поля адресов). Если массив не передан или же передан пустой массив, то будут выбраны все доступные поля адресов
filter `object`	Объект для фильтрации выбранных адресов в формате `{"field_1": "value_1", ... "field_N": "value_N"}`. Возможные значения для `field` соответствуют полям адреса. Ключу можно задать дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса: `>=` — больше либо равно `>` — больше `<=` — меньше либо равно `<` — меньше `@` — IN, в качестве значения передается массив `!@` — NOT IN, в качестве значения передается массив `%` — LIKE, поиск по подстроке. Символ `%` в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки `=%` — LIKE, поиск по подстроке. Символ `%` нужно передавать в значении. Примеры: `"мол%"` — ищет значения, начинающиеся с «мол» `"%мол"` — ищет значения, заканчивающиеся на «мол» `"%мол%"` — ищет значения, где «мол» может быть в любой позиции `%=` — LIKE (аналогично `=%`) `!%` — NOT LIKE, поиск по подстроке. Символ `%` в значении фильтра передавать не нужно. Поиск идет с обеих сторон `!=%` — NOT LIKE, поиск по подстроке. Символ `%` нужно передавать в значении. Примеры: `"мол%"` — ищет значения, не начинающиеся с «мол» `"%мол"` — ищет значения, не заканчивающиеся на «мол» `"%мол%"` — ищет значения, где подстроки «мол» нет в любой позиции `!%=` — NOT LIKE (аналогично `!=%`) `=` — равно, точное совпадение (используется по умолчанию) `!=` — не равно `!` — не равно
order `object`	Объект для сортировки выбранных адресов в формате `{"field_1": "order_1", ... "field_N": "order_N"}`. Возможные значения для `field` соответствуют полям адреса. Возможные значения для `order`: `asc` — в порядке возрастания `desc` — в порядке убывания
start `integer`	Параметр используется для управления постраничной навигацией. Размер страницы результатов всегда статичный: 50 записей. Чтобы выбрать вторую страницу результатов, необходимо передавать значение `50`. Чтобы выбрать третью страницу результатов значение — `100` и так далее. Формула расчета значения параметра `start`: `start = (N-1) * 50`, где `N` — номер нужной страницы

Описание полей адреса

Название `тип`	Описание
TYPE_ID `integer`	Идентификатор типа адреса. Элемент перечисления «Тип адреса». Элементы перечисления «Тип адреса» можно получить с помощью метода crm.enum.addresstype
ENTITY_TYPE_ID `integer`	Идентификатор типа родительского объекта. Идентификаторы типов объектов можно получить с помощью метода crm.enum.ownertype. Адреса могут быть привязаны только к Реквизитам (а реквизиты уже к компаниям либо контактам) или Лидам. Для обратной совместимости оставлена возможность связывать Адреса с Контактами или Компаниями. Но эта связь возможна только на некоторых старых порталах, где специально техподдержкой был включен старый режим работы с адресами
ENTITY_ID `string`	Идентификатор родительского объекта
ADDRESS_1 `string`	Улица, дом, корпус, строение
ADDRESS_2 `string`	Квартира / офис
CITY `string`	Город
POSTAL_CODE `string`	Почтовый индекс
REGION `string`	Район
PROVINCE `string`	Область
COUNTRY `string`	Страна
COUNTRY_CODE `string`	Код страны. Не используется, оставлено для обратной совместимости. В качестве значения можно указать пустую строку
LOC_ADDR_ID `integer`	Идентификатор адреса местоположения. Это поле содержит идентификатор объекта адреса в модуле `Location`, связанного с объектов адреса CRM. Каждому адресу CRM соответствует объект адреса в модуле `location`. Это можно использовать для копирования существующего адреса в CRM с информацией о местоположении, которой нет в полях адреса CRM. Если при создании адреса указан идентификатор адреса модуля `location`, то создается копия адреса `location` и привязывается к созданному адресу CRM. Если в таком случае не указаны значения для строковых полей адреса, то они будут заполнены из location-адреса. Если же было указано хоть одно строковое поле, то в адресе CRM будут сохранены только указанные поля, и их значения перезапишут соответствующие значения в объекте location-адреса. Такое же поведение будет и при обновлении адреса
ANCHOR_TYPE_ID `integer`	Идентификатор типа основного родительского объекта. Это поле для служебного использования. Значение заполняется автоматически при добавлении адреса. Идентификаторы типов объектов можно получить с помощью метода crm.enum.ownertype. В этом поле содержится идентификатор типа родительского объекта реквизита (компания или контакт), если адрес привязан к реквизиту. Если адрес привязан к лиду, то этим значением будет идентификатор типа лид
ANCHOR_ID `integer`	Это поле для служебного использования. Значение заполняется автоматически при добавлении адреса. В этом поле содержится идентификатор родительского объекта реквизита (компании или контакта), если адрес привязан к реквизиту. Если адрес привязан к лиду, то этим значением будет идентификатор лида

Примеры кода

Как использовать примеры в документации

Поиск адресов по привязке к типу Реквизит:

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"order":{"TYPE_ID":"asc"},"filter":{"ENTITY_TYPE_ID":8,"ENTITY_ID":7335},"limit":10}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.address.list

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"order":{"TYPE_ID":"asc"},"filter":{"ENTITY_TYPE_ID":8,"ENTITY_ID":7335},"limit":10,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.address.list

// callListMethod: Получает все данные сразу. Используйте только для небольших выборок (< 1000 элементов) из-за высокой нагрузки на память.
        
        try {
          const response = await $b24.callListMethod(
            'crm.address.list',
            {
              order: { "TYPE_ID": "asc"},
              filter: { "ENTITY_TYPE_ID": 8, "ENTITY_ID": 7335},
              limit: 10
            },
            (progress) => { console.log('Progress:', progress) }
          )
          const items = response.getData() || []
          for (const entity of items) { console.log('Entity:', entity) }
        } catch (error) {
          console.error('Request failed', error)
        }
        
        // fetchListMethod: Выбирает данные по частям с помощью итератора. Используйте для больших объемов данных для эффективного потребления памяти.
        
        try {
          const generator = $b24.fetchListMethod('crm.address.list', { order: { "TYPE_ID": "asc"}, filter: { "ENTITY_TYPE_ID": 8, "ENTITY_ID": 7335}, limit: 10 }, 'ID')
          for await (const page of generator) {
            for (const entity of page) { console.log('Entity:', entity) }
          }
        } catch (error) {
          console.error('Request failed', error)
        }
        
        // callMethod: Ручное управление постраничной навигацией через параметр start. Используйте для точного контроля над пакетами запросов. Для больших данных менее эффективен, чем fetchListMethod.
        
        try {
          const response = await $b24.callMethod('crm.address.list', { order: { "TYPE_ID": "asc"}, filter: { "ENTITY_TYPE_ID": 8, "ENTITY_ID": 7335}, limit: 10 }, 0)
          const result = response.getData().result || []
          for (const entity of result) { console.log('Entity:', entity) }
        } catch (error) {
          console.error('Request failed', error)
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.address.list',
                    [
                        'order' => ['TYPE_ID' => 'asc'],
                        'filter' => ['ENTITY_TYPE_ID' => 8, 'ENTITY_ID' => 7335],
                        'limit' => 10,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
            if ($result->more()) {
                $result->next();
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching address list: ' . $e->getMessage();
        }

BX24.callMethod(
            "crm.address.list",
            {
                order: { "TYPE_ID": "asc"},
                filter: { "ENTITY_TYPE_ID": 8, "ENTITY_ID": 7335},
                limit: 10
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                {
                    console.dir(result.data());
                    if(result.more())
                        result.next();
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.address.list',
            [
                'order' => ['TYPE_ID' => 'asc'],
                'filter' => ['ENTITY_TYPE_ID' => 8, 'ENTITY_ID' => 7335],
                'limit' => 10
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Обработка ответа

HTTP-статус: 200

{
            "result": [
                {
                    "TYPE_ID": "1",
                    "ENTITY_TYPE_ID": "8",
                    "ENTITY_ID": "7335",
                    "ADDRESS_1": "Ленина 2",
                    "ADDRESS_2": "701",
                    "CITY": "Тюмень",
                    "POSTAL_CODE": "625003",
                    "REGION": "Тюменская обл",
                    "PROVINCE": "Тюменская обл",
                    "COUNTRY": "Россия",
                    "COUNTRY_CODE": null,
                    "LOC_ADDR_ID": "479",
                    "ANCHOR_TYPE_ID": "3",
                    "ANCHOR_ID": "17192"
                }
            ],
            "total": 1,
            "time": {
                "start": 1716301758.664873,
                "finish": 1716301759.73158,
                "duration": 1.0667071342468262,
                "processing": 0.028820037841796875,
                "date_start": "2024-05-21T16:29:18+02:00",
                "date_finish": "2024-05-21T16:29:19+02:00",
                "operating": 0
            }
        }

Если у контакта 2 разных реквизита, к которым привязаны адреса:

HTTP-статус: 200

{
            "result": [
                {
                    "TYPE_ID": "1",
                    "ENTITY_TYPE_ID": "8",
                    "ENTITY_ID": "7335",
                    "ADDRESS_1": "Ленина 2",
                    "ADDRESS_2": "701",
                    "CITY": "Тюмень",
                    "POSTAL_CODE": "625003",
                    "REGION": "Тюменская обл",
                    "PROVINCE": "Тюменская обл",
                    "COUNTRY": "Россия",
                    "COUNTRY_CODE": null,
                    "LOC_ADDR_ID": "479",
                    "ANCHOR_TYPE_ID": "3",
                    "ANCHOR_ID": "17192"
                },
                {
                    "TYPE_ID": "1",
                    "ENTITY_TYPE_ID": "8",
                    "ENTITY_ID": "7335",
                    "ADDRESS_1": "Ленина",
                    "ADDRESS_2": "2",
                    "CITY": "Тюмень",
                    "POSTAL_CODE": "666000",
                    "REGION": "Тюменская область рег",
                    "PROVINCE": "Тюменская область",
                    "COUNTRY": "Россия",
                    "COUNTRY_CODE": null,
                    "LOC_ADDR_ID": "129",
                    "ANCHOR_TYPE_ID": "3",
                    "ANCHOR_ID": "17192"
                }
            ],
            "total": 2,
            "time": {
                "start": 1716301758.664873,
                "finish": 1716301759.73158,
                "duration": 1.0667071342468262,
                "processing": 0.028820037841796875,
                "date_start": "2024-05-21T16:29:18+02:00",
                "date_finish": "2024-05-21T16:29:19+02:00",
                "operating": 0
            }
        }

Дополнительная информация о результате

Поле ANCHOR_TYPE_ID заполнено значением из crm.enum.ownertype (в примере это Контакты), а поле ANCHOR_ID содержит ID объекта (в данном случае Контакта).

Поля ANCHOR_TYPE_ID и ANCHOR_ID в двух вышеуказанных примерах одинаковы, следовательно, оба адреса относятся к одному Контакту.

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

Название `тип`	Описание
result `array`	Массив объектов с информацией о выбранных адресах. Каждый элемент содержит выбранные поля адресов
total `integer`	Общее количество найденных записей
time `time`	Информация о времени выполнения запроса

Обработка ошибок

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

{
            "error":0,
            "error_description":"error"
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код	Описание
`Access denied`	Недостаточно прав доступа для получения списка адресов. Нет доступа на чтение компаний, контактов, лидов

Статусы и коды системных ошибок

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

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	Текущий метод не разрешен для вызова с помощью batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	Превышена максимальная длина параметров, переданных в метод batch
`401`	`NO_AUTH_FOUND` Wrong authorization data	Неверный access-токен или код вебхука
`400`	`INVALID_REQUEST` Https required	Для вызовов методов требуется использовать протокол HTTPS
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	REST API доступен только на коммерческих планах
`403`	`INVALID_CREDENTIALS` Invalid request credentials	У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	Манифест недоступен
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более высоких привилегий, чем предоставляет токен вебхука
`401`	`expired_token` The access token provided has expired	Предоставленный access-токен доступа истек
`403`	`user_access_error` The user does not have access to the application	Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям
`500`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Изменить адрес реквизита

Удалить адрес

Получить список адресов по фильтру crm.address.list

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

Описание полей адресаОписание полей адреса

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

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

Обработка ошибокОбработка ошибок

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

Статусы и коды системных ошибокСтатусы и коды системных ошибок

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