Добавить конфигурируемое дело crm.activity.configurable.add
Scope:
crmКто может выполнять метод: любой пользователь
Метод crm.activity.configurable.add добавляет конфигурируемое дело в таймлайн.
Важно
Вызов метода возможен только в контексте приложения.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
ownerTypeId* |
Целочисленный идентификатор типа собъекта CRM, в котором создаем дело, например |
|
ownerId* |
Целочисленный идентификатор элемента CRM, в котором создаем дело, например |
|
fields* |
Ассоциативный массив значений полей дела в виде структуры: |
|
layout* |
Ассоциативный массив особой структуры, описывающий внешний вид дела в таймлайне |
Параметр fields
Обязательные параметры отмечены *
|
Название |
Описание |
|
typeId |
Тип конфигурируемого дела. Если значение не указано, то оно устанавливается в значение по умолчанию |
|
completed |
Флаг, говорящий закрыто ли дело. Для установки значения можно использовать |
|
deadline |
Крайний срок исполнения дела |
|
pingOffsets |
Массив смещений в минутах относительно крайнего срока, определяющий когда нужно сформировать записи-пинги по этому делу |
|
isIncomingChannel |
Флаг, говорящий создано ли дело из входящего канала. Для установки значения можно использовать |
|
responsibleId |
Ответственный за дело |
|
badgeCode |
Код значка на канбане, соответствующего делу |
|
originatorId |
Идентификатор источника данных |
|
originId |
Идентификатор элемента в источнике данных |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ownerTypeId":1,"ownerId":999,"fields":{"typeId":"CONFIGURABLE","completed":true,"deadline":"**put_current_date_time_here**","pingOffsets":[60,300],"isIncomingChannel":"N","responsibleId":1,"badgeCode":"CUSTOM"},"layout":{"icon":{"code":"call-completed"},"header":{"title":"Входящий звонок"},"body":{"logo":{"code":"call-incoming"},"blocks":{"responsible":{"type":"lineOfBlocks","properties":{"blocks":{"client":{"type":"link","properties":{"text":"Сергей Востриков","bold":true,"action":{"type":"redirect","uri":"/crm/lead/details/789/"}}},"phone":{"type":"text","properties":{"value":"+7 999 888 7777"}}}}}}},"footer":{"buttons":{"startCall":{"title":"О клиенте","action":{"type":"openRestApp","actionParams":{"clientId":456}},"type":"primary"}}}},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.activity.configurable.add
try
{
const response = await $b24.callMethod(
"crm.activity.configurable.add",
{
ownerTypeId: 1,
ownerId: 999,
fields:
{
typeId: 'CONFIGURABLE',
completed: true,
deadline: new Date(),
pingOffsets: [60, 300],
isIncomingChannel: 'N',
responsibleId: 1,
badgeCode: 'CUSTOM',
},
layout:
{
"icon": {
"code": "call-completed"
},
"header": {
"title": "Входящий звонок"
},
"body": {
"logo": {
"code": "call-incoming"
},
"blocks": {
"responsible": {
"type": "lineOfBlocks",
"properties": {
"blocks": {
"client": {
"type": "link",
"properties": {
"text": "Сергей Востриков",
"bold": true,
"action": {
"type": "redirect",
"uri": "/crm/lead/details/789/"
}
}
},
"phone": {
"type": "text",
"properties": {
"value": "+7 999 888 7777"
}
}
}
}
}
}
},
"footer": {
"buttons": {
"startCall": {
"title": "О клиенте",
"action": {
"type": "openRestApp",
"actionParams": {
"clientId": 456
}
},
"type": "primary"
}
}
}
}
}
);
const result = response.getData().result;
console.dir(result);
}
catch( error )
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'crm.activity.configurable.add',
[
'ownerTypeId' => 1,
'ownerId' => 999,
'fields' => [
'typeId' => 'CONFIGURABLE',
'completed' => true,
'deadline' => new DateTime(),
'pingOffsets' => [60, 300],
'isIncomingChannel' => 'N',
'responsibleId' => 1,
'badgeCode' => 'CUSTOM',
],
'layout' => [
'icon' => [
'code' => 'call-completed',
],
'header' => [
'title' => 'Входящий звонок',
],
'body' => [
'logo' => [
'code' => 'call-incoming',
],
'blocks' => [
'responsible' => [
'type' => 'lineOfBlocks',
'properties' => [
'blocks' => [
'client' => [
'type' => 'link',
'properties' => [
'text' => 'Сергей Востриков',
'bold' => true,
'action' => [
'type' => 'redirect',
'uri' => '/crm/lead/details/789/',
],
],
],
'phone' => [
'type' => 'text',
'properties' => [
'value' => '+7 999 888 7777',
],
],
],
],
],
],
],
'footer' => [
'buttons' => [
'startCall' => [
'title' => 'О клиенте',
'action' => [
'type' => 'openRestApp',
'actionParams' => [
'clientId' => 456,
],
],
'type' => 'primary',
],
],
],
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Нужная вам логика обработки данных
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error adding configurable activity: ' . $e->getMessage();
}
BX24.callMethod(
"crm.activity.configurable.add",
{
ownerTypeId: 1,
ownerId: 999,
fields:
{
typeId: 'CONFIGURABLE',
completed: true,
deadline: new Date(),
pingOffsets: [60, 300],
isIncomingChannel: 'N',
responsibleId: 1,
badgeCode: 'CUSTOM',
},
layout:
{
"icon": {
"code": "call-completed"
},
"header": {
"title": "Входящий звонок"
},
"body": {
"logo": {
"code": "call-incoming"
},
"blocks": {
"responsible": {
"type": "lineOfBlocks",
"properties": {
"blocks": {
"client": {
"type": "link",
"properties": {
"text": "Сергей Востриков",
"bold": true,
"action": {
"type": "redirect",
"uri": "/crm/lead/details/789/"
}
}
},
"phone": {
"type": "text",
"properties": {
"value": "+7 999 888 7777"
}
}
}
}
}
}
},
"footer": {
"buttons": {
"startCall": {
"title": "О клиенте",
"action": {
"type": "openRestApp",
"actionParams": {
"clientId": 456
}
},
"type": "primary"
}
}
}
}
}, result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'crm.activity.configurable.add',
[
'ownerTypeId' => 1,
'ownerId' => 999,
'fields' => [
'typeId' => 'CONFIGURABLE',
'completed' => true,
'deadline' => date('c'), // Используем текущую дату и время в формате ISO 8601
'pingOffsets' => [60, 300],
'isIncomingChannel' => 'N',
'responsibleId' => 1,
'badgeCode' => 'CUSTOM',
],
'layout' => [
'icon' => [
'code' => 'call-completed'
],
'header' => [
'title' => 'Входящий звонок'
],
'body' => [
'logo' => [
'code' => 'call-incoming'
],
'blocks' => [
'responsible' => [
'type' => 'lineOfBlocks',
'properties' => [
'blocks' => [
'client' => [
'type' => 'link',
'properties' => [
'text' => 'Сергей Востриков',
'bold' => true,
'action' => [
'type' => 'redirect',
'uri' => '/crm/lead/details/789/'
]
]
],
'phone' => [
'type' => 'text',
'properties' => [
'value' => '+7 999 888 7777'
]
]
]
]
]
]
],
'footer' => [
'buttons' => [
'startCall' => [
'title' => 'О клиенте',
'action' => [
'type' => 'openRestApp',
'actionParams' => [
'clientId' => 456
]
],
'type' => 'primary'
]
]
]
]
]
);
if (isset($result['error'])) {
echo 'Ошибка: ' . $result['error_description'];
} else {
echo '<PRE>';
print_r($result['result']);
echo '</PRE>';
}
Обработка ответа
HTTP-статус: 200
{
"result": {
"activity": {
"id": 999,
},
"time": {
"start": 1724068028.331234,
"finish": 1724068028.726591,
"duration": 0.3953571319580078,
"processing": 0.13033390045166016,
"date_start": "2025-01-21T13:47:08+02:00",
"date_finish": "2025-01-21T13:47:08+02:00",
"operating": 0
}
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа, содержащий информацию о добавленном идентифокаторе дела |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "NOT_FOUND",
"error_description": "Not found."
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
|
|
Недостаточно прав для выполнения операции |
|
|
Не заполнены обязательные поля |
|
|
Вызов метода возможен только в контексте приложения |
|
|
Обновить дело может только приложение, которое его создало |
|
|
Некорректное значение поля |
|
|
Входящее дело не может иметь крайний срок |
|
|
Поле layout должно быть заполнено |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Обновить конфигурируемое дело crm.activity.configurable.update
- Получить конфигурируемое дело по id crm.activity.configurable.get