Это общая статья про api d7 crm
crm коробка старое api: сделки и лиды, компании и контакты, товары, счета и реквизиты, предложения, вид карточки crm, права и роли пользователя, активити (дела),
crm rest api: создать лид через вебхук (php + js), bitrix24 rest api класс - пример, решает определенные задачи по сделкам, лидам, контактам
api другие модули: диск, задачи, аналитика, бизнес-процессы, чат, календарь, техподдержка, интранет, телефония |
подключить модуль d7
\Bitrix\Main\Loader::includeModule("crm"); |
типы (системные константы)
CCrmOwnerType::Lead; //1
CCrmOwnerType::Deal; //2
CCrmOwnerType::Contact;
CCrmOwnerType::Company;
CCrmOwnerType::Invoice;
CCrmOwnerType::Quote;
CCrmOwnerType::Requisite; |
получить фабрику
$factory = \Bitrix\Crm\Service\Container::getInstance()->getFactory(\CCrmOwnerType::Deal); // \CCrmOwnerType::Lead, \CCrmOwnerType::Contact и тд
$factory = \Bitrix\Crm\Service\Container::getInstance()->getFactory($smartTypeId); // для смарт-процессов |
получить элемент
$item = $factory->getItem($id); |
получить элементы по отбору
$items = $factory->getItems([
"filter"=>[
"STAGE_ID" => "C11:NEW",
"UF_CRM_1719738837"=>$mainId
],
"select"=>["ID"],
'order' => ['UF_CRM_2_POLE' => 'ASC'],
'limit'=>1000,
'offset' =>0
]);
foreach($items as $item){
//
}
|
получить значения полей
$item->getTitle();
$item->getUfCrm_1719825378086();
$item->getUfCrm_3_1719825378086(); //для смарт-процессов номера "двойные" (смотрите коды свойств)
$item->getStageId(); //стадия для сделок, смарт-процессов
$item->getStatusId(); //статус для лидов
|
Важно!
после надо сохранить, как это сделать, написано ниже |
создать элемент
$item = $factory->createItem();
$item2 = $factory->createItem($data); //с массивом полей сразу |
установить/изменить значения полей
вариант 1
$item->set("#FIELD#",$value); |
вариант 2
$item->setStageId("NEW");
$item->setTitle("New Title"); |
привязки элемента к компаниям, контактам
$existingBindings = $item->getContactBindings(); //получить
$item->bindContacts(\Bitrix\Crm\Binding\EntityBinding::prepareEntityBindings(\CCrmOwnerType::Contact, [$contactId])); //добавить
$item->unBindContacts(\Bitrix\Crm\Binding\EntityBinding::prepareEntityBindings(\CCrmOwnerType::Contact, [$contactId])); //удалить
|
поле типа файл множественное
скопировать из одного поля в другое
$arFiles = $item->getUfCrm_5_1709576143217();
$arFilesCopy = [];
if(!empty($arFiles) && is_array($arFiles)){
foreach($arFiles as $fileId){
$arFilesCopy[] = CFile::MakeFileArray($fileId);
}
$item->setUfCrm_5_1710072122827($arFilesCopy);
} |
поле типа файл
$fields = [
'UF_CRM_8_1724504387273' => CFile::MakeFileArray($absoluteFilePath),
];
$item->setFromCompatibleData($fields); |
Сохранить, добавить, изменить, удалитьвариант 1выполнит, но не будет проверок и обработчики не запустятся, индексы не обновятся/не удалятся и тд
$item->save(); //изменение, добавление
$item->delete(); //удаление
|
с выполнением всех проверок, обновлением индексов и прочих подкапотных штук
$context = new \Bitrix\Crm\Service\Context();
$context->setUserId($userId); //ставим юзера, из-под которого делаем
$operation = $factory->getAddOperation($item, $context); //добавление, $context- необязателен
$operation = $factory->getUpdateOperation($item, $context); //изменение, $context- необязателен
$operation = $factory->getDeleteOperation($item, $context); //удаление, $context- необязателен
$operation->disableAllChecks(); //можно отключить проверки
$result = $operation->launch(); |
изменение через массив
$class = $factory->getDataClass();
$saveResult = $class::update($id, $arUpdate); |
получить из таймлайна
\Bitrix\Main\Loader::includeModule('crm');
$entityId = 14; // ID элемента
$entityType = 8; // ID Типа сущности
$obTimeLineEntity = Bitrix\Crm\Timeline\Entity\TimelineTable::getList(array(
'order' => array("CREATED" => "DESC"),
'filter' => array(
'ASSOCIATED_ENTITY_ID' => $entityId,
'ASSOCIATED_ENTITY_TYPE_ID' => $entityType,
),
'limit' => 100,
'select' => array("*"),
));
while($arFields = $obTimeLineEntity->fetch()) {
print_r($arFields);
} |