Получить статус коннектора imconnector.status

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

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

Scope: imopenlines

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

Метод imconnector.status возвращает текущий статус коннектора для указанной открытой линии.

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

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

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

Название
тип

Описание

CONNECTOR*
string

Строковый код коннектора, который задали в параметре ID при вызове imconnector.register

LINE
integer

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

Идентификатор можно получить методами imopenlines.config.get и imopenlines.config.list.get

Метод не проверяет, зарегистрирован ли коннектор и существует ли линия. Для неизвестной пары «коннектор — линия» он возвращает не ошибку, а статус со значениями ERROR: false, CONFIGURED: false и STATUS: false.

Частный случай такой пары — вызов без LINE: метод подставляет значение 0, статуса для такой пары обычно нет, и все три признака приходят со значением false, даже если коннектор работает на других линиях. Чтобы получить корректный статус, всегда указывайте идентификатор открытой линии.

Примеры кода

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

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"CONNECTOR":"myconnector","LINE":"12","auth":"**put_access_token_here**"}' \
  https://**put_your_bitrix24_address**/rest/imconnector.status
// 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 ConnectorStatusResult = {
  LINE: number
  CONNECTOR: string
  ERROR: boolean
  CONFIGURED: boolean
  STATUS: boolean
}

try {
  const response = await $b24.actions.v2.call.make<ConnectorStatusResult>({
    method: 'imconnector.status',
    params: {
      CONNECTOR: 'myconnector',
      LINE: '12',
    },
    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('Connector status:', result.STATUS, '| Configured:', result.CONFIGURED, '| Error:', result.ERROR)
  }
} 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 getConnectorStatus() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'imconnector.status',
        params: {
          CONNECTOR: 'myconnector',
          LINE: '12',
        },
        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('Connector status:', result.STATUS, '| Configured:', result.CONFIGURED, '| Error:', result.ERROR)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

try:
    bitrix_response = client.imconnector.status(
        connector="myconnector",
        line="12",
    ).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.status',
    [
        'CONNECTOR' => 'myconnector',
        'LINE' => '12',
    ]
);
BX24.callMethod(
  'imconnector.status',
  {
    CONNECTOR: 'myconnector',
    LINE: '12',
  },
  function(result) {
    console.log(result.data());
  }
);
$result = CRest::call(
    'imconnector.status',
    [
        'CONNECTOR' => 'myconnector',
        'LINE' => '12',
    ]
);
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "imconnector.status", b24.Params{
	"CONNECTOR": "myconnector",
	"LINE":      "12",
})
if err != nil {
	return fmt.Errorf("imconnector.status: %w", err)
}

var item struct {
	Line       int    `json:"LINE"`
	Connector  string `json:"CONNECTOR"`
	Error      bool   `json:"ERROR"`
	Configured bool   `json:"CONFIGURED"`
	Status     bool   `json:"STATUS"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.Line, item.Connector)

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

HTTP-статус: 200

{
    "result": {
        "LINE": 12,
        "CONNECTOR": "myconnector",
        "ERROR": false,
        "CONFIGURED": true,
        "STATUS": true
    },
    "time": {
        "start": 1773267900.126,
        "finish": 1773267900.489,
        "duration": 0.3630001544952393,
        "processing": 0.0884850025177002,
        "date_start": "2026-03-11T14:25:00+03:00",
        "date_finish": "2026-03-11T14:25:00+03:00",
        "operating_reset_at": 1773268500,
        "operating": 0.0884850025177002
    }
}

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

Название
тип

Описание

result
object

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

time
time

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

Объект result

Название
тип

Описание

LINE
integer

Идентификатор открытой линии, для которой запрошен статус. Если параметр LINE не передавали, возвращается 0

CONNECTOR
string

Код коннектора в нижнем регистре

ERROR
boolean

Признак ошибки коннектора на этой линии. Значение true означает, что коннектор помечен как нерабочий. Признак снимается при повторном вызове imconnector.activate

CONFIGURED
boolean

Признак завершенной настройки коннектора. Значение true, если коннектор одновременно зарегистрирован, подключен и активен на этой линии. Все три признака выставляет метод imconnector.activate

STATUS
boolean

Итоговый статус доступности коннектора. Значение true, если CONFIGURED равно true, а ERROR — false.

Только при STATUS: true линия принимает сообщения коннектора и показывает его настройки в интерфейсе оператора

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

HTTP-статус: 400, 403

{
    "error": "ERROR_ARGUMENT",
    "error_description": "Argument 'CONNECTOR' is null or empty",
    "argument": "CONNECTOR"
}

Название
тип

Описание

error
string

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

error_description
string

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

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

Статус

Код

Описание

Значение

403

WRONG_AUTH_TYPE

Current authorization type is denied for this method Application context required

Метод вызван не в контексте приложения OAuth

400

ERROR_ARGUMENT

Argument 'CONNECTOR' is null or empty

Не передан код коннектора CONNECTOR

В теле ошибки ERROR_ARGUMENT приходит дополнительное поле argument с именем параметра — разбирать текст сообщения не нужно.

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

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

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

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