Получить список воронок crm.category.list
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
crmКто может выполнять метод: любой пользователь
DEPRECATED
Развитие метода остановлено. Используйте метод REST 3.0 crm.<тип>.category.list. Воронки счетов, документов CRM и документов КЭДО в REST 3.0 пока недоступны, для них используйте этот метод.
Метод crm.category.list получает список воронок, которые относятся к типу объекта CRM с идентификатором entityTypeId.
Какие воронки попадут в список
Метод возвращает только те воронки, к которым у пользователя есть право на чтение.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
entityTypeId* |
Идентификатор системного или пользовательского типа объекта CRM, для которого нужно получить список воронок. Тип объекта должен поддерживать воронки: список поддерживаемых объектов |
|
filter |
Необязательный фильтр воронок (подробное описание). По умолчанию пустой |
|
isCategoryMenu |
Если |
Параметр filter
|
Название |
Описание |
|
code |
Точное значение кода воронки. Например, |
Метод возвращает весь список воронок, доступных пользователю и соответствующих фильтру, без постраничной навигации.
Примеры кода
Получить список воронок для сделок.
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityTypeId":2}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.category.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityTypeId":2,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.category.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 CategoryListResult = {
categories: Array<{
id: number
name: string
sort: number
entityTypeId: number
isDefault: 'Y' | 'N'
originId?: string
originatorId?: string
}>
}
try {
// Метод возвращает список доступных пользователю воронок
const response = await $b24.actions.v2.call.make<CategoryListResult>({
method: 'crm.category.list',
params: {
entityTypeId: 2,
},
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('Categories:', result.categories, 'Count:', result.categories.length)
}
} 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 loadCategoryList() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// Метод возвращает список доступных пользователю воронок
const response = await $b24.actions.v2.call.make({
method: 'crm.category.list',
params: {
entityTypeId: 2,
},
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('Categories:', result.categories, 'Count:', result.categories.length)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', loadCategoryList)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.category.list(
entity_type_id=2,
).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(
'crm.category.list',
[
'entityTypeId' => 2,
]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
BX24.callMethod(
"crm.category.list",
{
entityTypeId: 2,
},
(result) =>
{
if (result.error())
{
console.error(result.error());
}
else
{
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'crm.category.list',
[
'entityTypeId' => 2
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.category.list", b24.Params{
"entityTypeId": 2,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.category.list: %w", err)
}
// Метод заворачивает ответ в объект с ключом "categories".
raw, ok := b24.Unwrap(res.Result, "categories")
if !ok {
return fmt.Errorf("в ответе нет ключа categories")
}
var items []struct {
ID b24.ID `json:"id"`
Name string `json:"name"`
Sort int `json:"sort"`
EntityTypeID b24.ID `json:"entityTypeId"`
IsDefault string `json:"isDefault"`
OriginID string `json:"originId"`
}
if err := json.Unmarshal(raw, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.ID)
}
Обработка ответа
HTTP-статус: 200
{
"result": {
"categories": [
{
"id": 9,
"name": "Воронка с оригинальным названием",
"sort": 200,
"entityTypeId": 2,
"isDefault": "N",
"originId": "",
"originatorId": ""
},
{
"id": 10,
"name": "Лидовый маршрут",
"sort": 200,
"entityTypeId": 2,
"isDefault": "N",
"originId": "",
"originatorId": ""
},
{
"id": 11,
"name": "Путь успеха",
"sort": 200,
"entityTypeId": 2,
"isDefault": "N",
"originId": "",
"originatorId": ""
},
{
"id": 0,
"name": "Общая",
"sort": 300,
"entityTypeId": 2,
"isDefault": "Y"
}
]
},
"total": 4,
"time": {
"start": 1718293410.373042,
"finish": 1718293425.947633,
"duration": 15.574590921401978,
"processing": 15.16909408569336,
"date_start": "2024-06-13T17:43:30+02:00",
"date_finish": "2024-06-13T17:43:45+02:00",
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа (подробное описание) |
|
total |
Количество воронок, доступных пользователю и соответствующих фильтру |
|
time |
Информация о времени выполнения запроса |
Объект result
|
Название |
Описание |
|
categories |
Массив воронок. При |
При isCategoryMenu=false поля isSystem и code возвращаются только для контактов и компаний — entityTypeId=3 и entityTypeId=4. Для сделок и смарт-процессов эти поля в ответ не входят. Поле isSystem — boolean со значениями Y или N, поле code — строковый код воронки.
При isCategoryMenu=true каждая воронка содержит только id, name, sort, entityTypeId, isDefault и counter. Поле counter типа integer — значение счетчика текущего пользователя в этой воронке.
Обработка ошибок
HTTP-статус: 400
{
"error": "NOT_FOUND",
"error_description": "Смарт-процесс не найден"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
|
Could not find value for parameter |
Не передан обязательный параметр |
|
|
|
Смарт-процесс не найден |
Тип объекта CRM с указанным |
|
|
|
Сущность CRM {entityTypeName} не поддерживается |
Объект CRM не поддерживает воронки. Вместо |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Воронки CRM: обзор методов
- Добавить новую воронку crm.category.add
- Обновить воронку crm.category.update
- Получить воронку по Id crm.category.get
- Удалить воронку crm.category.delete
- Получить поля воронки crm.category.fields
- Как отфильтровать элементы по названию стадии
- Как создать поставщика в CRM
- Как получить список поставщиков