Добавить системное дело crm.activity.add
Scope:
crmКто может выполнять метод: пользователь с правом на добавление дела
DEPRECATED
Развитие метода остановлено. Используйте crm.activity.todo.add.
Метод crm.activity.add создает новое системное дело.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
fields* |
Массив значений полей дела в виде структуры:
Имеется дополнительное поле
|
Параметр fields
Обязательные параметры отмечены *
|
Поле |
Описание |
|
|
OWNER_ID* |
Идентификатор элемента CRM |
|
|
OWNER_TYPE_ID* |
||
|
TYPE_ID* |
Тип дела. Чтобы получить доступные типы дел, используйте метод crm.enum.activitytype. Чтобы создать дело с типом «задача», используйте метод создания или изменения задачи и укажите элемент CRM в поле |
|
|
ASSOCIATED_ENTITY_ID |
Идентификатор связанного с делом элемента |
|
|
COMMUNICATIONS* |
||
|
DEADLINE |
Дата и время срока исполнения дела. Поле напрямую не устанавливается, значение берётся из START_TIME для звонка и встречи и из END_TIME для задачи |
|
|
DESCRIPTION |
Текстовое описание дела |
|
|
DESCRIPTION_TYPE |
Тип описания |
|
|
DIRECTION |
Направление дела: входящее/исходящее. Актуально для звонков и писем, для встреч не используется |
|
|
END_TIME |
Время завершения дела |
|
|
FILES |
Добавленные в дело файлы |
|
|
LOCATION |
Местоположение |
|
|
NOTIFY_TYPE |
Тип уведомления |
|
|
ORIGINATOR_ID |
Идентификатор источника данных, используется только для привязки к внешнему источнику |
|
|
ORIGIN_ID |
Идентификатор элемента в источнике данных, используется только для привязки к внешнему источнику |
|
|
ORIGIN_VERSION |
Оригинальная версия, используется для защиты данных от случайного перетирания внешней системой. Если данные были импортированы и не изменялись во внешней системе, то такие данные могут быть редактированы в CRM без опасения, что следующая выгрузка приведет к перетиранию данных |
|
|
PRIORITY |
Приоритет |
|
|
PROVIDER_DATA |
Дополнительные данные провайдера |
|
|
PROVIDER_GROUP_ID |
Идентификатор группы провайдера |
|
|
PROVIDER_ID |
Идентификатор провайдера |
|
|
PROVIDER_TYPE_ID |
Идентификатор типа провайдера, статус из справочника |
|
|
PROVIDER_PARAMS |
Дополнительные параметры провайдера |
|
|
RESPONSIBLE_ID* |
Идентификатор пользователя, ответственного за дело |
|
|
SETTINGS |
Дополнительные настройки |
|
|
START_TIME |
Время начала выполнения дела |
|
|
STATUS |
Статус дела |
|
|
SUBJECT |
Дополнительное описание дела |
|
|
WEBDAV_ELEMENTS |
Добавленные файлы. Устарел, сохраняется для совместимости |
|
|
IS_INCOMING_CHANNEL |
Флаг, говорящий дело создано из входящего канала или нет ( |
Варианты использования значений полей
Для дел типа e-mail:
- если письмо не должно быть отправлено, устанавливайте параметры
DIRECTION=2иCOMPLETED='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
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"]}]},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.activity.add
try
{
const response = await $b24.callMethod(
"crm.activity.add",
{
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" // Контент файла в формате base64
]
}
]
}
}
);
const result = response.getData().result;
console.dir(result);
}
catch( error )
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'crm.activity.add',
[
'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'
]
]
]
]
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Нужная вам логика обработки данных
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error adding activity: ' . $e->getMessage();
}
BX24.callMethod(
"crm.activity.add",
{
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" // Контент файла в формате base64
]
}
]
}
},
result => {
if (result.error()) {
console.error(result.error());
} else {
console.dir(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'crm.activity.add',
[
'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' // Контент файла в формате base64
]
]
]
]
]
);
if (isset($result['error'])) {
echo 'Ошибка: ' . $result['error_description'];
} else {
echo '<PRE>';
print_r($result['result']);
echo '</PRE>';
}
Обработка ответа
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 |
Результат операции. Возвращает идентификатор дела в таймлайне в случае успеха, иначе — |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "",
"error_description": "Access denied."
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
|
|
Поле |
|
|
Поле |
|
|
Поле |
|
|
Поле |
|
|
Количество контактов более 1 |
|
|
Связи для дела не указаны |
|
Ошибки "почтовых" дел |
|
|
Тип дела не поддерживается в заданном контексте |
|
|
Некорректный вызов метода для конфигурируемого дела |
|
|
Отсутствуют права на добавление сущности в CRM |
|
|
Некорректный параметр |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Обновить системное дело crm.activity.update
- Удалить дело crm.activity.delete
- Получить информацию о деле по идентификатору crm.activity.get
- Получить список дел crm.activity.list
- Получить описание коммуникации crm.activity.communication.fields
- Получить список полей дела crm.activity.fields
- Добавить событие календаря для работы с клиентами
- Как отправить письмо клиенту от имени сотрудника