Получить список пользовательских полей сообщений форума forum.message.field.custom.list

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

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

Scope: forum

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

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

Метод forum.message.field.custom.list возвращает все пользовательские поля сообщений форума, включая системные поля Битрикс24, например UF_FORUM_MESSAGE_DOC.

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

Название
тип

Описание

select
array

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

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

  • id — идентификатор поля
  • entityId — идентификатор объекта
  • name — код поля
  • userTypeId — тип поля
  • xmlId — внешний код
  • sort — порядок сортировки
  • isMultiple — признак множественного поля
  • isMandatory — признак обязательного поля
  • showFilter — показ в фильтре списка
  • showInList — показ в списке
  • editInList — возможность редактирования
  • isSearchable — участие в поиске
  • settings — настройки типа поля
  • editFormLabel — подпись в форме редактирования
  • listColumnLabel — заголовок колонки в списке
  • listFilterLabel — подпись в фильтре
  • errorMessage — текст ошибки
  • helpMessage — текст подсказки

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

Метод всегда возвращает все поля одним списком: filter и pagination не применяются, а order вызывает ошибку валидации. Нужное поле ищите в ответе по name или получайте методом forum.message.field.custom.get по id.

Примеры кода

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

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

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["id","name","userTypeId","isMultiple","editFormLabel"]}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/forum.message.field.custom.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["id","name","userTypeId","isMultiple","editFormLabel"],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/forum.message.field.custom.list
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

type CustomFieldListResult = {
  items: Array<{
    id: number
    name: string
    userTypeId: string
    isMultiple: boolean
    editFormLabel: string | null
  }>
}

try {
  const response = await $b24.actions.v3.call.make<CustomFieldListResult>({
    method: 'forum.message.field.custom.list',
    params: {
      select: ['id', 'name', 'userTypeId', 'isMultiple', 'editFormLabel'],
    },
    requestId: Text.getUuidRfc4122()
  })

  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    result.items.forEach(field => console.info(field.id, field.name, field.userTypeId))
  }
} 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 listCustomFields() {
    try {
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v3.call.make({
        method: 'forum.message.field.custom.list',
        params: {
          select: ['id', 'name', 'userTypeId', 'isMultiple', 'editFormLabel'],
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

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

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

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

try:
    bitrix_response = client.forum.message.field.custom.list(
        select=["id", "name", "userTypeId", "isMultiple", "editFormLabel"],
    ).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.list',
            [
                'select' => ['id', 'name', 'userTypeId', 'isMultiple', 'editFormLabel'],
            ]
        );

    $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.list',
    {
        select: ['id', 'name', 'userTypeId', 'isMultiple', 'editFormLabel'],
    },
    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.list',
    [
        'select' => ['id', 'name', 'userTypeId', 'isMultiple', 'editFormLabel'],
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "forum.message.field.custom.list", b24.Params{
	"select": []string{"id", "name", "userTypeId", "isMultiple", "editFormLabel"},
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("forum.message.field.custom.list: %w", err)
}

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

var items []struct {
	ID            int     `json:"id"`
	Name          string  `json:"name"`
	UserTypeID    string  `json:"userTypeId"`
	IsMultiple    bool    `json:"isMultiple"`
	EditFormLabel *string `json:"editFormLabel"`
}
if err := json.Unmarshal(raw, &items); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
for _, field := range items {
	fmt.Println(field.ID, field.Name, field.UserTypeID)
}

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

HTTP-статус: 200

{
    "result": {
        "items": [
            {
                "id": 31,
                "name": "UF_FORUM_MESSAGE_DOC",
                "userTypeId": "disk_file",
                "isMultiple": true,
                "editFormLabel": null
            },
            {
                "id": 33,
                "name": "UF_FORUM_MESSAGE_VER",
                "userTypeId": "disk_version",
                "isMultiple": false,
                "editFormLabel": null
            },
            {
                "id": 35,
                "name": "UF_FORUM_MES_URL_PRV",
                "userTypeId": "url_preview",
                "isMultiple": false,
                "editFormLabel": null
            },
            {
                "id": 433,
                "name": "UF_TASK_COMMENT_TYPE",
                "userTypeId": "integer",
                "isMultiple": false,
                "editFormLabel": null
            },
            {
                "id": 6008091,
                "name": "UF_EXTERNAL_ID",
                "userTypeId": "string",
                "isMultiple": false,
                "editFormLabel": "Код во внешней системе"
            }
        ]
    },
    "time": {
        "start": 1792670697,
        "finish": 1792670697.444028,
        "duration": 0.4440279006958008,
        "processing": 0,
        "date_start": "2026-10-22T15:04:57+03:00",
        "date_finish": "2026-10-22T15:04:57+03:00",
        "operating_reset_at": 1792671240,
        "operating": 0
    }
}

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

Название
тип

Описание

result
object

Объект с данными ответа

result.items
array

Массив пользовательских полей сообщений форума. Состав полей элемента зависит от select. Описание полей — в методе forum.message.field.custom.get

time
time

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

Кроме полей, созданных через API, в списке есть системные поля, которые Битрикс24 создает сам:

  • UF_FORUM_MESSAGE_DOC — поле типа disk_file для файлов Диска в сообщении
  • UF_FORUM_MESSAGE_VER — поле типа disk_version для версий файлов Диска
  • UF_FORUM_MES_URL_PRV — поле типа url_preview для превью ссылок
  • UF_TASK_COMMENT_TYPE — системное поле модуля задач

Не изменяйте и не удаляйте системные поля: на них опирается работа комментариев в Битрикс24.

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

HTTP-статус: 400

{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
        "message": "Ошибка при валидации объекта запроса",
        "validation": [
            {
                "message": "В DTO `CustomDto` в поле `id` требуется наличие атрибута `Sortable` для такого запроса",
                "field": "id"
            }
        ]
    }
}

Название
тип

Описание

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_REQUESTVALIDATIONEXCEPTION

Поле

Описание ошибки

Как исправить

#FIELD#

В DTO CustomDto в поле #FIELD# требуется наличие атрибута Sortable для такого запроса

Метод не поддерживает сортировку. Уберите order из запроса

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

Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Поле

Описание ошибки

Как исправить

select

Неизвестное поле #FIELD# для сущности CustomDto

Передайте в select только поля из списка в описании параметра

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

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

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

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