Получить информацию о деле по идентификатору crm.activity.get

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

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

Scope: crm

Кто может выполнять метод: любой пользователь

Метод crm.activity.get возвращает информацию о деле по идентификатору.

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

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

Название
тип

Описание

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.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.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 ActivityGetResult = {
          ID: string
          OWNER_ID: string
          OWNER_TYPE_ID: string
          TYPE_ID: string
          PROVIDER_ID: string
          PROVIDER_TYPE_ID: string
          PROVIDER_GROUP_ID: string | null
          ASSOCIATED_ENTITY_ID: string
          SUBJECT: string
          CREATED: ISODate
          LAST_UPDATED: ISODate
          START_TIME: ISODate
          END_TIME: ISODate
          DEADLINE: ISODate
          COMPLETED: string
          STATUS: string
          RESPONSIBLE_ID: string
          PRIORITY: string
          NOTIFY_TYPE: string
          NOTIFY_VALUE: string
          DESCRIPTION: string
          DESCRIPTION_TYPE: string
          DIRECTION: string
          LOCATION: string
          SETTINGS: unknown[]
          ORIGINATOR_ID: string | null
          ORIGIN_ID: string | null
          AUTHOR_ID: string
          EDITOR_ID: string
          PROVIDER_PARAMS: unknown[]
          PROVIDER_DATA: string | null
          RESULT_MARK: string
          RESULT_VALUE: unknown | null
          RESULT_SUM: unknown | null
          RESULT_CURRENCY_ID: string | null
          RESULT_STATUS: string
          RESULT_STREAM: string
          RESULT_SOURCE_ID: string | null
          AUTOCOMPLETE_RULE: string
        }
        
        try {
          const response = await $b24.actions.v2.call.make<ActivityGetResult>({
            method: 'crm.activity.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('Activity:', result.ID, result.SUBJECT, result.STATUS)
          }
        } 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 getActivity() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'crm.activity.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('Activity:', result.ID, result.SUBJECT, result.STATUS)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getActivity)
        </script>
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.activity.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 activity: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'crm.activity.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.get',
            [
                'id' => 999
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

Пример

from b24pysdk.client import BaseClient
        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        client: BaseClient
        
        try:
            bitrix_response = client.crm.activity.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}")
        

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

HTTP-статус: 200

{
            "result": {
                "ID": "999",
                "OWNER_ID": "15",
                "OWNER_TYPE_ID": "3",
                "TYPE_ID": "2",
                "PROVIDER_ID": "VOXIMPLANT_CALL",
                "PROVIDER_TYPE_ID": "CALL",
                "PROVIDER_GROUP_ID": null,
                "ASSOCIATED_ENTITY_ID": "0",
                "SUBJECT": "Исходящий звонок Андрей Николаев",
                "CREATED": "2020-09-27T13:26:55+03:00",
                "LAST_UPDATED": "2021-03-21T20:28:24+03:00",
                "START_TIME": "2020-09-27T13:25:00+03:00",
                "END_TIME": "2020-09-27T19:25:00+03:00",
                "DEADLINE": "2020-09-27T13:25:00+03:00",
                "COMPLETED": "Y",
                "STATUS": "2",
                "RESPONSIBLE_ID": "505",
                "PRIORITY": "2",
                "NOTIFY_TYPE": "1",
                "NOTIFY_VALUE": "15",
                "DESCRIPTION": "",
                "DESCRIPTION_TYPE": "1",
                "DIRECTION": "2",
                "LOCATION": "",
                "SETTINGS": [],
                "ORIGINATOR_ID": null,
                "ORIGIN_ID": null,
                "AUTHOR_ID": "505",
                "EDITOR_ID": "505",
                "PROVIDER_PARAMS": [],
                "PROVIDER_DATA": null,
                "RESULT_MARK": "0",
                "RESULT_VALUE": null,
                "RESULT_SUM": null,
                "RESULT_CURRENCY_ID": null,
                "RESULT_STATUS": "0",
                "RESULT_STREAM": "0",
                "RESULT_SOURCE_ID": null,
                "AUTOCOMPLETE_RULE": "0"
            },
            "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
object

Корневой элемент ответа. Значения для поля result соответствуют полям объекта

time
time

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

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

HTTP-статус: 400

{
            "error": "",
            "error_description": "Access denied."
        }
        

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

Activity is not found

Дело с указанным идентификатором не найдено для сущности в CRM

Access denied

Отсутствуют права на редактирование сущности в CRM

Application context required

Некорректный параметр PROVIDER_ID для дела, созданного в контексте приложения

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

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

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

Описание

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

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

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

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

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

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

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

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

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