Получить доступные пользователю сообщения Ленты новостей log.blogpost.get

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

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

Scope: log

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

Метод log.blogpost.get возвращает сообщения Ленты новостей, доступные текущему пользователю.

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

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

Название
тип

Описание

POST_ID
integer

Фильтрация по идентификатору сообщения.

Идентификатор указан в поле ID элемента результата метода.

Если параметр передан, фильтрация по LOG_RIGHTS игнорируется

LOG_RIGHTS
array

Фильтрация по получателям, у которых есть право на просмотр сообщения.

Возможные значения:

  • SG<X> — рабочие группы и проекты с идентификатором X. Идентификатор можно получить методом sonet_group.get
  • U<X> — пользователи с идентификатором X. Идентификатор можно получить методом user.get
  • UA — все авторизованные пользователи
  • DR<X> — подразделения компании с идентификатором X. Идентификатор можно получить методом department.get

Параметр применяется, только если не передан POST_ID. Если не переданы оба параметра, метод возвращает все сообщения, доступные текущему пользователю

LOG_DATE_FROM
string

Нижняя граница периода публикации сообщения в формате ISO 8601. Если указаны LOG_DATE_FROM и LOG_DATE_TO, значение LOG_DATE_FROM не должно быть позже LOG_DATE_TO. Пустая строка не ограничивает выборку

LOG_DATE_TO
string

Верхняя граница периода публикации сообщения в формате ISO 8601. Если значение не указано или передана пустая строка, верхняя граница периода не применяется

FIRST_ID
integer

Идентификатор записи Ленты новостей для курсорной навигации вперед. Метод вернет сообщения с идентификаторами больше указанного значения. Если переданы FIRST_ID и LAST_ID, применяется FIRST_ID. Значение 0 или пустая строка начинает выборку с края списка

LAST_ID
integer

Идентификатор записи Ленты новостей для курсорной навигации назад. Метод вернет сообщения с идентификаторами меньше указанного значения. Значение 0 или пустая строка начинает выборку с края списка

LIMIT
integer

Размер страницы в курсорном режиме. По умолчанию — 50. Неположительное или нечисловое значение заменяется значением по умолчанию. Максимальное значение — 200

start
integer

Параметр используется для управления постраничной навигацией.

Размер страницы результатов всегда статичный — 50 записей.

Чтобы выбрать вторую страницу результатов, необходимо передавать значение 50. Чтобы выбрать третью страницу результатов — значение 100 и так далее.

Формула расчета значения параметра start:

start = (N - 1) * 50, где N — номер нужной страницы

Передайте FIRST_ID или LAST_ID, чтобы включить курсорный режим. В этом режиме параметр start игнорируется, а LIMIT задает размер страницы. Без курсоров метод использует постраничную навигацию через start по 50 записей.

Примеры кода

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"POST_ID":217}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/log.blogpost.get

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"POST_ID":217,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/log.blogpost.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 each BlogPostItem returned in result[]
type BlogPostItem = {
  ID: string
  BLOG_ID: string
  PUBLISH_STATUS: string
  TITLE: string
  AUTHOR_ID: string
  ENABLE_COMMENTS: string
  NUM_COMMENTS: string
  CODE: string | null
  MICRO: string
  DETAIL_TEXT: string
  DATE_PUBLISH: ISODate | null
  CATEGORY_ID: string
  HAS_SOCNET_ALL: string
  HAS_TAGS: string
  HAS_IMAGES: string
  HAS_PROPS: string
  HAS_COMMENT_IMAGES: string | null
  FILES: number[]
}

try {
  // log.blogpost.get returns a single page (max 50 records). For the whole result set
  // use a list helper: $b24.actions.v2.callList.make() returns every record as one
  // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
  // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
  // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
  const response = await $b24.actions.v2.call.make<BlogPostItem[]>({
    method: 'log.blogpost.get',
    params: {
      POST_ID: 217,
      start: 0,
    },
    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('Blog posts count:', result.length, 'First post title:', result[0]?.TITLE)
  }
} 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 getBlogPosts() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      // log.blogpost.get returns a single page (max 50 records). For the whole result set
      // use a list helper: $b24.actions.v2.callList.make() returns every record as one
      // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
      // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
      // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
      const response = await $b24.actions.v2.call.make({
        method: 'log.blogpost.get',
        params: {
          POST_ID: 217,
          start: 0,
        },
        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('Blog posts count:', result.length, 'First post title:', result[0]?.TITLE)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.log.blogpost.get(
        post_id=217,
        start=0,
    ).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(
            'log.blogpost.get',
            [
                'POST_ID' => 217
            ]
        );

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

    echo 'Success: ' . print_r($result, true);
    processData($result);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error retrieving blog post: ' . $e->getMessage();
}

BX24.callMethod(
    'log.blogpost.get',
    {
        POST_ID: 217
    },
    function(result)
    {
        if (result.error())
        {
            console.error(result.error(), result.error_description());
        }
        else
        {
            console.log(result.data());
        }
    }
);

require_once('crest.php');

$result = CRest::call(
    'log.blogpost.get',
    [
        'POST_ID' => 217
    ]
);

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

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "log.blogpost.get", b24.Params{
	"POST_ID": 217,
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("log.blogpost.get: %w", err)
}

// Ответ приходит как json.RawMessage — разберите его
// в структуру под форму ответа, показанную ниже на этой странице.
fmt.Printf("%s\n", res.Result)

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

HTTP-статус: 200

Пример ответа:

{
    "result": [
        {
        "ID": "217",
        "BLOG_ID": "299",
        "PUBLISH_STATUS": "P",
        "TITLE": "Новый регламент",
        "AUTHOR_ID": "1269",
        "ENABLE_COMMENTS": "Y",
        "NUM_COMMENTS": "0",
        "CODE": null,
        "MICRO": "N",
        "DETAIL_TEXT": "С 1 ноября обновляется процесс согласования.",
        "DATE_PUBLISH": "2026-03-17T15:29:15+03:00",
        "CATEGORY_ID": "9,11,13",
        "HAS_SOCNET_ALL": "N",
        "HAS_TAGS": "Y",
        "HAS_IMAGES": "N",
        "HAS_PROPS": "Y",
        "HAS_COMMENT_IMAGES": null,
        "UF_BLOG_POST_DOC": {
            "ID": "1",
            "ENTITY_ID": "BLOG_POST",
            "FIELD_NAME": "UF_BLOG_POST_DOC",
            "USER_TYPE_ID": "file",
            "XML_ID": "UF_BLOG_POST_DOC",
            "SORT": "100",
            "MULTIPLE": "Y",
            "MANDATORY": "N",
            "SHOW_FILTER": "N",
            "SHOW_IN_LIST": "N",
            "EDIT_IN_LIST": "Y",
            "IS_SEARCHABLE": "Y",
            "SETTINGS": {
            "SIZE": 20,
            "LIST_WIDTH": 0,
            "LIST_HEIGHT": 0,
            "MAX_SHOW_SIZE": 0,
            "MAX_ALLOWED_SIZE": 0,
            "EXTENSIONS": [],
            "TARGET_BLANK": "Y",
            "DEFAULT_VIEW": null
            },
            "EDIT_FORM_LABEL": null,
            "LIST_COLUMN_LABEL": null,
            "LIST_FILTER_LABEL": null,
            "ERROR_MESSAGE": null,
            "HELP_MESSAGE": null,
            "USER_TYPE": {
            "USER_TYPE_ID": "file",
            "CLASS_NAME": "Bitrix\\Main\\UserField\\Types\\FileType",
            "EDIT_CALLBACK": ["Bitrix\\Main\\UserField\\Types\\FileType", "renderEdit"],
            "VIEW_CALLBACK": ["Bitrix\\Main\\UserField\\Types\\FileType", "renderView"],
            "USE_FIELD_COMPONENT": true,
            "DESCRIPTION": "Файл",
            "BASE_TYPE": "file"
            },
            "VALUE": false,
            "ENTITY_VALUE_ID": 217,
            "VALUE_EXISTS": true,
            "VALUE_RAW": null,
            "CUSTOM_DATA": []
        },
        "UF_BLOG_POST_URL_PRV": {
            "ID": "5",
            "ENTITY_ID": "BLOG_POST",
            "FIELD_NAME": "UF_BLOG_POST_URL_PRV",
            "USER_TYPE_ID": "url_preview",
            "XML_ID": "UF_BLOG_POST_URL_PRV",
            "SORT": "100",
            "MULTIPLE": "N",
            "MANDATORY": "N",
            "SHOW_FILTER": "N",
            "SHOW_IN_LIST": "N",
            "EDIT_IN_LIST": "Y",
            "IS_SEARCHABLE": "Y",
            "SETTINGS": [],
            "EDIT_FORM_LABEL": null,
            "LIST_COLUMN_LABEL": null,
            "LIST_FILTER_LABEL": null,
            "ERROR_MESSAGE": null,
            "HELP_MESSAGE": null,
            "USER_TYPE": {
            "USER_TYPE_ID": "url_preview",
            "CLASS_NAME": "Bitrix\\Main\\UrlPreview\\UrlPreviewUserType",
            "DESCRIPTION": "Содержимое ссылки",
            "BASE_TYPE": "int"
            },
            "VALUE": null,
            "ENTITY_VALUE_ID": 217,
            "VALUE_EXISTS": true,
            "VALUE_RAW": null,
            "CUSTOM_DATA": []
        },
        "UF_GRATITUDE": {
            "ID": "9",
            "ENTITY_ID": "BLOG_POST",
            "FIELD_NAME": "UF_GRATITUDE",
            "USER_TYPE_ID": "integer",
            "XML_ID": "UF_GRATITUDE",
            "SORT": "100",
            "MULTIPLE": "N",
            "MANDATORY": "N",
            "SHOW_FILTER": "N",
            "SHOW_IN_LIST": "N",
            "EDIT_IN_LIST": "Y",
            "IS_SEARCHABLE": "N",
            "SETTINGS": {
            "SIZE": 20,
            "MIN_VALUE": 0,
            "MAX_VALUE": 0,
            "DEFAULT_VALUE": null
            },
            "EDIT_FORM_LABEL": null,
            "LIST_COLUMN_LABEL": null,
            "LIST_FILTER_LABEL": null,
            "ERROR_MESSAGE": null,
            "HELP_MESSAGE": null,
            "USER_TYPE": {
            "USER_TYPE_ID": "integer",
            "CLASS_NAME": "Bitrix\\Main\\UserField\\Types\\IntegerType",
            "EDIT_CALLBACK": ["Bitrix\\Main\\UserField\\Types\\IntegerType", "renderEdit"],
            "VIEW_CALLBACK": ["Bitrix\\Main\\UserField\\Types\\IntegerType", "renderView"],
            "USE_FIELD_COMPONENT": true,
            "DESCRIPTION": "Целое число",
            "BASE_TYPE": "int"
            },
            "VALUE": null,
            "ENTITY_VALUE_ID": 217,
            "VALUE_EXISTS": true,
            "VALUE_RAW": null,
            "CUSTOM_DATA": []
        },
        "UF_BLOG_POST_FILE": {
            "ID": "19",
            "ENTITY_ID": "BLOG_POST",
            "FIELD_NAME": "UF_BLOG_POST_FILE",
            "USER_TYPE_ID": "disk_file",
            "XML_ID": "UF_BLOG_POST_FILE",
            "SORT": "100",
            "MULTIPLE": "Y",
            "MANDATORY": "N",
            "SHOW_FILTER": "N",
            "SHOW_IN_LIST": "N",
            "EDIT_IN_LIST": "Y",
            "IS_SEARCHABLE": "Y",
            "SETTINGS": {
            "IBLOCK_ID": null,
            "SECTION_ID": null,
            "UF_TO_SAVE_ALLOW_EDIT": false
            },
            "EDIT_FORM_LABEL": null,
            "LIST_COLUMN_LABEL": null,
            "LIST_FILTER_LABEL": null,
            "ERROR_MESSAGE": null,
            "HELP_MESSAGE": null,
            "USER_TYPE": {
            "USER_TYPE_ID": "disk_file",
            "CLASS_NAME": "Bitrix\\Disk\\Uf\\FileUserType",
            "DESCRIPTION": "Файл (Диск)",
            "BASE_TYPE": "int",
            "TAG": ["DISK FILE ID", "DOCUMENT ID"]
            },
            "VALUE": [505],
            "ENTITY_VALUE_ID": 217,
            "VALUE_EXISTS": true,
            "VALUE_RAW": "a:1:{i:0;i:505;}",
            "CUSTOM_DATA": {
            "PHOTO_TEMPLATE": "gallery"
            }
        },
        "UF_BLOG_POST_IMPRTNT": {
            "ID": "83",
            "ENTITY_ID": "BLOG_POST",
            "FIELD_NAME": "UF_BLOG_POST_IMPRTNT",
            "USER_TYPE_ID": "integer",
            "XML_ID": "UF_BLOG_POST_IMPRTNT",
            "SORT": "100",
            "MULTIPLE": "N",
            "MANDATORY": "N",
            "SHOW_FILTER": "N",
            "SHOW_IN_LIST": "Y",
            "EDIT_IN_LIST": "Y",
            "IS_SEARCHABLE": "N",
            "SETTINGS": {
            "SIZE": 20,
            "MIN_VALUE": 0,
            "MAX_VALUE": 0,
            "DEFAULT_VALUE": null
            },
            "EDIT_FORM_LABEL": "Важное сообщение",
            "LIST_COLUMN_LABEL": "Важное",
            "LIST_FILTER_LABEL": "Важное",
            "ERROR_MESSAGE": null,
            "HELP_MESSAGE": null,
            "USER_TYPE": {
            "USER_TYPE_ID": "integer",
            "CLASS_NAME": "Bitrix\\Main\\UserField\\Types\\IntegerType",
            "EDIT_CALLBACK": ["Bitrix\\Main\\UserField\\Types\\IntegerType", "renderEdit"],
            "VIEW_CALLBACK": ["Bitrix\\Main\\UserField\\Types\\IntegerType", "renderView"],
            "USE_FIELD_COMPONENT": true,
            "DESCRIPTION": "Целое число",
            "BASE_TYPE": "int"
            },
            "VALUE": null,
            "ENTITY_VALUE_ID": 217,
            "VALUE_EXISTS": true,
            "VALUE_RAW": null,
            "CUSTOM_DATA": []
        },
        "UF_IMPRTANT_DATE_END": {
            "ID": "85",
            "ENTITY_ID": "BLOG_POST",
            "FIELD_NAME": "UF_IMPRTANT_DATE_END",
            "USER_TYPE_ID": "datetime",
            "XML_ID": "UF_IMPRTANT_DATE_END",
            "SORT": "100",
            "MULTIPLE": "N",
            "MANDATORY": "N",
            "SHOW_FILTER": "N",
            "SHOW_IN_LIST": "N",
            "EDIT_IN_LIST": "Y",
            "IS_SEARCHABLE": "N",
            "SETTINGS": {
            "DEFAULT_VALUE": {
                "TYPE": "NONE",
                "VALUE": ""
            },
            "USE_SECOND": "Y",
            "USE_TIMEZONE": "N"
            },
            "EDIT_FORM_LABEL": "Срок действия",
            "LIST_COLUMN_LABEL": "Срок",
            "LIST_FILTER_LABEL": null,
            "ERROR_MESSAGE": null,
            "HELP_MESSAGE": null,
            "USER_TYPE": {
            "USER_TYPE_ID": "datetime",
            "CLASS_NAME": "Bitrix\\Main\\UserField\\Types\\DateTimeType",
            "EDIT_CALLBACK": ["Bitrix\\Main\\UserField\\Types\\DateTimeType", "renderEdit"],
            "VIEW_CALLBACK": ["Bitrix\\Main\\UserField\\Types\\DateTimeType", "renderView"],
            "USE_FIELD_COMPONENT": true,
            "DESCRIPTION": "Дата со временем",
            "BASE_TYPE": "datetime"
            },
            "VALUE": "",
            "ENTITY_VALUE_ID": 217,
            "VALUE_EXISTS": true,
            "VALUE_RAW": null,
            "CUSTOM_DATA": []
        },
        "UF_BLOG_POST_VOTE": {
            "ID": "131",
            "ENTITY_ID": "BLOG_POST",
            "FIELD_NAME": "UF_BLOG_POST_VOTE",
            "USER_TYPE_ID": "vote",
            "XML_ID": "UF_BLOG_POST_VOTE",
            "SORT": "100",
            "MULTIPLE": "N",
            "MANDATORY": "N",
            "SHOW_FILTER": "N",
            "SHOW_IN_LIST": "Y",
            "EDIT_IN_LIST": "Y",
            "IS_SEARCHABLE": "N",
            "SETTINGS": {
            "CHANNEL_ID": 1,
            "UNIQUE": 8,
            "UNIQUE_IP_DELAY": {
                "DELAY": "10",
                "DELAY_TYPE": "D"
            },
            "NOTIFY": "I"
            },
            "EDIT_FORM_LABEL": null,
            "LIST_COLUMN_LABEL": null,
            "LIST_FILTER_LABEL": null,
            "ERROR_MESSAGE": null,
            "HELP_MESSAGE": null,
            "USER_TYPE": {
            "USER_TYPE_ID": "vote",
            "CLASS_NAME": "Bitrix\\Vote\\Uf\\VoteUserType",
            "DESCRIPTION": "Опрос",
            "BASE_TYPE": "int"
            },
            "VALUE": null,
            "ENTITY_VALUE_ID": 217,
            "VALUE_EXISTS": true,
            "VALUE_RAW": null,
            "CUSTOM_DATA": []
        },
        "UF_MAIL_MESSAGE": {
            "ID": "439",
            "ENTITY_ID": "BLOG_POST",
            "FIELD_NAME": "UF_MAIL_MESSAGE",
            "USER_TYPE_ID": "mail_message",
            "XML_ID": "",
            "SORT": "100",
            "MULTIPLE": "N",
            "MANDATORY": "N",
            "SHOW_FILTER": "N",
            "SHOW_IN_LIST": "N",
            "EDIT_IN_LIST": "Y",
            "IS_SEARCHABLE": "N",
            "SETTINGS": null,
            "EDIT_FORM_LABEL": null,
            "LIST_COLUMN_LABEL": null,
            "LIST_FILTER_LABEL": null,
            "ERROR_MESSAGE": null,
            "HELP_MESSAGE": null,
            "USER_TYPE": {
            "USER_TYPE_ID": "mail_message",
            "CLASS_NAME": "Bitrix\\Mail\\MessageUserType",
            "DESCRIPTION": "Письмо (email)",
            "BASE_TYPE": "int",
            "VIEW_CALLBACK": ["Bitrix\\Mail\\MessageUserType", "getPublicView"],
            "EDIT_CALLBACK": ["Bitrix\\Mail\\MessageUserType", "getPublicEdit"],
            "onBeforeSave": ["Bitrix\\Mail\\MessageUserType", "onBeforeSave"],
            "onDelete": ["Bitrix\\Mail\\MessageUserType", "onDelete"]
            },
            "VALUE": null,
            "ENTITY_VALUE_ID": 217,
            "VALUE_EXISTS": true,
            "VALUE_RAW": null,
            "CUSTOM_DATA": []
        },
        "FILES": [505]
        }
    ],
    "total": 1,
    "time": {
        "start": 1773754540,
        "finish": 1773754540.902101,
        "duration": 0.9021010398864746,
        "processing": 0,
        "date_start": "2026-03-17T16:35:40+03:00",
        "date_finish": "2026-03-17T16:35:40+03:00",
        "operating_reset_at": 1773755140,
        "operating": 0
    }
}

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

Название
тип

Описание

result
object[]

Список сообщений Ленты новостей. Поля каждого элемента перечислены в следующих строках таблицы.

Пустой массив означает, что нет записей, удовлетворяющих фильтру

ID
integer

Идентификатор сообщения

BLOG_ID
integer

Идентификатор блога, к которому относится сообщение

PUBLISH_STATUS
string

Статус публикации сообщения

TITLE
string

Заголовок сообщения

AUTHOR_ID
integer

Идентификатор автора сообщения

ENABLE_COMMENTS
string

Разрешены ли комментарии

NUM_COMMENTS
integer

Количество комментариев

CODE
string

Символьный код сообщения

MICRO
string

Признак микросообщения

DETAIL_TEXT
string

Текст сообщения

DATE_PUBLISH
datetime

Дата и время публикации

CATEGORY_ID
string

Идентификаторы тегов (категорий) через запятую

HAS_SOCNET_ALL
string

Признак публикации для всех авторизованных пользователей

HAS_TAGS
string

Признак наличия тегов

HAS_IMAGES
string

Признак наличия изображений

HAS_PROPS
string

Признак наличия пользовательских полей

HAS_COMMENT_IMAGES
string

Признак наличия изображений в комментариях

UF_*
object

Пользовательские поля сообщения. Набор полей зависит от настроек портала. Формат каждого поля описан ниже

UF_BLOG_POST_DOC
object

Дополнительное поле с файлами

UF_BLOG_POST_URL_PRV
object

Данные превью ссылки из текста сообщения, если превью удалось сформировать

UF_GRATITUDE
object

Служебное поле для функционала Благодарность

UF_BLOG_POST_FILE
object

Файлы Диска, прикрепленные к сообщению

UF_BLOG_POST_IMPRTNT
object

Признак важного сообщения

UF_IMPRTANT_DATE_END
object

Дата и время, до которых сообщение считается важным

UF_BLOG_POST_VOTE
object

Данные опроса, если к сообщению прикреплен опрос

UF_MAIL_MESSAGE
object

Связь сообщения с почтой

FILES
array

Массив ID файлов из UF_BLOG_POST_FILE

next
integer

Значение для постраничной навигации (если есть)

total
integer

Общее количество найденных элементов

time
time

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

Объект UF_*

Название
тип

Описание

ID
integer

Идентификатор пользовательского поля

ENTITY_ID
string

Объект поля

FIELD_NAME
string

Код пользовательского поля

USER_TYPE_ID
string

Тип пользовательского поля

XML_ID
string

Внешний код поля

SORT
integer

Порядок сортировки поля

MULTIPLE
string

Признак множественного поля

MANDATORY
string

Признак обязательности

SHOW_FILTER
string

Признак отображения поля в фильтре

SHOW_IN_LIST
string

Признак отображения поля в списках

EDIT_IN_LIST
string

Признак редактирования поля в списках

IS_SEARCHABLE
string

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

SETTINGS
object

Настройки поля в зависимости от типа

EDIT_FORM_LABEL
string

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

LIST_COLUMN_LABEL
string

Подпись поля в колонках списка

LIST_FILTER_LABEL
string

Подпись поля в фильтре

ERROR_MESSAGE
string

Текст ошибки поля

HELP_MESSAGE
string

Подсказка для поля

USER_TYPE
object

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

VALUE
string

Значение поля

ENTITY_VALUE_ID
integer

Идентификатор сообщения, к которому относится значение поля

VALUE_EXISTS
boolean

Признак наличия значения поля

VALUE_RAW
string

Сырое значение поля

CUSTOM_DATA
object

Дополнительные данные поля

Объект USER_TYPE

Название
тип

Описание

USER_TYPE_ID
string

Идентификатор типа пользовательского поля

CLASS_NAME
string

PHP-класс обработчика типа поля

EDIT_CALLBACK
array

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

VIEW_CALLBACK
array

Обработчик, который формирует отображение поля в интерфейсе просмотра

USE_FIELD_COMPONENT
boolean

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

DESCRIPTION
string

Название типа поля

BASE_TYPE
string

Базовый тип значения

TAG
array

Дополнительные теги типа поля

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

HTTP-статус: 400

{
    "error": "ERROR_ARGUMENT",
    "error_description": "Wrong date format in LOG_DATE_FROM"
}

Название
тип

Описание

error
string

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

error_description
string

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

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

Код

Описание

Значение

ERROR_ARGUMENT

Wrong date format in LOG_DATE_FROM

В LOG_DATE_FROM передана дата в неверном формате

ERROR_ARGUMENT

Wrong date format in LOG_DATE_TO

В LOG_DATE_TO передана дата в неверном формате

ERROR_ARGUMENT

LOG_DATE_FROM is later than LOG_DATE_TO

Нижняя граница периода LOG_DATE_FROM позже верхней границы LOG_DATE_TO

ERROR_ARGUMENT

Wrong FIRST_ID value

В FIRST_ID передано отрицательное или нечисловое значение

ERROR_ARGUMENT

Wrong LAST_ID value

В LAST_ID передано отрицательное или нечисловое значение

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

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

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

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

Предыдущая
Изменить сообщение
Следующая
Удалить сообщение