Показать информацию о приложении app.info

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

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

Scope: базовый

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

Метод app.info возвращает информацию о приложении: статус, версию, срок оплаты и тариф Битрикс24, см. также ответ при вызове через вебхук.

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

Без параметров.

Примеры кода

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/app.info
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
    "auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/app.info
// 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 } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of the payload returned in result (match the "response handling" section of the page)
type AppInfoResult = {
  ID: number
  CODE: string
  VERSION: number
  STATUS: string
  INSTALLED: boolean
  PAYMENT_EXPIRED: string
  DAYS: number | null
  LANGUAGE_ID: string
  LICENSE: string
  LICENSE_PREVIOUS?: string
  LICENSE_TYPE?: string
  LICENSE_FAMILY?: string
}

try {
  const response = await $b24.actions.v2.call.make<AppInfoResult>({
    method: 'app.info',
    params: {},
    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.ID, result.CODE, result.STATUS, result.LICENSE)
  }
} 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 getAppInfo() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'app.info',
        params: {},
        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.ID, result.CODE, result.STATUS, result.LICENSE)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getAppInfo)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.app.info().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 {
    $applicationInfoResult = $serviceBuilder->getMainScope()->main()->getApplicationInfo();
    $itemResult = $applicationInfoResult->applicationInfo();
    print("ID: " . $itemResult->ID . PHP_EOL);
    print("Code: " . $itemResult->CODE . PHP_EOL);
    print("Version: " . $itemResult->VERSION . PHP_EOL);
    print("Status: " . $itemResult->getStatus()->getStatusCode() . PHP_EOL);
    print("Installed: " . ($itemResult->INSTALLED ? 'true' : 'false') . PHP_EOL);
    print("Payment Expired: " . $itemResult->PAYMENT_EXPIRED . PHP_EOL);
    print("Days: " . $itemResult->DAYS . PHP_EOL);
    print("License: " . $itemResult->LICENSE . PHP_EOL);
} catch (Throwable $e) {
    print("Error: " . $e->getMessage() . PHP_EOL);
}
BX24.callMethod(
    "app.info",
    {},
    function(result)
    {
        if(result.error())
            console.error(result.error());
        else
            console.log(result.data());
    }
);
require_once('crest.php');

$result = CRest::call(
    'app.info',
    []
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "app.info", nil)
if err != nil {
	return fmt.Errorf("app.info: %w", err)
}

var item struct {
	ID             b24.ID `json:"ID"`
	Code           string `json:"CODE"`
	Version        int    `json:"VERSION"`
	Status         string `json:"STATUS"`
	Installed      bool   `json:"INSTALLED"`
	PaymentExpired string `json:"PAYMENT_EXPIRED"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.Code)

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

HTTP-статус: 200

{
    "result": {
        "ID": 5,
        "CODE": "telefum24.kp10",
        "VERSION": 4,
        "STATUS": "F",
        "INSTALLED": true,
        "PAYMENT_EXPIRED": "N",
        "DAYS": null,
        "LANGUAGE_ID": "ru",
        "LICENSE": "ru_ent10000",
        "LICENSE_TYPE": "ent10000",
        "LICENSE_FAMILY": "ent"
    },
    "time": {
        "start": 1722841503.0585,
        "finish": 1722841503.09885,
        "duration": 0.0403509140014648,
        "processing": 0.00533103942871094,
        "date_start": "2024-08-05T07:05:03+00:00",
        "date_finish": "2024-08-05T07:05:03+00:00",
        "operating": 0
    }
}

Возвращаемые данные

Название
тип

Описание

result
object

Информация о приложении (подробное описание)

time
time

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

Объект result

Название
тип

Описание

ID
integer

Локальный идентификатор приложения в Битрикс24

CODE
string

Код приложения

VERSION
integer

Установленная версия приложения

STATUS
string

Статус приложения:

  • L — локальное приложение
  • F — бесплатное тиражное приложение
  • S — подписное тиражное приложение

INSTALLED
boolean

Завершена ли установка приложения. Если false, приложение доступно только администраторам Битрикс24 и должно сообщить об окончании установки вызовом BX24.installFinish. Пока значение false, Битрикс24 не доставляет приложению события и не показывает его встройки, даже если event.bind и placement.bind отработали успешно

PAYMENT_EXPIRED
string

Истек ли оплаченный период: Y или N

DAYS
integer

Количество дней до конца подписки или оплаченного периода. После окончания срока — отрицательное число.

null, если срок не ограничен, например у бесплатного или локального приложения, а также у подписного приложения, когда подписка в Битрикс24 не подключена

LANGUAGE_ID
string

Язык сайта Битрикс24 по умолчанию, например ru

LICENSE
string

Тариф Битрикс24 с префиксом региона, например ru_std. Для тарифов, состав которых менялся при сохранении названия, например CRM+, Команда и Компания, по этому полю нельзя понять, какой именно тариф действует. Примеры значений:

  • ru_project — тариф Проект
  • ru_basic — тариф Базовый
  • ru_std — тариф Стандартный
  • ru_pro100 — тариф Профессиональный
  • ru_ent250 — Энтерпрайз 250
  • ru_ent500 — Энтерпрайз 500
  • ru_ent1000 — Энтерпрайз 1000
  • ru_ent2000 — Энтерпрайз 2000
  • ru_ent10000 — Энтерпрайз 10000

В коробочной версии Битрикс24 — строка <язык>_selfhosted, например ru_selfhosted

LICENSE_PREVIOUS
string

Тариф, который действовал до демо-режима, в формате LICENSE. Приходит, только если Битрикс24 сейчас в демо-режиме тарифа

LICENSE_TYPE
string

Идентификатор тарифа без префикса региона, например ent10000. Только в облачном Битрикс24

LICENSE_FAMILY
string

Семейство тарифа, например ent. Только в облачном Битрикс24

Когда подписка закончилась или не подключена, поле PAYMENT_EXPIRED равно Y. Если срок подписки известен, поле DAYS содержит отрицательное число — сколько дней прошло после окончания.

Ответ при вызове через вебхук

Через вебхук метод не возвращает данные о приложении, а отдает scope вебхука и тариф Битрикс24:

{
    "result": {
        "SCOPE": [
            "crm",
            "user"
        ],
        "LICENSE": "ru_std"
    },
    "time": {
        "start": 1790665588,
        "finish": 1790665588.741944,
        "duration": 0.7419440746307373,
        "processing": 0,
        "date_start": "2026-09-29T10:06:28+03:00",
        "date_finish": "2026-09-29T10:06:28+03:00",
        "operating_reset_at": 1790666188,
        "operating": 0.11118412017822266
    }
}

Название
тип

Описание

SCOPE
string[]

Коды scope вебхука, как в методе scope

LICENSE
string

Тариф Битрикс24, формат как у поля LICENSE выше

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

HTTP-статус: 403

{
    "error": "ACCESS_DENIED",
    "error_description": "Access denied! Application context required"
}

Название
тип

Описание

error
string

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

error_description
string

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

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

Статус

Код

Описание

Значение

403

ACCESS_DENIED

Access denied! Application context required

Запрос авторизован не приложением и не вебхуком, а сессией пользователя

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

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

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

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