Получить список коннекторов imconnector.list

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

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

Scope: imopenlines

Кто может выполнять метод: пользователь с правом изменения коннекторов открытых линий

Метод imconnector.list возвращает список коннекторов, которые доступны в Битрикс24 и могут быть подключены к открытой линии.

Метод работает только в контексте приложения.

В список попадают:

  • встроенные коннекторы, которые доступны в регионе и включены в настройках Битрикс24: онлайн-чат, Telegram, Битрикс24 Network и другие
  • пользовательские коннекторы, зарегистрированные приложениями через imconnector.register

На пользовательские коннекторы настройки Битрикс24 не влияют: они попадают в список сразу после регистрации.

Метод не показывает, к каким линиям подключены коннекторы и в каком они состоянии. Состояние коннектора на конкретной линии проверяйте методом imconnector.status.

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

Без параметров.

Примеры кода

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

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"auth":"**put_access_token_here**"}' \
  https://**put_your_bitrix24_address**/rest/imconnector.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 } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of the payload returned in result (match the "response handling" section of the page)
type ConnectorListResult = Record<string, string>

try {
  const response = await $b24.actions.v2.call.make<ConnectorListResult>({
    method: 'imconnector.list',
    params: {},
    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('Connectors:', result)
  }
} 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 listConnectors() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'imconnector.list',
        params: {},
        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('Connectors:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.imconnector.list().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}")

$result = $b24Service->core->call(
    'imconnector.list',
    []
);

BX24.callMethod(
  'imconnector.list',
  {},
  function(result) {
    console.log(result.data());
  }
);

$result = CRest::call(
    'imconnector.list',
    []
);

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

var item struct {
	Livechat    string `json:"livechat"`
	Telegrambot string `json:"telegrambot"`
	Network     string `json:"network"`
	Myconnector string `json:"myconnector"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.Livechat, item.Telegrambot)

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

HTTP-статус: 200

{
    "result": {
        "livechat": "Онлайн-чат",
        "telegrambot": "Telegram",
        "network": "Битрикс24 Network",
        "myconnector": "Мой коннектор"
    },
    "time": {
        "start": 1738065600.11,
        "finish": 1738065600.17,
        "duration": 0.06,
        "processing": 0.03,
        "date_start": "2025-01-28T12:00:00+00:00",
        "date_finish": "2025-01-28T12:00:00+00:00"
    }
}

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

Название
тип

Описание

result
object

Объект вида connector_id: connector_name, где:

  • ключ — код коннектора. Для пользовательского коннектора это значение параметра ID метода imconnector.register, приведенное к нижнему регистру
  • значение — название коннектора на языке интерфейса Битрикс24: для пользовательского коннектора это параметр NAME метода imconnector.register

Ключ подставляют в параметр CONNECTOR остальных методов раздела.

Если доступных коннекторов нет, в result приходит пустой массив []

time
time

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

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

HTTP-статус: 400

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

{
    "error": "ERROR_CORE",
    "error_description": "Current authorization type is denied for this method"
}

Нет права изменения коннекторов:

{
    "error": "ACCESS_DENIED",
    "error_description": "You dont have access to this action"
}

Название
тип

Описание

error
string

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

error_description
string

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

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

Статус

Код

Описание

Значение

400

ERROR_CORE

Current authorization type is denied for this method

Метод вызван не в контексте приложения OAuth. В отличие от остальных методов раздела, этот метод отвечает кодом ERROR_CORE и статусом 400

400

ACCESS_DENIED

The ImOpenLines module is not installed.

В Битрикс24 не установлен модуль imopenlines. Эта проверка выполняется раньше проверки контекста приложения

400

ACCESS_DENIED

You dont have access to this action

У пользователя нет права изменения коннекторов

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

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

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

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

Предыдущая
Установить настройки коннектора
Следующая
Отменить регистрацию коннектора