Получить конфигурируемое дело crm.activity.configurable.get

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: crm

Кто может выполнять метод: пользователь с доступом на чтение элемента CRM, к которому привязано дело

Метод crm.activity.configurable.get возвращает конфигурируемое дело по идентификатору: его поля и структуру layout, которая задает внешний вид записи в таймлайне.

В отличие от crm.activity.configurable.add и crm.activity.configurable.update, метод не требует контекста приложения — его можно вызвать и через входящий вебхук.

Метод возвращает только конфигурируемые дела — для дел других типов он вернет NOT_FOUND.

Идентификатор дела приходит в ответе метода crm.activity.configurable.add. Найти дела, созданные приложением, можно методом crm.activity.list с фильтром PROVIDER_ID = CONFIGURABLE_REST_APP.

Параметры метода

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

Название
тип

Описание

id*
integer

Целочисленный идентификатор дела, например 999

Примеры кода

Как использовать примеры в документации

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":999}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.activity.configurable.get

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

// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of the payload returned in result (match the "response handling" section of the page)
type ConfigurableActivityGetResult = {
  activity: {
    id: number
    ownerTypeId: number
    ownerId: number
    fields: {
      typeId: string
      completed: boolean
      deadline: ISODate | null
      pingOffsets: number[]
      isIncomingChannel: boolean
      responsibleId: number
      badgeCode: string
      originatorId: string | null
      originId: string | null
    }
    layout: Record<string, unknown>
  }
}

try {
  const response = await $b24.actions.v2.call.make<ConfigurableActivityGetResult>({
    method: 'crm.activity.configurable.get',
    params: {
      id: 999,
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info(result.activity.id, result.activity.fields.typeId, result.activity.layout)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}

<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function getConfigurableActivity() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'crm.activity.configurable.get',
        params: {
          id: 999,
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info(result.activity.id, result.activity.fields.typeId, result.activity.layout)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getConfigurableActivity)
</script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.crm.activity.configurable.get(
        bitrix_id=999,
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")

try {
    $response = $b24Service
        ->core
        ->call(
            'crm.activity.configurable.get',
            [
                'id' => 999,
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Data: ' . print_r($result, 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
    ]
);

if (isset($result['error'])) {
    echo 'Ошибка: ' . $result['error_description'];
} else {
    echo '<PRE>';
    print_r($result['result']);
    echo '</PRE>';
}

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.activity.configurable.get", b24.Params{
	"id": 999,
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("crm.activity.configurable.get: %w", err)
}

// Ответ приходит как json.RawMessage — разберите его
// в структуру под форму ответа, показанную ниже на этой странице.
fmt.Printf("%s\n", res.Result)

Обработка ответа

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
object

Корневой элемент ответа с единственным ключом activity (подробное описание)

time
time

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

Объект activity

Название
тип

Описание

id
integer

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

ownerTypeId
integer

Идентификатор типа объекта CRM, к которому привязано дело

ownerId
integer

Идентификатор элемента CRM, к которому привязано дело

fields
object

Поля дела (подробное описание)

layout
LayoutDto

Структура, которая задает внешний вид записи в таймлайне. Ее же передают в параметре layout методов crm.activity.configurable.add и crm.activity.configurable.update. Значения actionParams внутри структуры возвращаются строками, даже если при создании их передавали числами: в примере выше clientId пришел как "456"

Объект fields

Типы в ответе отличаются от типов на входе. Флаги приходят как boolean, даже если при создании их передавали как Y/N или 1/0. Незаполненные значения приходят как null или пустая строка.

Название
тип

Описание

typeId
string

Тип конфигурируемого дела, например CONFIGURABLE

completed
boolean

Закрыто ли дело

deadline
datetime

Крайний срок в формате ISO 8601 или null, если срока нет

pingOffsets
array

Смещения в минутах относительно крайнего срока. Пустой массив, если пинги не заданы

isIncomingChannel
boolean

Создано ли дело из входящего канала

responsibleId
integer

Идентификатор ответственного

badgeCode
string

Код бейджа или пустая строка, если бейдж не задан

originatorId
string

Идентификатор источника данных или null

originId
string

Идентификатор элемента в источнике данных или null

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

HTTP-статус: 400

{
    "error": "NOT_FOUND",
    "error_description": "Элемент не найден"
}

Название
тип

Описание

error
string

Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только error_description

error_description
string

Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

Возможные коды ошибок

Код

Описание

100

Не передан обязательный параметр id

NOT_FOUND

Дело не найдено: такого идентификатора нет, дело не является конфигурируемым или у пользователя нет доступа к элементу CRM

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Предыдущая
Обновить конфигурируемое дело
Следующая
Обзор методов