Массовое управление уведомлениями для пользователей битрикс24. Получение и изменение настроек уведомлений пользователя через API на PHP

Доброго времени суток. Требуется понимание как на PHP API(пока что не REST) 1)получить список настроек уведомлений пользователя(возможно каждой настройки по отдельности); 2)изменить требуемые настройки уведомлений у пользователя. Требуется это для массового управления настройками пользователей(например чтобы отключить почтовые уведомления на определённые события, которые мало кто читает, при этом вся эта корреспонденция затем хранится на почтовом сервере). Так же если есть другие стандартные механизмы для управления настройками уведомлений пользователей/групп пришлите пожалуйста ссылки на соответствующую документацию, при этом тем не менее ответьте как реализовать через API(поскольку всё равно это может пригодиться).

Сразу же добавлю, поскольку перед вопросом пробовал искать информацию в поисковых системах, если вдруг окажется что готового API для указанных целей нет - пожалуйста предоставьте описание таблиц где находятся соответствующие настройки и могут ли быть проблемы с кэшем если менять параметры через SQL. В случаи проблем с кэшем предложите оптимальный вариант его очистки(тут не лишним было бы понимание как и вручную очистить нужный кэшь и по API). Так же прошу описание ячеек таблиц, чтобы понимать какие именно ячейки отвечают за какой тип уведомлений.

Содержание файла PresetDisabledSettings.php

<?php
//TODO замените на свой namespace
namespace Bitrix\Im\Update;

use Bitrix\Im\Configuration\Configuration;
use Bitrix\Im\Configuration\General;
use Bitrix\Im\Configuration\Notification;
use Bitrix\Main\ArgumentException;

class PresetDisabledSettings
{
	public const SITE = 'SITE';
	public const MAIL = 'MAIL';
	public const PUSH = 'PUSH';

private int $creatorId;

/**
	 * От чьего имени будет создан пресет настроек
	 *
	 * @param int $creatorId
	 */
	public function __construct(int $creatorId = 1)
	{
		$this->creatorId = $creatorId;
	}

/**
	 * @param array $accessCodes Массив кодов, для каких отделов создать пресет настроек
	 *
	 * @param string $disablingNotifyType Поддерживаются значения
	 * SITE - уведомление в браузере/десктоп приложении
	 * MAIL - уведомление отправленное на почту
	 * PUSH - уведомление на мобильный телефон
	 *
	 * @param array $disablingChatSettings Ассоциативный массив с настройками чата
	 * @return int|null
	 *@see General::getDefaultSettings()
	 *
	 */
	public function createPreset(
		string $presetName,
		array $accessCodes = ['DR1'],
		//TODO опасно выставлять именно DR1 так как на огромном количестве пользователей на портале может упасть
		//нужно по-хорошему ставить конкретный access-код отдела, например, D1
		string $disablingNotifyType = self::MAIL,
		array $disablingChatSettings = []
	): ?int
	{
		$presetId = Configuration::createSharedPreset(
			$accessCodes,
			$this->getDisabledSettings($disablingNotifyType, $disablingChatSettings),
			$presetName,
			$this->creatorId,
			sort: 1000,
			force: true,
		);

return $presetId;
	}

private function getDisabledSettings(string $notifyType, array $disablingChatSettings): array
	{
		if (!in_array($notifyType, [self::SITE, self::MAIL, self::PUSH]))
		{
			throw new ArgumentException('Invalid notify type value');
		}
		$chatSettings = $this->getDisabledGeneralSettings($notifyType, $disablingChatSettings);
		$notifySettings = $this->getDisabledNotifyMailSettings($notifyType);

return [
			'general' => $chatSettings,
			'notify' => $notifySettings,
		];
	}

private function getDisabledNotifyMailSettings(string $notifyType): array
	{
		$settings = Notification::getDefaultSettings();
		foreach($settings as $moduleName => &$config)
		{
			foreach($config['NOTIFY'] as $eventName => &$eventConfig)
			{
				if (!$eventConfig['DISABLED'][$notifyType])
				{
					$eventConfig[$notifyType] = false;
				}
			}
		}

return $settings;
	}

private function getDisabledGeneralSettings(string $notifyType, array $disablingChatSettings): array
	{
		$settings = General::getDefaultSettings();
		$settings['notifyScheme'] = 'simple';

$result = array_filter(
			$disablingChatSettings,
			static fn($settingName) => array_key_exists($settingName, $settings),
			ARRAY_FILTER_USE_KEY
		);

$settings = array_replace_recursive($settings, $result);

switch($notifyType)
		{
			case self::SITE:
				$settings['notifySchemeSendSite'] = false;
				break;
			case self::MAIL:
				$settings['notifySchemeSendEmail'] = false;
				break;
			case self::PUSH:
				$settings['notifySchemeSendPush'] = false;
				break;
		}

return $settings;
	}
}

Содержание файла PresetSelector.php

<?php
//TODO замените на свой namespace
namespace Bitrix\Im\Update;
      
use Bitrix\Im\Configuration\Configuration;
use Bitrix\Im\Model\OptionUserTable;
use Bitrix\Main\ORM\Fields\Relations\Reference;
use Bitrix\Main\ORM\Query\Join;
use Bitrix\Main\UserAccessTable;
      
class PresetSelector
{
	public static function choosePresetForUser(int $presetId, int $userId)
	{
		Configuration::chooseExistingPreset($presetId, $userId);
	}
      
	public static function choosePresetForUserList(int $presetId, array $userIdList)
	{
		Configuration::setExistingPresetToUsers($presetId, $userIdList, true);
	}
      
	public static function choosePresetForDepartmentByAccessCodes(int $presetId, array $accessCodes)
	{
		$rowCandidates =
			UserAccessTable::query()
				->addSelect('USER_ID')
				->registerRuntimeField(
					'OPTION_USER_TABLE',
					new Reference(
						'OPTION_USER_TABLE',
						OptionUserTable::class,
						Join::on('this.USER_ID', 'ref.USER_ID'),
						['join_type' => Join::TYPE_INNER]
					)
				)
				->whereIn('ACCESS_CODE', $accessCodes)
		;
		$candidates = [];
		foreach ($rowCandidates->exec() as $rowCandidate)
		{
			$candidates[] = (int)$rowCandidate['USER_ID'];
		}
      
		Configuration::setExistingPresetToUsers($presetId, $candidates, true);
	}
      
}

Содержание файла ExamplePresetWorking.php

<?php
//создать новый пресет с отключенными настройками.
$preset = new \Bitrix\Im\Update\PresetDisabledSettings(1);
$preset->createPreset(
	'without mail notifications',
	['D1'], // вносим список Access-кодов, каким отделам выставим данный пресет настроек
	\Bitrix\Im\Update\PresetDisabledSettings::MAIL, // указываем, какой тип уведомлений хотим отключить
	['sendByEnter' => false] // указываем какие настройки чата хотим изменить
/** @see \Bitrix\Im\Configuration\General::getDefaultSettings() */
);
// ѕолученный id пресета настроек будет помещен в таблицу b_im_option_group
      
//сменить пресет настроек для выбранного пользователя
\Bitrix\Im\Update\PresetSelector::choosePresetForUser(1667, 123);
      
//сменить пресет настроек дл¤ выбранного списка пользователей
\Bitrix\Im\Update\PresetSelector::choosePresetForUserList(1667, [1,2,3]);
      
//сменить пресет настроек дл¤ выбранного целого отдела по его Access-коду
\Bitrix\Im\Update\PresetSelector::choosePresetForDepartmentByAccessCodes(1667, ['D1']);

Комментарии