Получить конфигурируемое дело по id crm.activity.configurable.get
Scope:
crmКто может выполнять метод: любой пользователь
Метод crm.activity.configurable.get возвращает информацию о конфигурируемом деле.
Важно
Вызов метода возможен только в контексте приложения.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
id* |
Целочисленный идентификатор дела, например |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":999,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.activity.configurable.get
try
{
const response = await $b24.callMethod(
'crm.activity.configurable.get',
{
id: 999,
}
);
const result = response.getData().result;
if (result.error())
{
console.error(result.error());
}
else
{
console.dir(result);
}
}
catch( error )
{
console.error('Error:', error);
}
try {
$response = $b24Service
->core
->call(
'crm.activity.configurable.get',
[
'id' => 999,
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
} else {
echo 'Data: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting configurable activity: ' . $e->getMessage();
}
BX24.callMethod(
"crm.activity.configurable.get",
{
id: 999,
},
result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'crm.activity.configurable.get',
[
'id' => 999
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Обработка ответа
HTTP-статус: 200
{
"result": {
"activity": {
"id": 8903,
"ownerTypeId": 1,
"ownerId": 2975,
"fields": {
"typeId": "CONFIGURABLE",
"completed": false,
"deadline": "2025-02-01T01:00:00+03:00",
"pingOffsets": [],
"isIncomingChannel": false,
"responsibleId": 1,
"badgeCode": "",
"originatorId": null,
"originId": null
},
"layout": {
"icon": {
"code": "call-completed"
},
"header": {
"title": "Входящий звонок",
"tags": {
"status2": {
"title": "не расшифрован",
"type": "warning"
}
}
},
"body": {
"logo": {
"code": "call-incoming",
"action": {
"type": "redirect",
"uri": "/crm/deal/details/123/"
}
},
"blocks": {
"client": {
"type": "withTitle",
"properties": {
"title": "Клиент",
"inline": true,
"block": {
"type": "text",
"properties": {
"value": "ООО Рога и Копыта"
}
}
}
},
"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": "О клиенте",
"type": "primary",
"action": {
"type": "openRestApp",
"actionParams": {
"clientId": "456"
}
}
}
},
"menu": {
"showPostponeItem": false,
"items": {
"confirm": {
"title": "Подтвердить заявку",
"action": {
"type": "restEvent",
"id": "confirm",
"animationType": "loader"
}
},
"decline": {
"title": "Отклонить заявку",
"action": {
"type": "restEvent",
"id": "decline",
"animationType": "loader"
}
}
}
}
}
}
}
}
"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 |
Корневой элемент ответа - ассоциативный массив с ключом activity, в котором будет содержаться поля |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "NOT_FOUND",
"error_description": "Not found."
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
|
|
Недостаточно прав для выполнения операции |
|
|
Элемент не найден |
|
|
Вызов метода возможен только в контексте приложения |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Обновить конфигурируемое дело crm.activity.configurable.update
- Добавить конфигурируемое дело crm.activity.configurable.add