Для AI-агентов: markdown этой страницы — /docs-content/entities/crm-tracking/channels-list.md индекс документации — /llms.txt

Метод в процессе раскатки — выходит в обновлении crm 26.2100.0. Доступен не на всех порталах Битрикс24. Если метод ещё не включён, API вернёт 422 METHOD_NOT_YET_AVAILABLE.

Список каналов сквозной аналитики

GET /v1/crm-tracking/channels

Перечисляет каналы сквозной аналитики для настройки сбора сведений о взаимодействиях с клиентами.

Требуется скоуп crm, включённый флаг crm-tracking-v3 и доступность возможности на портале Битрикс24. Для чтения подходит ключ READONLY.

Параметры

Параметр Тип По умолч. Описание
Параметрlimit (query) Типnumber По умолч.50 ОписаниеРазмер страницы, целое число от 1 до 500.
Параметрoffset (query) Типnumber По умолч.0 ОписаниеЧисло пропускаемых записей, неотрицательное целое число.

Пагинация: один запрос возвращает одну страницу. Для следующей страницы увеличьте offset на limit. Сортировка и дополнительные фильтры не поддерживаются.

Примеры

curl — личный ключ

Terminal 
curl "https://vibecode.bitrix24.tech/v1/crm-tracking/channels?limit=50&offset=0" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth-приложение

Terminal 
curl "https://vibecode.bitrix24.tech/v1/crm-tracking/channels?limit=50&offset=0" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/crm-tracking/channels?limit=50&offset=0', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const result = await res.json()
console.log(result)

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/crm-tracking/channels?limit=50&offset=0', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const result = await res.json()
console.log(result)

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean Описаниеtrue
Полеdata Типarray ОписаниеКаналы.
Полеdata[].code Типstring ОписаниеКод канала.
Полеdata[].name Типstring ОписаниеНазвание канала на языке портала.
Полеdata[].isConfigurable Типboolean ОписаниеКанал допускает настройку.
Полеdata[].isConfigured Типboolean ОписаниеКанал настроен.
Полеmeta.limit Типnumber ОписаниеРазмер запрошенной страницы.
Полеmeta.offset Типnumber ОписаниеЧисло пропущенных записей.

Пример ответа

JSON 
{
  "success": true,
  "data": [
    {
      "code": "site24",
      "name": "Сайт Битрикс24",
      "isConfigurable": false,
      "isConfigured": true
    },
    {
      "code": "shop24",
      "name": "Магазин Битрикс24",
      "isConfigurable": false,
      "isConfigured": true
    }
  ],
  "meta": {
    "limit": 50,
    "offset": 0
  }
}

Пример ответа при ошибке

400 — неподдерживаемый параметр запроса:

JSON 
{
  "success": false,
  "error": {
    "code": "UNKNOWN_FILTER_FIELD",
    "message": "Unknown query parameter"
  }
}

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PARAMS ОписаниеНекорректная пагинация.
HTTP400 КодUNKNOWN_FILTER_FIELD ОписаниеПередан неизвестный параметр, фильтр или сортировка.
HTTP403 КодSCOPE_DENIED ОписаниеУ ключа нет скоупа crm.
HTTP401 КодTOKEN_MISSING ОписаниеУ ключа нет настроенных токенов.
HTTP422 КодMETHOD_NOT_YET_AVAILABLE ОписаниеФлаг выключен или метод ещё не включён на портале. error.release — crm 26.2100.0.
HTTP502 КодBITRIX_UNAVAILABLE ОписаниеНекорректный ответ Битрикс24.

Коды, HTTP-статусы и тексты остальных отказов Битрикс24 сохраняются. Полный список общих ошибок API — Ошибки.

Смотрите также