Получить список открытых линий imopenlines.config.list.get

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

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

Scope: imopenlines

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

Метод imopenlines.config.list.get получает список открытых линий.

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

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

Название
тип

Описание

PARAMS
object

Параметры выборки (подробное описание)

OPTIONS
object

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

Параметр PARAMS

Название
тип

Описание

select
array

Массив содержит список полей, которые необходимо выбрать.

Можно указывать поля из таблицы Элемент массива result. Поля QUEUE, QUEUE_USERS_FIELDS, CONFIG_QUEUE возвращаются только через OPTIONS

order
object

Объект для сортировки списка открытых линий в формате {"field_1": "value_1", ... "field_N": "value_N"}

Направление сортировки может принимать значения:

  • asc — по возрастанию
  • desc — по убыванию

Для field_N используйте поля из таблицы Элемент массива result. Поля QUEUE, QUEUE_USERS_FIELDS, CONFIG_QUEUE не поддерживаются в order

filter
object

Объект для фильтрации списка открытых линий в формате {"field_1": "value_1", ... "field_N": "value_N"}

Для field_N используйте поля из таблицы Элемент массива result. Поля QUEUE, QUEUE_USERS_FIELDS, CONFIG_QUEUE не поддерживаются в filter

limit
integer

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

offset
integer

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

Параметр OPTIONS

Название
тип

Описание

QUEUE
char

Возвращать очередь операторов. Возможные значения:

  • Y — да
  • N — нет

CONFIG_QUEUE
char

Возвращать очередь линии. Каждый элемент очереди содержит ENTITY_TYPE и ENTITY_ID. Возможные значения:

  • Y — да
  • N — нет

CHECK_PERMISSION
string

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

Примеры кода

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

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "PARAMS": {
      "select": ["ID", "LINE_NAME", "ACTIVE"],
      "order": {"ID": "ASC"},
      "filter": {"ACTIVE": "Y"},
      "limit": 50,
      "offset": 0
    },
    "OPTIONS": {
      "QUEUE": "Y",
      "CONFIG_QUEUE": "Y"
    }
  }' \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imopenlines.config.list.get
curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "PARAMS": {
      "select": ["ID", "LINE_NAME", "ACTIVE"],
      "order": {"ID": "ASC"},
      "filter": {"ACTIVE": "Y"},
      "limit": 50,
      "offset": 0
    },
    "OPTIONS": {
      "QUEUE": "Y",
      "CONFIG_QUEUE": "Y"
    },
    "auth": "**put_access_token_here**"
  }' \
  https://**put_your_bitrix24_address**/rest/imopenlines.config.list.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 } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of each OpenLineItem returned in result[]
type OpenLineItem = {
  ID: string
  LINE_NAME: string
  ACTIVE: string
  QUEUE?: number[]
  QUEUE_USERS_FIELDS?: Record<string, {
    USER_NAME: string | null
    USER_WORK_POSITION: string | null
    USER_AVATAR: string | null
    USER_AVATAR_ID: number | null
  }>
  CONFIG_QUEUE?: Array<{
    ENTITY_ID: string
    ENTITY_TYPE: string
  }>
}

try {
  // imopenlines.config.list.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<OpenLineItem[]>({
    method: 'imopenlines.config.list.get',
    params: {
      PARAMS: {
        select: ['ID', 'LINE_NAME', 'ACTIVE'],
        order: { ID: 'ASC' },
        filter: { ACTIVE: 'Y' },
        limit: 50,
        offset: 0,
      },
      OPTIONS: {
        QUEUE: 'Y',
        CONFIG_QUEUE: 'Y',
      },
    },
    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('Open lines count:', result.length, 'First line:', result[0]?.LINE_NAME)
  }
} 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 getOpenLineList() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      // imopenlines.config.list.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: 'imopenlines.config.list.get',
        params: {
          PARAMS: {
            select: ['ID', 'LINE_NAME', 'ACTIVE'],
            order: { ID: 'ASC' },
            filter: { ACTIVE: 'Y' },
            limit: 50,
            offset: 0,
          },
          OPTIONS: {
            QUEUE: 'Y',
            CONFIG_QUEUE: 'Y',
          },
        },
        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('Open lines count:', result.length, 'First line:', result[0]?.LINE_NAME)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

try:
    bitrix_response = client.imopenlines.config.list.get(
        params={
            "select": [
                "ID",
                "LINE_NAME",
                "ACTIVE",
            ],
            "order": {
                "ID": "ASC",
            },
            "filter": {
                "ACTIVE": "Y",
            },
            "limit": 50,
            "offset": 0,
        },
        options={
            "QUEUE": "Y",
            "CONFIG_QUEUE": "Y",
        },
    ).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(
            'imopenlines.config.list.get',
            [
                'PARAMS' => [
                    'select' => ['ID', 'LINE_NAME', 'ACTIVE'],
                    'order' => ['ID' => 'ASC'],
                    'filter' => ['ACTIVE' => 'Y'],
                    'limit' => 50,
                    'offset' => 0,
                ],
                'OPTIONS' => [
                    'QUEUE' => 'Y',
                    'CONFIG_QUEUE' => 'Y',
                ],
            ]
        );

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

    print_r($result);
} catch (Throwable $e) {
    echo $e->getMessage();
}
BX24.callMethod(
    'imopenlines.config.list.get',
    {
        PARAMS: {
            select: ['ID', 'LINE_NAME', 'ACTIVE'],
            order: { ID: 'ASC' },
            filter: { ACTIVE: 'Y' },
            limit: 50,
            offset: 0
        },
        OPTIONS: {
            QUEUE: 'Y',
            CONFIG_QUEUE: 'Y'
        }
    },
    function(result)
    {
        if (result.error())
        {
            console.error(result.error());
        }
        else
        {
            console.log(result.data());
        }
    }
);
require_once('crest.php');

$result = CRest::call(
    'imopenlines.config.list.get',
    [
        'PARAMS' => [
            'select' => ['ID', 'LINE_NAME', 'ACTIVE'],
            'order' => ['ID' => 'ASC'],
            'filter' => ['ACTIVE' => 'Y'],
            'limit' => 50,
            'offset' => 0,
        ],
        'OPTIONS' => [
            'QUEUE' => 'Y',
            'CONFIG_QUEUE' => 'Y',
        ],
    ]
);

print_r($result);
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "imopenlines.config.list.get", b24.Params{
	"PARAMS": b24.Params{
		"select": []string{"ID", "LINE_NAME", "ACTIVE"},
		"order": b24.Params{
			"ID": "ASC",
		},
		"filter": b24.Params{
			"ACTIVE": "Y",
		},
		"limit":  50,
		"offset": 0,
	},
	"OPTIONS": b24.Params{
		"QUEUE":        "Y",
		"CONFIG_QUEUE": "Y",
	},
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("imopenlines.config.list.get: %w", err)
}

var items []struct {
	ID       b24.ID `json:"ID"`
	LineName string `json:"LINE_NAME"`
	Active   string `json:"ACTIVE"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
	fmt.Println(it.ID, it.LineName)
}

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

HTTP-статус: 200

{
    "result": [
        {
            "ID": "15",
            "LINE_NAME": "Линия поддержки VIP",
            "ACTIVE": "Y",
            "QUEUE": [101, 205],
            "QUEUE_USERS_FIELDS": {
                "101": {
                    "USER_NAME": "Иван Петров",
                    "USER_WORK_POSITION": "Оператор",
                    "USER_AVATAR": "https://example.bitrix24.ru/upload/main/a1b/avatar.jpg",
                    "USER_AVATAR_ID": 312
                },
                "205": {
                    "USER_NAME": "Анна Смирнова",
                    "USER_WORK_POSITION": null,
                    "USER_AVATAR": "",
                    "USER_AVATAR_ID": null
                }
            },
            "CONFIG_QUEUE": [
                {
                    "ENTITY_ID": "10",
                    "ENTITY_TYPE": "department"
                }
            ]
        },
        {
            "ID": "16",
            "LINE_NAME": "Линия продаж",
            "ACTIVE": "Y",
            "QUEUE": [101],
            "QUEUE_USERS_FIELDS": {
                "101": {
                    "USER_NAME": "Иван Петров",
                    "USER_WORK_POSITION": "Оператор",
                    "USER_AVATAR": "https://example.bitrix24.ru/upload/main/a1b/avatar.jpg",
                    "USER_AVATAR_ID": 312
                }
            },
            "CONFIG_QUEUE": []
        }
    ],
    "time": {
        "start": 1741688574.50636,
        "finish": 1741688574.701981,
        "duration": 0.19562101364135742,
        "processing": 0.09473705291748047,
        "date_start": "2025-03-11T10:29:34+03:00",
        "date_finish": "2025-03-11T10:29:34+03:00",
        "operating_reset_at": 1741689174,
        "operating": 0
    }
}

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

Название
тип

Описание

result
array

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

time
time

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

Элемент массива result

Название
тип

Описание

ID
string

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

LINE_NAME
string

Название открытой линии

ACTIVE
string

Признак активности линии. Возможные значения:

  • Y — линия активна
  • N — линия неактивна

CRM
string

Признак работы с CRM. Возможные значения:

  • Y — да
  • N — нет

CRM_CREATE
string

Сценарий создания элемента CRM

CRM_CREATE_SECOND
string

Дополнительный режим создания элемента CRM

CRM_CREATE_THIRD
string

Дополнительный режим создания элемента CRM. Возможные значения:

  • Y — да
  • N — нет

CRM_FORWARD
string

Признак перенаправления в CRM. Возможные значения:

  • Y — да
  • N — нет

CRM_CHAT_TRACKER
string

Признак отправки диалога в трекер CRM. Возможные значения:

  • Y — да
  • N — нет

CRM_TRANSFER_CHANGE
string

Признак смены ответственного при переводе. Возможные значения:

  • Y — да
  • N — нет

CRM_SOURCE
string

Режим работы с источником в CRM

QUEUE_TYPE
string

Режим распределения обращений

QUEUE_TIME
string

Время перехода обращения к следующему оператору

NO_ANSWER_TIME
string

Время до срабатывания сценария без ответа

CHECK_AVAILABLE
string

Проверять доступность операторов. Возможные значения:

  • Y — да
  • N — нет

WATCH_TYPING
string

Показывать набор текста оператором. Возможные значения:

  • Y — да
  • N — нет

WELCOME_BOT_ENABLE
string

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

  • Y — да
  • N — нет

WELCOME_MESSAGE
string

Признак приветственного сообщения. Возможные значения:

  • Y — да
  • N — нет

WELCOME_MESSAGE_TEXT
string

Текст приветственного сообщения

VOTE_MESSAGE
string

Признак запроса оценки. Возможные значения:

  • Y — да
  • N — нет

VOTE_TIME_LIMIT
string

Ограничение времени для оценки

VOTE_BEFORE_FINISH
string

Запрашивать оценку до завершения диалога. Возможные значения:

  • Y — да
  • N — нет

VOTE_CLOSING_DELAY
string

Использовать задержку закрытия после оценки. Возможные значения:

  • Y — да
  • N — нет

VOTE_MESSAGE_1_TEXT
string

Текст первого сценария оценки

VOTE_MESSAGE_1_LIKE
string

Текст при положительной оценке по первому сценарию

VOTE_MESSAGE_1_DISLIKE
string

Текст при отрицательной оценке по первому сценарию

VOTE_MESSAGE_2_TEXT
string

Текст второго сценария оценки

VOTE_MESSAGE_2_LIKE
string

Текст при положительной оценке по второму сценарию

VOTE_MESSAGE_2_DISLIKE
string

Текст при отрицательной оценке по второму сценарию

AGREEMENT_MESSAGE
string

Признак вывода сообщения о согласии. Возможные значения:

  • Y — да
  • N — нет

AGREEMENT_ID
string

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

CATEGORY_ENABLE
string

Признак использования категорий. Возможные значения:

  • Y — да
  • N — нет

CATEGORY_ID
string

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

WELCOME_BOT_JOIN
string

Режим подключения приветственного бота

WELCOME_BOT_ID
string

Идентификатор приветственного бота

WELCOME_BOT_TIME
string

Время ожидания подключения приветственного бота

WELCOME_BOT_LEFT
string

Режим отключения приветственного бота

NO_ANSWER_RULE
string

Сценарий при отсутствии ответа оператора

NO_ANSWER_FORM_ID
string

Идентификатор формы сценария отсутствия ответа

NO_ANSWER_BOT_ID
string

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

NO_ANSWER_TEXT
string

Текст сообщения при отсутствии ответа

WORKTIME_ENABLE
string

Признак учета рабочего времени. Возможные значения:

  • Y — да
  • N — нет

WORKTIME_FROM
string

Начало рабочего времени

WORKTIME_TO
string

Конец рабочего времени

WORKTIME_TIMEZONE
string

Часовой пояс рабочего времени

WORKTIME_HOLIDAYS
array

Массив праздничных дней

WORKTIME_DAYOFF
array

Массив выходных дней

WORKTIME_DAYOFF_RULE
string

Сценарий обработки обращений в нерабочее время

WORKTIME_DAYOFF_FORM_ID
string

Идентификатор формы сценария нерабочего времени

WORKTIME_DAYOFF_BOT_ID
string

Идентификатор бота сценария нерабочего времени

WORKTIME_DAYOFF_TEXT
string

Текст сообщения в нерабочее время

CLOSE_RULE
string

Сценарий закрытия диалога

CLOSE_FORM_ID
string

Идентификатор формы закрытия

CLOSE_BOT_ID
string

Идентификатор бота закрытия

CLOSE_TEXT
string

Текст сообщения при закрытии

FULL_CLOSE_TIME
string

Время полного закрытия сессии

AUTO_CLOSE_RULE
string

Сценарий автозакрытия

AUTO_CLOSE_FORM_ID
string

Идентификатор формы автозакрытия

AUTO_CLOSE_BOT_ID
string

Идентификатор бота автозакрытия

AUTO_CLOSE_TIME
string

Время до автозакрытия

AUTO_CLOSE_TEXT
string

Текст автозакрытия

AUTO_EXPIRE_TIME
string

Время истечения активности

DATE_CREATE
object

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

DATE_MODIFY
object

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

MODIFY_USER_ID
string

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

TEMPORARY
string

Признак временной линии. Возможные значения:

  • Y — временная линия
  • N — постоянная линия

XML_ID
string

Внешний идентификатор. Возможные значения:

  • string — внешний идентификатор задан
  • null — внешний идентификатор не задан

LANGUAGE_ID
string

Язык линии

QUICK_ANSWERS_IBLOCK_ID
string

Идентификатор инфоблока быстрых ответов

SESSION_PRIORITY
string

Приоритет сессии

TYPE_MAX_CHAT
string

Режим ограничения активных диалогов на оператора

MAX_CHAT
string

Максимум активных диалогов на оператора

OPERATOR_DATA
string

Режим отображения данных оператора

QUEUE
array

Идентификаторы операторов в очереди.

Поле возвращается при OPTIONS.QUEUE = "Y"

QUEUE_USERS_FIELDS
object

Дополнительные поля пользователей очереди. Ключ — идентификатор пользователя, значение — описание полей очереди (подробное описание).

Поле возвращается при OPTIONS.QUEUE = "Y"

CONFIG_QUEUE
array

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

Поле возвращается при OPTIONS.CONFIG_QUEUE = "Y"

DEFAULT_OPERATOR_DATA
array

Набор полей отображения оператора по умолчанию

KPI_FIRST_ANSWER_TIME
string

Норматив времени первого ответа

KPI_FIRST_ANSWER_ALERT
string

Признак уведомления о просрочке первого ответа. Возможные значения:

  • Y — да
  • N — нет

KPI_FIRST_ANSWER_LIST
array

Список получателей уведомлений о первом ответе. Возможные значения:

  • array — список получателей задан
  • null — список получателей не задан

KPI_FIRST_ANSWER_TEXT
string

Текст уведомления о просрочке первого ответа

KPI_FURTHER_ANSWER_TIME
string

Норматив времени последующих ответов

KPI_FURTHER_ANSWER_ALERT
string

Признак уведомления о просрочке последующих ответов. Возможные значения:

  • Y — да
  • N — нет

KPI_FURTHER_ANSWER_LIST
array

Список получателей уведомлений о последующих ответах. Возможные значения:

  • array — список получателей задан
  • null — список получателей не задан

KPI_FURTHER_ANSWER_TEXT
string

Текст уведомления о просрочке последующих ответов

KPI_CHECK_OPERATOR_ACTIVITY
string

Признак контроля активности оператора. Возможные значения:

  • Y — да
  • N — нет

SEND_NOTIFICATION_EMPTY_QUEUE
string

Признак уведомлений о пустой очереди. Возможные значения:

  • Y — да
  • N — нет

USE_WELCOME_FORM
string

Признак использования приветственной формы. Возможные значения:

  • Y — да
  • N — нет

WELCOME_FORM_ID
string

Идентификатор приветственной формы

WELCOME_FORM_DELAY
string

Признак задержки показа приветственной формы. Возможные значения:

  • Y — да
  • N — нет

SEND_WELCOME_EACH_SESSION
string

Показывать приветствие в каждой сессии. Возможные значения:

  • Y — да
  • N — нет

CONFIRM_CLOSE
string

Требовать подтверждение закрытия. Возможные значения:

  • Y — да
  • N — нет

IGNORE_WELCOME_FORM_RESPONSIBLE
string

Игнорировать ответственного в приветственной форме. Возможные значения:

  • Y — да
  • N — нет

Объект QUEUE_USERS_FIELDS

Название
тип

Описание

USER_NAME
string

Имя пользователя. Возможные значения:

  • string — имя пользователя задано
  • null — имя пользователя не задано

USER_WORK_POSITION
string

Должность пользователя. Возможные значения:

  • string — должность задана
  • null — должность не задана

USER_AVATAR
string

Ссылка на аватар. Возможные значения:

  • string — ссылка на аватар задана
  • null — аватар не задан

USER_AVATAR_ID
string

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

Объект CONFIG_QUEUE

Название
тип

Описание

ENTITY_ID
string

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

ENTITY_TYPE
string

Тип объекта в очереди

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

HTTP-статус: 400

{
    "error": "INVALID_FORMAT",
    "error_description": "A wrong format for the PARAMS field 'filter' is passed"
}

Название
тип

Описание

error
string

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

error_description
string

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

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

Статус

Код

Описание

Значение

400

INVALID_FORMAT

Unsupported PARAMS fields are passed: ...

В PARAMS переданы поля, которых нет в списке select, filter, order, limit, offset

400

INVALID_FORMAT

A wrong format for the PARAMS field 'select' is passed

Поле PARAMS.select передано не массивом

400

INVALID_FORMAT

A wrong format for the PARAMS field 'order' is passed

Поле PARAMS.order передано в неверном формате

400

INVALID_FORMAT

A wrong format for the PARAMS field 'filter' is passed

Поле PARAMS.filter передано в неверном формате

400

INVALID_FORMAT

A non-negative integer is expected in the PARAMS field 'limit'

Поле PARAMS.limit должно быть неотрицательным целым числом

400

INVALID_FORMAT

A non-negative integer is expected in the PARAMS field 'offset'

Поле PARAMS.offset должно быть неотрицательным целым числом

400

INVALID_FORMAT

A wrong field name is passed in the PARAMS field 'select'

В PARAMS.select передано пустое или некорректное имя поля

400

INVALID_FORMAT

A wrong field name is passed in the PARAMS field 'order'

В PARAMS.order передано пустое или некорректное имя поля

400

INVALID_FORMAT

A wrong field name is passed in the PARAMS field 'filter'

В PARAMS.filter передано пустое или некорректное имя поля

400

INVALID_FORMAT

An unknown field '...' is passed in the PARAMS field 'select'

В PARAMS.select передано неизвестное поле

400

INVALID_FORMAT

An unknown field '...' is passed in the PARAMS field 'order'

В PARAMS.order передано неизвестное поле

400

INVALID_FORMAT

An unknown field '...' is passed in the PARAMS field 'filter'

В PARAMS.filter передано неизвестное поле

400

INVALID_FORMAT

A wrong field alias is passed in the PARAMS field 'select'

В PARAMS.select передан некорректный псевдоним поля

400

INVALID_FORMAT

The alias '...' matches an existing field in the PARAMS field 'select'

Псевдоним в PARAMS.select конфликтует с существующим полем

400

INVALID_FORMAT

A wrong sorting direction is passed in the PARAMS field 'order'

В PARAMS.order передано направление сортировки, отличное от ASC или DESC

400

INVALID_FORMAT

Unsupported OPTIONS fields are passed: ...

В OPTIONS переданы поля, которых нет в списке QUEUE, CONFIG_QUEUE, CHECK_PERMISSION

400

INVALID_FORMAT

A wrong format for the OPTIONS field 'QUEUE' is passed

Поле OPTIONS.QUEUE передано не скалярным значением

400

INVALID_FORMAT

A wrong format for the OPTIONS field 'CONFIG_QUEUE' is passed

Поле OPTIONS.CONFIG_QUEUE передано не скалярным значением

400

INVALID_FORMAT

An unknown value for the OPTIONS field 'CHECK_PERMISSION' is passed

В OPTIONS.CHECK_PERMISSION передано неизвестное действие

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

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

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

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