Событие при удалении адреса onCrmAddressUnregister

Scope: crm

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

Событие onCrmAddressUnregister вызывается при удалении адреса.

События не будут отправляться в приложение, пока установка не завершена. Проверьте установку приложения

Что получает обработчик

Данные передаются в виде POST-запроса

[
            'event' => 'onCrmAddressUnregister',
            'data' => [
                'FIELDS' => [
                    'TYPE_ID' => 1,
                    'ENTITY_TYPE_ID' => 8,
                    'ENTITY_ID' => 1,
                    'ANCHOR_ID' => 17192,
                    'ANCHOR_TYPE_ID' => 3,
                ],
            ],
            'ts' => '1466439714',
            'auth' => [
                'access_token' => 's6p6eclrvim6da22ft9ch94ekreb52lv',
                'expires_in' => '3600',
                'scope' => 'crm',
                'domain' => 'some-domain.bitrix24.com',
                'server_endpoint' => 'https://oauth.bitrix24.tech/rest/',
                'status' => 'F',
                'client_endpoint' => 'https://some-domain.bitrix24.com/rest/',
                'member_id' => 'a223c6b3710f85df22e9377d6c4f7553',
                'refresh_token' => '4s386p3q0tr8dy89xvmt96234v3dljg8',
                'application_token' => '51856fefc120afa4b628cc82d3935cce',
            ],
        ]

Обязательные параметры отмечены *

Параметр
тип

Описание

event*
string

Символьный код события. В данном случае это onCrmAddressUnregister

data*
array

Массив с данными удаляемого адреса

ts*
timestamp

Дата и время отправки события из очереди событий

auth*
array

Параметры авторизации и данные о портале, на котором произошло событие

Параметр data[]

Обязательные параметры отмечены *

Параметр
тип

Описание

FIELDS*
array

Массив с полями удаляемого адреса

Параметр FIELDS[]

Обязательные параметры отмечены *

Параметр
тип

Описание

TYPE_ID*
integer

Идентификатор типа адреса. Элемент перечисления «Тип адреса».

Элементы перечисления «Тип адреса» возвращает метод crm.enum.addresstype

ENTITY_TYPE_ID*
integer

Идентификатор типа родительского объекта.

Идентификаторы типов объектов возвращает метод crm.enum.ownertype.

Адреса могут быть привязаны только к Реквизитам (а реквизиты уже к компаниям либо контактам) или Лидам. Для обратной совместимости оставлена возможность связывать Адреса с Контактами или Компаниями. Но эта связь возможна только на некоторых старых порталах, где специально техподдержкой был включен старый режим работы с адресами

ENTITY_ID*
integer

Идентификатор родительского объекта

ANCHOR_ID*
integer

Идентификатор основного родительского объекта.

Это поле для служебного использования. Значение заполняется автоматически при добавлении адреса.

В этом поле содержится идентификатор родительского объекта реквизита (компании или контакта), если адрес привязан к реквизиту. Если адрес привязан к лиду, то этим значением будет идентификатор лида

ANCHOR_TYPE_ID*
integer

Идентификатор типа основного родительского объекта.

Это поле для служебного использования. Значение заполняется автоматически при добавлении адреса.

Идентификаторы типов объектов возвращает метод crm.enum.ownertype.

В этом поле содержится идентификатор типа родительского объекта реквизита (компания или контакт), если адрес привязан к реквизиту. Если адрес привязан к лиду, то этим значением будет идентификатор типа лид

Параметр auth[]

Обязательные параметры отмечены *

Название
тип

Описание

access_token
string

Токен авторизации OAuth 2.0

expires_in
integer

Время в секундах до истечения срока действия токена

scope*
string

Скоуп, в рамках которого произошло событие

domain*
string

Адрес Битрикс24, на котором произошло событие

server_endpoint*
string

Адрес сервера авторизации Битрикс24, необходимый для обновления токенов OAuth 2.0

status*
string

Статус приложения, подписавшегося на это событие:

client_endpoint*
string

Общий путь для вызовов методов REST API для Битрикс24, на котором произошло событие

member_id*
string

Идентификатор Битрикс24, на котором произошло событие

refresh_token
string

Токен продления авторизации OAuth 2.0

application_token*
string

Токен для безопасной обработки событий

Токены авторизации не всегда передаются в обработчик события. Если хит, инициировавший событие, не удалось привязать к конкретному пользователю Битрикс24, токены не передаются. Обязательно проверяйте содержимое ключа auth в коде.

Рекомендуем хранить токены, полученные ранее при установке приложения. Используйте их при работе с интерфейсом приложения в виде встроек, виджетов и так далее.

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

Предыдущая
При регистрации адреса
Следующая
При добавлении реквизита