Добавить бейдж crm.activity.badge.add

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

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

Scope: crm

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

Метод crm.activity.badge.add регистрирует бейдж — значок, который появится на карточке элемента в канбане.

Метод только регистрирует бейдж и не привязывает его к элементу CRM. Чтобы значок появился, код бейджа передают в поле badgeCode конфигурируемого дела при вызове crm.activity.configurable.add или crm.activity.configurable.update.

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

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

Название
тип

Описание

code*
string

Код бейджа, например missedCall. Не длиннее 30 символов и уникальный

title*
string|object

Название бейджа. Строка или объект с переводами, где ключ — код языка

value*
string|object

Текст внутри значка, выводится в верхнем регистре. Строка или объект с переводами

type*
string

Тип бейджа. Определяет цвет значка: success, failure, warning, primary или secondary

Занятые коды возвращает метод crm.activity.badge.list.

В объекте с переводами ключами могут быть только коды языков, которые знает Битрикс24, например ru, en, de.

Примеры кода

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"code":"missedCall","title":"Статус звонка","value":"Пропущен","type":"failure"}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.activity.badge.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"code":"missedCall","title":"Статус звонка","value":"Пропущен","type":"failure","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.activity.badge.add
// 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 BadgeAddResult = {
  badge: {
    code: string
    // title и value приходят строкой или объектом с переводами
    title: string | Record<string, string>
    value: string | Record<string, string>
    type: string
  }
}

try {
  const response = await $b24.actions.v2.call.make<BadgeAddResult>({
    method: 'crm.activity.badge.add',
    params: {
      code: 'missedCall',
      title: 'Статус звонка',
      value: 'Пропущен',
      type: 'failure',
    },
    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.badge)
  }
} 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 addActivityBadge() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'crm.activity.badge.add',
        params: {
          code: 'missedCall',
          title: 'Статус звонка',
          value: 'Пропущен',
          type: 'failure',
        },
        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.badge)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

try:
    bitrix_response = client.crm.activity.badge.add(
        code="missedCall",
        title="Статус звонка",
        value="Пропущен",
        type="failure",
    ).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.badge.add',
            [
                'code'  => 'missedCall',
                'title' => 'Статус звонка',
                'value' => 'Пропущен',
                'type'  => 'failure'
            ]
        );

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

    if ($result->error()) {
        error_log($result->error());
    } else {
        echo 'Success: ' . print_r($result->data(), true);
    }

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error adding activity badge: ' . $e->getMessage();
}
BX24.callMethod(
    "crm.activity.badge.add",
    {
        code: 'missedCall',
        title: 'Статус звонка',
        value: 'Пропущен',
        type: 'failure'
    }, result => {
        if (result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }    
);
require_once('crest.php');

$result = CRest::call(
    'crm.activity.badge.add',
    [
        'code' => 'missedCall',
        'title' => 'Статус звонка',
        'value' => 'Пропущен',
        'type' => 'failure'
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.activity.badge.add", b24.Params{
	"code":  "missedCall",
	"title": "Статус звонка",
	"value": "Пропущен",
	"type":  "failure",
})
if err != nil {
	return fmt.Errorf("crm.activity.badge.add: %w", err)
}

// Метод заворачивает ответ в объект с ключом "badge".
raw, ok := b24.Unwrap(res.Result, "badge")
if !ok {
	return fmt.Errorf("в ответе нет ключа badge")
}

var item struct {
	Code string `json:"code"`
	// Title и Value приходят строкой или объектом с переводами
	Title any    `json:"title"`
	Value any    `json:"value"`
	Type  string `json:"type"`
}
if err := json.Unmarshal(raw, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.Code, item.Title)

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

HTTP-статус: 200

{
    "result": {
        "badge": {
            "code": "missedCall",
            "title": "Статус звонка",
            "value": "Пропущен",
            "type": "failure"
        }
    },
    "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

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

time
time

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

Объект badge

Название
тип

Описание

code
string

Код бейджа. Его передают в поле badgeCode конфигурируемого дела

title
string|object

Название бейджа в том виде, в котором его передали

value
string|object

Текст внутри значка

type
string

Тип бейджа

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

HTTP-статус: 400

{
    "error": "BX_INVALID_VALUE",
    "error_description": "Code must be unique"
}

Название
тип

Описание

error
string

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

error_description
string

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

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

Код

Описание

ACCESS_DENIED

Недостаточно прав: метод доступен только пользователю с административным доступом к разделу CRM

100

Не передан обязательный параметр. Его имя приходит в описании ошибки, например Could not find value for parameter {title}

REQUIRED_ARG_MISSING

Поле title или value пустое либо передано не строкой и не объектом

WRONG_TYPE_VALUE

Значение поля type не входит в список допустимых

BX_INVALID_VALUE

Бейдж с таким кодом уже зарегистрирован: Code must be unique

0

Общий код ошибки валидации. Причину называет error_description: The length of the code field must not exceed 30 characters — код длиннее 30 символов, Language `X` was not found — в объекте с переводами указан неизвестный код языка

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

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

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

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