Блог Горошко Андрея Bitrix24,PHP Добавить адрес crm.address.add

Добавить адрес crm.address.add

При разработке и поддержке проектов на платформе 1С-Битрикс критически важно использовать современные стандарты D7 API. В этом руководстве мы детально изучим тему «Добавить адрес crm.address.add», разберем архитектурные особенности и предоставим готовые к интеграции примеры кода.

Добавить адрес crm.address.add

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

Метод добавляет новый адрес для реквизита или лида. Для пользователя такой адрес выглядит как адрес контакта, компании или лида.

Может быть создано несколько адресов разного типа, привязанных к одному реквизиту.

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

Название
тип
Описание
fields
object
Набор полей — объект вида {"поле": "значение"[, ...]} для добавления адреса

Параметр fields

Название
тип
Описание
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-адреса. Такое же поведение будет и при обновлении адреса

Примеры кода

  • cURL (Webhook)
    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"fields":{"TYPE_ID":1,"ENTITY_TYPE_ID":8,"ENTITY_ID":1,"ADDRESS_1":"проспект Мира, 4","ADDRESS_2":"Калининградский областной драматический театр","CITY":"Калининград","POSTAL_CODE":"236036","REGION":"городской округ Калининград","PROVINCE":"Калининградская область","COUNTRY":"Россия"}}' \
    https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.address.add
  • cURL (OAuth)
    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"fields":{"TYPE_ID":1,"ENTITY_TYPE_ID":8,"ENTITY_ID":1,"ADDRESS_1":"проспект Мира, 4","ADDRESS_2":"Калининградский областной драматический театр","CITY":"Калининград","POSTAL_CODE":"236036","REGION":"городской округ Калининград","PROVINCE":"Калининградская область","COUNTRY":"Россия"},"auth":"**put_access_token_here**"}' \
    https://**put_your_bitrix24_address**/rest/crm.address.add
  • JS
    try
    {
    	const response = await $b24.callMethod(
    		"crm.address.add",
    		{
    			fields:
    			{
    				"TYPE_ID": 1,            // Тип адреса, см. crm.enum.addresstype
    				"ENTITY_TYPE_ID": 8,     // Тип объекта (реквизит или лид)
    				"ENTITY_ID": 1,          // Идентификатор реквизита
    				"ADDRESS_1": "проспект Мира, 4",
    				"ADDRESS_2": "Калининградский областной драматический театр",
    				"CITY": "Калининград",
    				"POSTAL_CODE": "236036",
    				"REGION": "городской округ Калининград",
    				"PROVINCE": "Калининградская область",
    				"COUNTRY": "Россия",
    			}
    		}
    	);
    	
    	const result = response.getData().result;
    	if(result.error())
    		console.error(result.error());
    }
    catch(error)
    {
    	console.error(error);
    }
  • PHP
    try {
        $response = $b24Service
            ->core
            ->call(
                'crm.address.add',
                [
                    'fields' => [
                        'TYPE_ID'        => 1,
                        'ENTITY_TYPE_ID' => 8,
                        'ENTITY_ID'      => 1,
                        'ADDRESS_1'      => 'проспект Мира, 4',
                        'ADDRESS_2'      => 'Калининградский областной драматический театр',
                        'CITY'           => 'Калининград',
                        'POSTAL_CODE'    => '236036',
                        'REGION'         => 'городской округ Калининград',
                        'PROVINCE'       => 'Калининградская область',
                        'COUNTRY'        => 'Россия',
                    ],
                ]
            );
    
        $result = $response
            ->getResponseData()
            ->getResult();
    
    } catch (Throwable $e) {
        error_log($e->getMessage());
        echo 'Error adding address: ' . $e->getMessage();
    }
  • BX24.js
    BX24.callMethod(
        "crm.address.add",
        {
            fields:
            {
                "TYPE_ID": 1,            // Тип адреса, см. crm.enum.addresstype
                "ENTITY_TYPE_ID": 8,     // Тип объекта (реквизит или лид)
                "ENTITY_ID": 1,          // Идентификатор реквизита
                "ADDRESS_1": "проспект Мира, 4",
                "ADDRESS_2": "Калининградский областной драматический театр",
                "CITY": "Калининград",
                "POSTAL_CODE": "236036",
                "REGION": "городской округ Калининград",
                "PROVINCE": "Калининградская область",
                "COUNTRY": "Россия",
            }
        },
        function(result)
        {
            if(result.error())
                console.error(result.error());
        }
    );
  • PHP CRest
    require_once('crest.php');

    $result = CRest::call(
        'crm.address.add',
        [
            'fields' => [
                'TYPE_ID' => 1,
                'ENTITY_TYPE_ID' => 8,
                'ENTITY_ID' => 1,
                'ADDRESS_1' => 'проспект Мира, 4',
                'ADDRESS_2' => 'Калининградский областной драматический театр',
                'CITY' => 'Калининград',
                'POSTAL_CODE' => '236036',
                'REGION' => 'городской округ Калининград',
                'PROVINCE' => 'Калининградская область',
                'COUNTRY' => 'Россия',
            ]
        ]
    );

    echo '<PRE>';
    print_r($result);
    echo '</PRE>';

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

HTTP-статус: 200

{
    "result": true,
    "time": {
        "start": 1712922620.724857,
        "finish": 1712922623.393783,
        "duration": 2.6689260005950928,
        "processing": 2.210068941116333,
        "date_start": "2024-04-12T14:50:20+03:00",
        "date_finish": "2024-04-12T14:50:23+03:00"
    }
}

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

Название
тип
Описание
result
boolean
Результат добавления адреса:
— true — добавлен
— false — не добавлен
time
time
Информация о времени выполнения запроса

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

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

{
    "error": "",
    "error_description": "ENTITY_ID is not defined or invalid."
}

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

КодОписание
TYPE_ID is not defined or invalidИдентификатор типа адреса не указан или имеет недопустимое значение
ENTITY_TYPE_ID is not defined or invalidИдентификатор типа родительского объекта не указан или имеет недопустимое значение.
ENTITY_ID is not defined or invalidИдентификатор родительского объекта не указан или имеет недопустимое значение
TypeAddress existsАдрес с таким типом у указанного родительского объекта уже существует
Access deniedНедостаточно прав доступа для добавления адреса
  • [](./crm-address-update)
  • [](./crm-address-list)
  • [](./crm-address-delete)
  • [](./crm-address-fields)
  • [](../../../../tutorials/crm/how-to-add-crm-objects/how-to-add-company-with-requisite)
  • [](../../../../tutorials/crm/how-to-add-crm-objects/how-to-add-contact-with-requisite)
  • [](../../../../tutorials/crm/how-to-add-crm-objects/how-to-add-deal-with-choice-of-requisite)

💡 Экспертное мнение и рекомендации

Советы эксперта по интеграции:

  • Всегда используйте кэширование при частых запросах к crm.address.add, чтобы разгрузить базу данных.
  • Соблюдайте стандарты PSR при написании обработчиков для «Добавить адрес crm.address.add».
  • Регулярно проводите аудит производительности системы с помощью встроенного монитора 1С-Битрикс.

Похожая задача в бизнесе?

Помогу автоматизировать процессы и внедрить ИИ

Меня зовут Андрей Горошко. Я Full-stack разработчик и эксперт по 1С-Битрикс. Настраиваю CRM Битрикс24, разрабатываю защищенные API и создаю умных ИИ-агентов для автоматизации рутины.

Related Post

Получить историю движения по стадиям crm.stagehistory.listПолучить историю движения по стадиям crm.stagehistory.list

Эффективная интеграция и кастомизация функционала в Битрикс24 часто требует работы на уровне API. Сегодня мы подробно рассмотрим «Получить историю движения по стадиям crm.stagehistory.list». Вы узнаете экспертные методики работы с crm.stagehistory.list

Внедрение Битрикс24 для юридической компании и адвокатского бюроВнедрение Битрикс24 для юридической компании и адвокатского бюро

Профессиональная настройка и комплексная автоматизация Битрикс24 CRM позволяет выстроить прозрачный отдел продаж, исключить потерю обращений и автоматизировать рутинный документооборот компании. Услуга «Внедрение Битрикс24 для юридической компании и адвокатского бюро» обеспечивает

Получить информацию о диалоге (чате) оператора открытой линии imopenlines.dia…Получить информацию о диалоге (чате) оператора открытой линии imopenlines.dia…

При разработке и поддержке проектов на платформе 1С-Битрикс критически важно использовать современные стандарты D7 API. В этом руководстве мы детально изучим тему «Получить информацию о диалоге (чате) оператора открытой линии