Получить значения списка пользовательского поля forum.message.field.custom.enum.list

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

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

Scope: forum

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

Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.

Метод forum.message.field.custom.enum.list возвращает все значения пользовательского поля типа «Список» сообщений форума.

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

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

Название
тип

Описание

filter*
array

Идентификатор пользовательского поля, значения которого нужно получить. Передайте одно условие в формате ["fieldId", идентификатор], например ["fieldId", 6008093].

Метод принимает фильтр только в таком виде. Стандартный формат REST 3.0 — массив условий [["fieldId", 6008093]] или [["fieldId", "=", 6008093]] — вызывает ошибку.

Поле должно иметь тип enumeration. Идентификатор можно получить методом forum.message.field.custom.list

select
array

Массив полей значения, которые нужно вернуть в ответе.

Доступные поля:

id — идентификатор значения
fieldId — идентификатор пользовательского поля
value — текст значения
isDefault — признак значения по умолчанию
sort — порядок сортировки
xmlId — внешний код значения

По умолчанию: все поля

Метод возвращает все значения поля за один запрос, отсортированные по возрастанию sort. Параметры order и pagination на результат не влияют. Сортировка по любому полю, кроме id, вызывает ошибку валидации.

Примеры кода

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

Вызов нового API отличается добавлением параметра /api/ в запросе:

https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/forum.message.field.custom.enum.list

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":["fieldId",6008093],"select":["id","value","isDefault","sort","xmlId"]}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/forum.message.field.custom.enum.list

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":["fieldId",6008093],"select":["id","value","isDefault","sort","xmlId"],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/forum.message.field.custom.enum.list

import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

type EnumValueListResult = {
  items: {
    id: number
    value: string
    isDefault: boolean
    sort: number
    xmlId: string
  }[]
}

try {
  const response = await $b24.actions.v3.call.make<EnumValueListResult>({
    method: 'forum.message.field.custom.enum.list',
    params: {
      filter: ['fieldId', 6008093],
      select: ['id', 'value', 'isDefault', 'sort', 'xmlId'],
    },
    requestId: Text.getUuidRfc4122()
  })

  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    result.items.forEach(item => console.info(item.id, item.value))
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}

<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function listEnumValues() {
    try {
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v3.call.make({
        method: 'forum.message.field.custom.enum.list',
        params: {
          filter: ['fieldId', 6008093],
          select: ['id', 'value', 'isDefault', 'sort', 'xmlId'],
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      result.items.forEach(item => console.info(item.id, item.value))
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.forum.message.field.custom.enum.list(
        filter=["fieldId", 6008093],
        select=["id", "value", "isDefault", "sort", "xmlId"],
    ).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}")

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

try {
    $response = $b24Service
        ->core
        ->call(
            'forum.message.field.custom.enum.list',
            [
                'filter' => ['fieldId', 6008093],
                'select' => ['id', 'value', 'isDefault', 'sort', 'xmlId'],
            ]
        );

    $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: ' . $e->getMessage();
}

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

BX24.callMethod(
    'forum.message.field.custom.enum.list',
    {
        filter: ['fieldId', 6008093],
        select: ['id', 'value', 'isDefault', 'sort', 'xmlId'],
    },
    result => {
        if (result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

require_once('crest.php');

$result = CRest::call(
    'forum.message.field.custom.enum.list',
    [
        'filter' => ['fieldId', 6008093],
        'select' => ['id', 'value', 'isDefault', 'sort', 'xmlId'],
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "forum.message.field.custom.enum.list", b24.Params{
	"filter": []any{"fieldId", 6008093},
	"select": []string{"id", "value", "isDefault", "sort", "xmlId"},
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("forum.message.field.custom.enum.list: %w", err)
}

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

var items []struct {
	ID        int    `json:"id"`
	Value     string `json:"value"`
	IsDefault bool   `json:"isDefault"`
	Sort      int    `json:"sort"`
	XMLID     string `json:"xmlId"`
}
if err := json.Unmarshal(raw, &items); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
for _, item := range items {
	fmt.Println(item.ID, item.Value)
}

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

HTTP-статус: 200

{
    "result": {
        "items": [
            {
                "id": 4077,
                "value": "Срочный",
                "isDefault": false,
                "sort": 5,
                "xmlId": "HIGH"
            },
            {
                "id": 4079,
                "value": "Обычный",
                "isDefault": true,
                "sort": 20,
                "xmlId": "NORMAL"
            },
            {
                "id": 4081,
                "value": "Низкий",
                "isDefault": true,
                "sort": 30,
                "xmlId": "LOW"
            }
        ]
    },
    "time": {
        "start": 1792670773,
        "finish": 1792670773.884,
        "duration": 0.8840000629425049,
        "processing": 0,
        "date_start": "2026-10-22T15:06:13+03:00",
        "date_finish": "2026-10-22T15:06:13+03:00",
        "operating_reset_at": 1792671360,
        "operating": 0
    }
}

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

Название `тип`	Описание
result `object`	Объект с данными ответа
result.items `array`	Массив значений поля. Состав полей зависит от `select`. Если у поля нет значений, массив пустой. Описание полей
time `time`	Информация о времени выполнения запроса

Элемент items

Название `тип`	Описание
id `integer`	Идентификатор значения списка
fieldId `integer`	Идентификатор пользовательского поля, к которому относится значение
value `string`	Текст значения
isDefault `boolean`	`true` — значение по умолчанию, `false` — обычное значение. Признак может стоять у нескольких значений поля
sort `integer`	Порядок сортировки
xmlId `string`	Внешний код значения

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

HTTP-статус: 400, 404

{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTFILTERVALIDATIONEXCEPTION",
        "message": "Ошибка при валидации фильтров объекта запроса",
        "validation": [
            {
                "message": "Требуется указать фильтр по обязательному полю `fieldId`",
                "field": "filter.fieldId"
            }
        ]
    }
}

Название `тип`	Описание
error.code `string`	Строковый код ошибки. Используйте для идентификации типа исключения
error.message `string`	Текстовое описание ошибки
error.validation `array`	Массив c деталями ошибки. Присутствует только в ошибках валидации данных `BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION`
error.validation[].field `string`	Название поля, в котором возникла ошибка валидации
error.validation[].message `string`	Описание ошибки, связанной с указанным полем

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

Ошибки фильтра

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTFILTERVALIDATIONEXCEPTION

Поле	Описание ошибки	Как исправить
`filter.fieldId`	Требуется указать фильтр по обязательному полю `fieldId`	Передайте фильтр одним условием `["fieldId", 6008093]`, без внешнего массива

Код ошибки: BITRIX_REST_V3_EXCEPTION_INVALIDFILTEREXCEPTION

Поле	Описание ошибки	Как исправить
`filter`	Не удается распознать выражение фильтра `Unknown filter condition`	Передайте фильтр массивом `["fieldId", 6008093]`, а не объектом

Ошибки валидации запроса

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Поле	Описание ошибки	Как исправить
`filter`	Значение поля не может быть пустым	Передайте `filter` с идентификатором поля
`fieldId`	В поле `fieldId` требуется тип данных `int` для такого запроса	Передайте идентификатор поля числом, а не строкой
`#FIELD#`	В DTO `EnumDto` в поле `#FIELD#` требуется наличие атрибута `Sortable` для такого запроса	Не передавайте `order`: метод его не применяет

Поле не найдено

Код ошибки: BITRIX_REST_V3_REALISATION_EXCEPTION_FIELDNOTFOUNDEXCEPTION

HTTP-статус: 404

Поле	Описание ошибки	Как исправить
`-`	Поле `#FIELD_ID#` не найдено	Пользовательского поля с таким идентификатором нет у сообщений форума или его тип не `enumeration`. Проверьте поле методом forum.message.field.custom.list

Ошибка неизвестного поля

Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Поле	Описание ошибки	Как исправить
`select`	Неизвестное поле `#FIELD#` для сущности `EnumDto`	Передайте в `select` только поля из описания элемента items

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

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

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

Была ли статья полезна?

Получить значение списка пользовательского поля

Удалить значение списка пользовательского поля

Получить значения списка пользовательского поля forum.message.field.custom.enum.list

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

Примеры кодаПримеры кода

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

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

Элемент itemsЭлемент items

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

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

Ошибки фильтраОшибки фильтра

Ошибки валидации запросаОшибки валидации запроса

Поле не найденоПоле не найдено

Ошибка неизвестного поляОшибка неизвестного поля

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

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

Была ли статья полезна?

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

Примеры кода

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

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

Элемент items

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

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

Ошибки фильтра

Ошибки валидации запроса

Поле не найдено

Ошибка неизвестного поля

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

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