Для AI-агентов: markdown этой страницы — /docs-content/entities/crm-v3-dictionaries.md индекс документации — /llms.txt
Справочники CRM и настройки стадий
Читайте типы средств связи, поставщиков дел и исходы стадий, заменяйте стадии собственной воронки и переключайте режим работы CRM.
Битрикс24 API: crm.dictionary.*, crm.<E>.category.stage.replace, crm.lead.enable, crm.lead.disable
Скоуп: crm
Методы в процессе раскатки. Нужна возможность CRM REST v3, появившаяся после
crm 26.2200.0, и её включение администратором. Номер следующего выпуска ещё не опубликован. Недоступный метод возвращает422 METHOD_NOT_YET_AVAILABLEсerror.release.
Операции
- Список записей справочника —
GET /v1/crm-dictionaries/:dictionary - Получить запись справочника CRM —
GET /v1/crm-dictionaries/:dictionary/:id - Заменить стадии воронки —
PUT /v1/deal-categories/:categoryId/stages - Включить лиды —
POST /v1/leads/enable - Выключить лиды —
POST /v1/leads/disable
Справочник :dictionary выбирается из таблицы. Замена стадий смарт-процесса использует /v1/categories/:entityTypeId/:categoryId/stages. Значения списочных пользовательских полей находятся в отдельном разделе.
Ключевые поля
| Поле | Описание |
|---|---|
Полеid |
ОписаниеСтроковый ID из списка справочника |
Полеname |
ОписаниеНазвание записи, у типов средств связи может быть null |
ПолеnameShort |
ОписаниеКраткое название типа средства связи, может быть null |
ПолеcategoryId |
ОписаниеID из воронок сделок или воронок смарт-процесса |
ПолеstageId |
ОписаниеID стадии, возвращённый заменой стадий или справочником стадий |
Полеenabled |
ОписаниеВключены ли лиды для всего портала |
Что нужно знать перед работой
:dictionary |
Содержимое |
|---|---|
:dictionaryactivity-providers |
СодержимоеПоставщики дел CRM, их типы и возможности |
:dictionaryemail-types |
СодержимоеТипы адресов электронной почты |
:dictionaryphone-types |
СодержимоеТипы телефонов |
:dictionaryim-types |
СодержимоеТипы средств обмена сообщениями |
:dictionaryweb-types |
СодержимоеТипы сайтов |
:dictionarystage-semantics |
СодержимоеИсходы стадий CRM |
- Справочники разрешено читать ключам
READONLY. Изменения требуютREADWRITEи прав сотрудника в Битрикс24. - Включение и выключение лидов переключает весь портал между классическим и простым режимом CRM. Нужны права администратора CRM. Текущий режим доступен через настройки CRM.
- Замена стадий меняет набор стадий одной воронки. Системные и финальные стадии сохраняются. Изменять их или удалять стадию с элементами нельзя. Элементы на другие стадии не переносятся.
- После неопределённого сбоя записи сначала прочитайте текущее состояние. Не повторяйте изменение вслепую.
Типичный сценарий
- Прочитайте справочник.
- Для настройки воронки получите её ID из списка воронок.
- Замените стадии, сохраняя ID стадий, которые должны остаться.
Лимиты
| Лимит | Значение |
|---|---|
| ЛимитЧтение справочника | ЗначениеОдна страница, limit по умолчанию 50, offset по умолчанию 0 |
| ЛимитПодсчёт записей | ЗначениеОбщее количество не возвращается |
| ЛимитИзменения CRM | ЗначениеПрава и ограничения проверяет Битрикс24 |