метод REST scope: imopenlines

imopenlines.config.list.get

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

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

Описание

Метод 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

Ответ

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

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

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

HTTP-статус: 400

{
    "error": "INVALID_FORMAT",
    "error_description": "A wrong format for the PARAMS field 'filter' is passed"
}
Код Описание Значение
400 INVALID_FORMAT Unsupported PARAMS fields are passed: ...
400 INVALID_FORMAT A wrong format for the PARAMS field 'select' is passed
400 INVALID_FORMAT A wrong format for the PARAMS field 'order' is passed
400 INVALID_FORMAT A wrong format for the PARAMS field 'filter' is passed
400 INVALID_FORMAT A non-negative integer is expected in the PARAMS field 'limit'
400 INVALID_FORMAT A non-negative integer is expected in the PARAMS field 'offset'
400 INVALID_FORMAT A wrong field name is passed in the PARAMS field 'select'
400 INVALID_FORMAT A wrong field name is passed in the PARAMS field 'order'
400 INVALID_FORMAT A wrong field name is passed in the PARAMS field 'filter'
400 INVALID_FORMAT An unknown field '...' is passed in the PARAMS field 'select'
400 INVALID_FORMAT An unknown field '...' is passed in the PARAMS field 'order'
400 INVALID_FORMAT An unknown field '...' is passed in the PARAMS field 'filter'
400 INVALID_FORMAT A wrong field alias is passed in the PARAMS field 'select'
400 INVALID_FORMAT The alias '...' matches an existing field in the PARAMS field 'select'
400 INVALID_FORMAT A wrong sorting direction is passed in the PARAMS field 'order'
400 INVALID_FORMAT Unsupported OPTIONS fields are passed: ...
400 INVALID_FORMAT A wrong format for the OPTIONS field 'QUEUE' is passed
400 INVALID_FORMAT A wrong format for the OPTIONS field 'CONFIG_QUEUE' is passed
400 INVALID_FORMAT An unknown value for the OPTIONS field 'CHECK_PERMISSION' is passed

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.