Получить список чатов im.recent.list

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

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

Scope: im

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

Метод im.recent.list получает список последних диалогов пользователя с поддержкой пагинации.

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

Название
тип

Описание

SKIP_OPENLINES
string

Пропускать чаты открытых линий.

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

  • Y — да
  • N — нет

SKIP_DIALOG
string

Пропускать диалоги один-на-один.

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

  • Y — да
  • N — нет

SKIP_CHAT
string

Пропускать групповые чаты.

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

  • Y — да
  • N — нет

LAST_MESSAGE_DATE
datetime

Дата последнего элемента предыдущей выборки в формате ATOM (ISO-8601)

UNREAD_ONLY
string

Возвращать только диалоги с непрочитанными сообщениями.

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

  • Y — да
  • N — нет

PARSE_TEXT
string

Парсить текст последнего сообщения.

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

  • Y — да
  • N — нет

GET_ORIGINAL_TEXT
string

Вернуть оригинальный текст сообщения без преобразований.

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

  • Y — да
  • N — нет

SKIP_UNDISTRIBUTED_OPENLINES
string

Пропускать нераспределенные чаты открытых линий.

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

  • Y — да
  • N — нет

ONLY_OPENLINES
string

Возвращать только чаты открытых линий.

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

  • Y — да
  • N — нет

ONLY_COPILOT
string

Возвращать только чаты BitrixGPT.

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

  • Y — да
  • N — нет

ONLY_CHANNEL
string

Возвращать только каналы.

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

  • Y — да
  • N — нет

CAN_MANAGE_MESSAGES
string

Возвращать только чаты с правом управления сообщениями.

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

  • Y — да
  • N — нет

OFFSET
integer

Смещение для постраничной выборки. По умолчанию: 0

LIMIT
integer

Количество элементов на страницу. По умолчанию: 50. Максимальное значение: 200

Рекомендации по пагинации

  • Для перехода на следующую страницу увеличивайте OFFSET на значение LIMIT (0, 50, 100), а не на количество элементов в ответе.

  • Между страницами могут повторяться одни и те же диалоги, потому что выборка сначала строится по внутренним записям, а затем сворачивается в уникальные диалоги. Из-за этого границы страниц могут пересекаться.

  • Если чаты открытых линий не нужны, передавайте SKIP_OPENLINES = Y — это снижает вероятность пересечений между страницами.

  • Если список небольшой, запрашивайте его одним вызовом с увеличенным LIMIT, максимальное значение 200.

Примеры кода

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

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"LAST_MESSAGE_DATE":"2026-02-25T18:30:00+03:00","SKIP_OPENLINES":"N","SKIP_DIALOG":"N","SKIP_CHAT":"N","UNREAD_ONLY":"Y","PARSE_TEXT":"Y","GET_ORIGINAL_TEXT":"N","SKIP_UNDISTRIBUTED_OPENLINES":"Y","ONLY_COPILOT":"N","ONLY_CHANNEL":"N","CAN_MANAGE_MESSAGES":"Y","OFFSET":0,"LIMIT":20}' \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.recent.list
curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"LAST_MESSAGE_DATE":"2026-02-25T18:30:00+03:00","SKIP_OPENLINES":"N","SKIP_DIALOG":"N","SKIP_CHAT":"N","UNREAD_ONLY":"Y","PARSE_TEXT":"Y","GET_ORIGINAL_TEXT":"N","SKIP_UNDISTRIBUTED_OPENLINES":"Y","ONLY_COPILOT":"N","ONLY_CHANNEL":"N","CAN_MANAGE_MESSAGES":"Y","OFFSET":0,"LIMIT":20,"auth":"**put_access_token_here**"}' \
  https://**put_your_bitrix24_address**/rest/im.recent.list
// 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 the payload returned in result (match the "response handling" section of the page)
type RecentListResult = {
  items: Array<{
    id: string | number
    chat_id: number
    type: string
    title: string
    counter: number
    pinned: boolean
    unread: boolean
    has_reminder: boolean
    date_update: ISODate
    date_last_activity: ISODate
  }>
  hasMorePages: boolean
  hasMore: boolean
  copilot: object | null
  messagesAutoDeleteConfigs: object[]
}

try {
  const response = await $b24.actions.v2.call.make<RecentListResult>({
    method: 'im.recent.list',
    params: {
      LAST_MESSAGE_DATE: '2026-02-25T18:30:00+03:00',
      SKIP_OPENLINES: 'N',
      SKIP_DIALOG: 'N',
      SKIP_CHAT: 'N',
      UNREAD_ONLY: 'Y',
      PARSE_TEXT: 'Y',
      GET_ORIGINAL_TEXT: 'N',
      SKIP_UNDISTRIBUTED_OPENLINES: 'Y',
      ONLY_COPILOT: 'N',
      ONLY_CHANNEL: 'N',
      CAN_MANAGE_MESSAGES: 'Y',
      OFFSET: 0,
      LIMIT: 20,
    },
    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('Loaded dialogs:', result.items.length, 'hasMore:', result.hasMore)
  }
} 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 fetchRecentList() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'im.recent.list',
        params: {
          LAST_MESSAGE_DATE: '2026-02-25T18:30:00+03:00',
          SKIP_OPENLINES: 'N',
          SKIP_DIALOG: 'N',
          SKIP_CHAT: 'N',
          UNREAD_ONLY: 'Y',
          PARSE_TEXT: 'Y',
          GET_ORIGINAL_TEXT: 'N',
          SKIP_UNDISTRIBUTED_OPENLINES: 'Y',
          ONLY_COPILOT: 'N',
          ONLY_CHANNEL: 'N',
          CAN_MANAGE_MESSAGES: 'Y',
          OFFSET: 0,
          LIMIT: 20,
        },
        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('Loaded dialogs:', result.items.length, 'hasMore:', result.hasMore)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

try:
    bitrix_response = client.im.recent.list(
        last_message_date="2026-02-25T18:30:00+03:00",
        skip_openlines=False,
        skip_dialog=False,
        skip_chat=False,
        unread_only=True,
        parse_text=True,
        get_original_text=False,
        skip_undistributed_openlines=True,
        only_copilot=False,
        only_channel=False,
        can_manage_messages=True,
        offset=0,
        limit=20,
    ).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(
            'im.recent.list',
            [
                'LAST_MESSAGE_DATE' => '2026-02-25T18:30:00+03:00',
                'SKIP_OPENLINES' => 'N',
                'SKIP_DIALOG' => 'N',
                'SKIP_CHAT' => 'N',
                'UNREAD_ONLY' => 'Y',
                'PARSE_TEXT' => 'Y',
                'GET_ORIGINAL_TEXT' => 'N',
                'SKIP_UNDISTRIBUTED_OPENLINES' => 'Y',
                'ONLY_COPILOT' => 'N',
                'ONLY_CHANNEL' => 'N',
                'CAN_MANAGE_MESSAGES' => 'Y',
                'OFFSET' => 0,
                'LIMIT' => 20,
            ]
        );

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

    echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error: ' . $e->getMessage();
}
BX24.callMethod(
    'im.recent.list',
    {
        LAST_MESSAGE_DATE: '2026-02-25T18:30:00+03:00',
        SKIP_OPENLINES: 'N',
        SKIP_DIALOG: 'N',
        SKIP_CHAT: 'N',
        UNREAD_ONLY: 'Y',
        PARSE_TEXT: 'Y',
        GET_ORIGINAL_TEXT: 'N',
        SKIP_UNDISTRIBUTED_OPENLINES: 'Y',
        ONLY_COPILOT: 'N',
        ONLY_CHANNEL: 'N',
        CAN_MANAGE_MESSAGES: 'Y',
        OFFSET: 0,
        LIMIT: 20
    },
    function(result)
    {
        if (result.error())
        {
            console.error(result.error());
        }
        else
        {
            console.log(result.data());
        }
    }
);
require_once('crest.php');

$result = CRest::call(
    'im.recent.list',
    [
        'LAST_MESSAGE_DATE' => '2026-02-25T18:30:00+03:00',
        'SKIP_OPENLINES' => 'N',
        'SKIP_DIALOG' => 'N',
        'SKIP_CHAT' => 'N',
        'UNREAD_ONLY' => 'Y',
        'PARSE_TEXT' => 'Y',
        'GET_ORIGINAL_TEXT' => 'N',
        'SKIP_UNDISTRIBUTED_OPENLINES' => 'Y',
        'ONLY_COPILOT' => 'N',
        'ONLY_CHANNEL' => 'N',
        'CAN_MANAGE_MESSAGES' => 'Y',
        'OFFSET' => 0,
        'LIMIT' => 20,
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "im.recent.list", b24.Params{
	"LAST_MESSAGE_DATE":            "2026-02-25T18:30:00+03:00",
	"SKIP_OPENLINES":               "N",
	"SKIP_DIALOG":                  "N",
	"SKIP_CHAT":                    "N",
	"UNREAD_ONLY":                  "Y",
	"PARSE_TEXT":                   "Y",
	"GET_ORIGINAL_TEXT":            "N",
	"SKIP_UNDISTRIBUTED_OPENLINES": "Y",
	"ONLY_COPILOT":                 "N",
	"ONLY_CHANNEL":                 "N",
	"CAN_MANAGE_MESSAGES":          "Y",
	"OFFSET":                       0,
	"LIMIT":                        20,
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("im.recent.list: %w", err)
}

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

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

HTTP-статус: 200

{
    "result": {
        "items": [
            {
                "id": 547,
                "chat_id": 1231,
                "type": "user",
                "avatar": {
                    "url": "",
                    "color": "#1eb4aa"
                },
                "title": "Иван Иванов",
                "message": {
                    "id": 84415,
                    "text": "ntcn",
                    "file": false,
                    "author_id": 547,
                    "attach": false,
                    "sticker": null,
                    "date": "2026-02-25T12:07:10+03:00",
                    "status": "received",
                    "uuid": "0c3c5ad6-a1b8-4d4d-9234-f137ef862a77"
                },
                "counter": 1,
                "last_id": 82363,
                "pinned": false,
                "unread": false,
                "has_reminder": false,
                "date_update": "2026-02-25T12:07:10+03:00",
                "date_last_activity": "2026-02-25T12:07:10+03:00",
                "user": {
                    "id": 547,
                    "active": true,
                    "name": "Иван Иванов",
                    "first_name": "Иван",
                    "last_name": "Иванов",
                    "work_position": "Тестировщик",
                    "color": "#1eb4aa",
                    "avatar": "",
                    "avatar_hr": "/bitrix/js/im/images/blank.gif",
                    "gender": "M",
                    "birthday": "",
                    "extranet": false,
                    "network": false,
                    "bot": false,
                    "connector": false,
                    "external_auth_id": "socservices",
                    "status": "online",
                    "idle": false,
                    "last_activity_date": "2026-02-25T17:42:27+03:00",
                    "mobile_last_date": false,
                    "desktop_last_date": false,
                    "absent": false,
                    "departments": [
                        1,
                        667
                    ],
                    "phones": false,
                    "bot_data": null,
                    "type": "user",
                    "website": "",
                    "email": "ivan.ivanov@mysite.ru"
                },
                "chat": {
                    "text_field_enabled": true,
                    "background_id": null,
                    "mute_list": []
                },
                "options": []
            },
            {
                "id": "chat1317",
                "chat_id": 1317,
                "type": "chat",
                "avatar": {
                    "url": "https://cdn-ru.bitrix24.ru/b17053/resize_cache/54309/ff58db95aecdfa09ae61b51b5fd8f63f/im/553/5539ce72ef842ca40efd35b54322d828/7qd8lz4rsqwubjru086fst8tx6uhkxa9",
                    "color": "#4ba984"
                },
                "title": "Хочу зеленый чат",
                "message": {
                    "id": 84413,
                    "text": "ntcn",
                    "file": false,
                    "author_id": 547,
                    "attach": false,
                    "sticker": null,
                    "date": "2026-02-25T12:07:05+03:00",
                    "status": "received",
                    "uuid": "f4721d3d-68c6-473e-a899-3b96b0ee18db"
                },
                "counter": 1,
                "last_id": 82447,
                "pinned": false,
                "unread": false,
                "has_reminder": false,
                "date_update": "2026-02-25T12:07:05+03:00",
                "date_last_activity": "2026-02-25T12:07:05+03:00",
                "chat": {
                    "id": 1317,
                    "parent_chat_id": 0,
                    "parent_message_id": 0,
                    "name": "Хочу зеленый чат",
                    "owner": 547,
                    "extranet": false,
                    "contains_collaber": false,
                    "avatar": "https://cdn-ru.bitrix24.ru/b17053/resize_cache/54309/ff58db95aecdfa09ae61b51b5fd8f63f/im/553/5539ce72ef842ca40efd35b54322d828/7qd8lz4rsqwubjru086fst8tx6uhkxa9",
                    "color": "#4ba984",
                    "type": "chat",
                    "entity_type": "",
                    "entity_id": "",
                    "entity_data_1": "",
                    "entity_data_2": "",
                    "entity_data_3": "",
                    "mute_list": {
                        "503": true
                    },
                    "manager_list": [],
                    "date_create": "2025-08-12T16:14:00+03:00",
                    "message_type": "C",
                    "user_counter": 2,
                    "restrictions": {
                        "avatar": true,
                        "rename": true,
                        "extend": true,
                        "call": true,
                        "mute": true,
                        "leave": true,
                        "leave_owner": true,
                        "send": true,
                        "user_list": true
                    },
                    "role": "MEMBER",
                    "text_field_enabled": true,
                    "background_id": null,
                    "entity_link": {
                        "type": "",
                        "url": "",
                        "id": ""
                    },
                    "permissions": {
                        "manage_users_add": "member",
                        "manage_users_delete": "manager",
                        "manage_ui": "member",
                        "manage_settings": "owner",
                        "manage_messages": "member",
                        "can_post": "member"
                    },
                    "public": ""
                },
                "user": {
                    "id": 547,
                    "active": true,
                    "name": "Иван Иванов",
                    "first_name": "Иван",
                    "last_name": "Иванов",
                    "work_position": "Тестировщик",
                    "color": "#1eb4aa",
                    "avatar": "",
                    "avatar_hr": "/bitrix/js/im/images/blank.gif",
                    "gender": "M",
                    "birthday": "",
                    "extranet": false,
                    "network": false,
                    "bot": false,
                    "connector": false,
                    "external_auth_id": "socservices",
                    "status": "online",
                    "idle": false,
                    "last_activity_date": "2026-02-25T17:42:27+03:00",
                    "mobile_last_date": false,
                    "desktop_last_date": false,
                    "absent": false,
                    "departments": [
                        1,
                        667
                    ],
                    "phones": false,
                    "bot_data": null,
                    "type": "user",
                    "website": "",
                    "email": "ivan.ivanov@mysite.ru"
                },
                "options": []
            }
        ],
        "hasMorePages": false,
        "hasMore": false,
        "copilot": {
            "chats": null,
            "messages": null,
            "roles": {
                "copilot_assistant": {
                    "code": "copilot_assistant",
                    "name": "BitrixGPT",
                    "desc": "Готов отвечать на все вопросы в общем формате",
                    "avatar": {
                        "small": "https://preview.bitrix24.site/upload/ai/avatars/5f72dd53304450356e0eaf09c0fcda7b_64x64.png",
                        "medium": "https://preview.bitrix24.site/upload/ai/avatars/f62609ab98ede5b3d4bff7675cc9f1f5_128x128.png",
                        "large": "https://preview.bitrix24.site/upload/ai/avatars/0a89c642ed5f1c2a292f7c3a1eab99d3_256x256.png"
                    },
                    "default": true,
                    "prompts": [
                        {
                            "code": "universal_how_to_properly_write_a_business_letter",
                            "promptType": "default",
                            "title": "Как правильно составить деловое письмо?",
                            "text": "Как правильно составить деловое письмо?",
                            "isNew": false
                        },
                        {
                            "code": "universal_effective_methods_to_combat_procrastination_in_the_workplace",
                            "promptType": "default",
                            "title": "Как бороться с прокрастинацией?",
                            "text": "Расскажи про эффективные методы борьбы с прокрастинацией на рабочем месте",
                            "isNew": false
                        },
                        {
                            "code": "universal_ideas_on_how_to_make_meetings_more_concise_and_substantive",
                            "promptType": "default",
                            "title": "Идеи для совещаний",
                            "text": "Есть идеи, как сделать совещания более компактными и содержательными?",
                            "isNew": false
                        },
                        {
                            "code": "universal_ideas_for_short_breaks_for_physical_exercises",
                            "promptType": "default",
                            "title": "Идеи для коротких перерывов",
                            "text": "Предложи идеи для коротких перерывов на физические упражнения в офисе",
                            "isNew": false
                        }
                    ]
                }
            },
            "recommendedRoles": [
                "copilot_assistant",
                "smm_manager",
                "seo_copywriter",
                "prompt_generator",
                "marketing_specialist"
            ]
        },
        "messagesAutoDeleteConfigs": []
    },
    "total": -1,
    "time": {
        "start": 1772089843,
        "finish": 1772089843.789026,
        "duration": 0.7890260219573975,
        "processing": 0,
        "date_start": "2026-02-26T10:10:43+03:00",
        "date_finish": "2026-02-26T10:10:43+03:00",
        "operating_reset_at": 1772090443,
        "operating": 0.2634410858154297
    }
}

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

Название
тип

Описание

result
object

Корневой объект результата (подробное описание)

total
integer

Общее количество элементов. В текущей реализации обычно -1

time
time

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

Объект result-item

Название
тип

Описание

items
array

Список последних диалогов (подробное описание)

hasMorePages
boolean

Устаревающий алиас поля hasMore

hasMore
boolean

Признак наличия следующей страницы выборки

copilot
object

Дополнительные данные для элементов BitrixGPT (подробное описание)

messagesAutoDeleteConfigs
array

Настройки автоудаления сообщений по чатам

Объект items

Название
тип

Описание

id
string

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

chat_id
integer

Идентификатор чата

type
string

Тип записи: user или chat

avatar
object

Объект аватара (подробное описание)

title
string

Заголовок записи: имя пользователя или название чата

message
object

Последнее сообщение в диалоге (подробное описание)

counter
integer

Счетчик непрочитанных сообщений

last_id
integer

Идентификатор последнего прочитанного сообщения

pinned
boolean

Признак закрепленного диалога

unread
boolean

Признак ручной метки «не прочитано»

has_reminder
boolean

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

date_update
datetime

Дата последнего изменения диалога в формате ISO 8601

date_last_activity
datetime

Дата последней активности в диалоге в формате ISO 8601

user
object

Данные пользователя (подробное описание)

chat
object

Данные чата (подробное описание)

lines
object

Данные открытой линии (подробное описание)

options
array

Дополнительные параметры записи

Объект avatar

Название
тип

Описание

url
string

Ссылка на аватар. Если пусто, аватар не задан

color
string

Цвет диалога в формате HEX

Объект message

Название
тип

Описание

id
integer

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

text
string

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

file
boolean

Признак наличия файлов

author_id
integer

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

attach
boolean

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

date
datetime

Дата сообщения в формате ATOM

status
string

Статус доставки сообщения

sticker
integer

Идентификатор стикера. Если стикера нет, значение null

uuid
string

Внешний идентификатор сообщения. Если не задан, значение null

Объект user

Название
тип

Описание

id
integer

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

active
boolean

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

name
string

Имя и фамилия пользователя

first_name
string

Имя пользователя

last_name
string

Фамилия пользователя

work_position
string

Должность пользователя

color
string

Цвет пользователя в формате HEX

avatar
string

Ссылка на аватар

avatar_hr
string

Ссылка на avatar высокого разрешения

gender
string

Пол пользователя

birthday
string

День рождения в формате DD-MM или пустая строка

extranet
boolean

Признак внешнего экстранет-пользователя

network
boolean

Признак пользователя Битрикс24.Network

bot
boolean

Признак бота

connector
boolean

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

external_auth_id
string

Код внешней авторизации

status
string

Статус пользователя

idle
datetime

Дата, когда пользователь отошел от компьютера. Если не задано, false

last_activity_date
datetime

Дата последней активности пользователя

mobile_last_date
datetime

Дата последней активности в мобильном приложении. Если не задано, false

desktop_last_date
datetime

Дата последней активности в десктоп-приложении. Если не задано, false

absent
datetime

Дата отпуска пользователя. Если не задано, false

departments
array

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

phones
object

Контактные телефоны пользователя. Может быть false

bot_data
object

Данные бота. Для обычного пользователя может быть null

type
string

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

website
string

Сайт пользователя

email
string

Email пользователя

Объект chat

Название
тип

Описание

id
integer

Идентификатор чата

parent_chat_id
integer

Идентификатор родительского чата

parent_message_id
integer

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

name
string

Название чата

owner
integer

Идентификатор владельца чата

extranet
boolean

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

contains_collaber
boolean

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

avatar
string

Ссылка на аватар. Если пусто, аватар не задан

color
string

Цвет чата в формате HEX

type
string

Тип чата

entity_type
string

Внешний код чата: тип

entity_id
string

Внешний код чата: идентификатор

entity_data_1
string

Внешние данные 1 для чата

entity_data_2
string

Внешние данные 2 для чата

entity_data_3
string

Внешние данные 3 для чата

mute_list
array

Список пользователей с отключенными уведомлениями

manager_list
array

Список идентификаторов менеджеров чата

date_create
datetime

Дата создания чата в формате ATOM

message_type
string

Тип сообщений чата

user_counter
integer

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

restrictions
object

Ограничения действий в чате (подробное описание)

role
string

Роль текущего пользователя в чате

text_field_enabled
boolean

Доступность поля ввода сообщений

background_id
integer

Идентификатор фона чата. Если не задан, значение null

entity_link
object

Ссылка на связанный объект (подробное описание)

permissions
object

Права действий в чате (подробное описание)

public
string

Признак публичности чата

Объект lines

Название
тип

Описание

id
integer

Идентификатор открытой линии

status
integer

Статус открытой линии

date_create
datetime

Дата создания открытой линии в формате ATOM

Объект restrictions

Название
тип

Описание

avatar
boolean

Доступность изменения аватара

rename
boolean

Доступность изменения названия

extend
boolean

Доступность расширения чата

call
boolean

Доступность звонков

mute
boolean

Доступность отключения уведомлений

leave
boolean

Доступность выхода из чата

leave_owner
boolean

Доступность выхода владельца из чата

send
boolean

Доступность отправки сообщений

user_list
boolean

Доступность просмотра списка участников

Название
тип

Описание

type
string

Тип связанного объекта

url
string

Ссылка на связанный объект

id
string

Идентификатор связанного объекта

Объект permissions

Название
тип

Описание

manage_users_add
string

Право на добавление участников

manage_users_delete
string

Право на удаление участников

manage_ui
string

Право на управление интерфейсом чата

manage_settings
string

Право на управление настройками чата

manage_messages
string

Право на управление сообщениями

can_post
string

Право на отправку сообщений

Объект copilot

Название
тип

Описание

chats
object

Данные BitrixGPT-чатов. Может быть null

messages
object

Данные BitrixGPT-сообщений. Может быть null

roles
object

Описание доступных ролей BitrixGPT

recommendedRoles
array

Список рекомендуемых ролей BitrixGPT

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

HTTP-статус: 401

{
    "error": "INVALID_CREDENTIALS",
    "error_description": "Invalid request credentials"
}

У метода нет собственных кодов ошибок — возможны только системные ошибки REST API.

Название
тип

Описание

error
string

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

error_description
string

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

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

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

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

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