метод REST scope: crm Устаревший

crm.activity.add

Добавить системное дело

Устаревший метод. Развитие метода остановлено. Используйте crm.activity.todo.add.

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

Описание

Метод crm.activity.add создает новое системное дело.

Параметры

fields array обязательный

Массив значений полей дела в виде структуры:

fields:
{
    "OWNER_TYPE_ID": 2, 
    "OWNER_ID": 102, 
    "TYPE_ID": 2, 
    "SUBJECT": "Новый звонок",
}

Имеется дополнительное поле DISABLE_SENDING_MESSAGE_COPY. Оно предназначено для принудительного отключения отправки копии сообщения адресату из MESSAGE_FROM. Если параметр не заполнен или указано любое значение отличное от Y - копия отправлена будет. Пример:

[
    'fields'=> array(
        'SETTINGS'=> array(
            'DISABLE_SENDING_MESSAGE_COPY'=>'Y'
        )
    )
]

Параметр fields

OWNER_ID integer обязательный

Идентификатор элемента CRM

OWNER_TYPE_ID integer обязательный
TYPE_ID crm_enum_activitytype обязательный

Тип дела. Чтобы получить доступные типы дел, используйте метод crm.enum.activitytype.

Чтобы создать дело с типом «задача», используйте метод создания или изменения задачи и укажите элемент CRM в поле UF_CRM_TASK

ASSOCIATED_ENTITY_ID integer необязательный

Идентификатор связанного с делом элемента

COMMUNICATIONS crm_activity_communication обязательный
DEADLINE datetime необязательный

Дата и время срока исполнения дела. Поле напрямую не устанавливается, значение берётся из START_TIME для звонка и встречи и из END_TIME для задачи

DESCRIPTION string необязательный

Текстовое описание дела

DESCRIPTION_TYPE crm_enum_contenttype необязательный

Тип описания

DIRECTION crm_enum_activitydirection необязательный

Направление дела: входящее/исходящее. Актуально для звонков и писем, для встреч не используется

END_TIME datetime необязательный

Время завершения дела

FILES diskfile необязательный

Добавленные в дело файлы

LOCATION string необязательный

Местоположение

NOTIFY_TYPE crm_enum_activitynotifytype необязательный

Тип уведомления

ORIGINATOR_ID string необязательный

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

ORIGIN_ID string необязательный

Идентификатор элемента в источнике данных, используется только для привязки к внешнему источнику

ORIGIN_VERSION string необязательный

Оригинальная версия, используется для защиты данных от случайного перетирания внешней системой. Если данные были импортированы и не изменялись во внешней системе, то такие данные могут быть редактированы в CRM без опасения, что следующая выгрузка приведет к перетиранию данных

PRIORITY crm_enum_activitypriority необязательный

Приоритет

PROVIDER_DATA string необязательный

Дополнительные данные провайдера

PROVIDER_GROUP_ID string необязательный

Идентификатор группы провайдера

PROVIDER_ID string необязательный

Идентификатор провайдера

PROVIDER_TYPE_ID string необязательный

Идентификатор типа провайдера, статус из справочника

PROVIDER_PARAMS object необязательный

Дополнительные параметры провайдера

RESPONSIBLE_ID user обязательный

Идентификатор пользователя, ответственного за дело

SETTINGS object необязательный

Дополнительные настройки

START_TIME datetime необязательный

Время начала выполнения дела

STATUS crm_enum_activitystatus необязательный

Статус дела

SUBJECT string необязательный

Дополнительное описание дела

WEBDAV_ELEMENTS diskfile необязательный

Добавленные файлы. Устарел, сохраняется для совместимости

IS_INCOMING_CHANNEL char необязательный

Флаг, говорящий дело создано из входящего канала или нет (Y/N)

Примеры запроса

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"OWNER_TYPE_ID":2,"OWNER_ID":102,"TYPE_ID":2,"COMMUNICATIONS":[{"VALUE":"+79832322323","ENTITY_ID":134,"ENTITY_TYPE_ID":3}],"SUBJECT":"Новый звонок","START_TIME":"2023-12-31T12:00:00+00:00","END_TIME":"2023-12-31T12:30:00+00:00","COMPLETED":"N","PRIORITY":3,"RESPONSIBLE_ID":1,"DESCRIPTION":"Важный звонок","DESCRIPTION_TYPE":3,"DIRECTION":2,"FILES":[{"fileData":["example.jpg","base64_encoded_content_here"]}]} }' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.activity.add

Ответ

HTTP-статус: 200

{
    "result": 999,
    "time": {
        "start": 1712132792.910734,
        "finish": 1712132793.530359,
        "duration": 0.6196250915527344,
        "processing": 0.032338857650756836,
        "date_start": "2024-04-03T10:26:32+02:00",
        "date_finish": "2024-04-03T10:26:33+02:00",
        "operating_reset_at": 1705765533,
        "operating": 3.3076241016387939
    }
}

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

result integer

Идентификатор дела в таймлайне

time time

Информация о времени выполнения запроса

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

HTTP-статус: 400

{
    "error": "",
    "error_description": "Access denied."
}
Код Описание Значение
The field SUBJECT is not defined or empty Поле SUBJECT не установлено
The field RESPONSIBLE_ID is not defined or invalid Поле RESPONSIBLE_ID не установлено
The field TYPE_ID is not defined or invalid Поле TYPE_ID не установлено
The field COMMUNICATIONS is not defined or invalid Поле COMMUNICATIONS не установлено
The only one communication is allowed for activity of specified type Количество контактов более 1
Could not build binding. Please ensure that owner info and communications are defined correctly Связи для дела не указаны
The custom activity without provider is not supported in current context Тип дела не поддерживается в заданном контексте
Use crm.activity.configurable.add for this activity provider Некорректный вызов метода для конфигурируемого дела
Access denied Отсутствуют права на добавление сущности в CRM
Application context required Некорректный параметр PROVIDER_ID для дела, созданного в контексте приложения

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.