Документация для разработчиков
Темная тема

pull.application.event.add

Описание

Метод для отправки событий в RT-канал приложения.

Параметры

Параметр Пример Обязательный Описание
COMMAND 'test' Да Тип события, строка.
PARAMS {JSON Object} Нет Произвольный JSON массив с данными.
MODULE_ID 'application' Нет Если отправляются команды из разных подсистем приложения, можно это указать через модуль.
USER_ID 1 или [1,2,3] Нет Если не указывать USER_ID, то данные будут отправлены в общий канал. Если указать ID пользователя, то данные будут отправлены в приватный канал.
Администратор может отправлять одновременно нескольким пользователям и в общий канал, пользователь без прав - только себе или в общий канал.

Примеры

JavaScript

BX24.callMethod('pull.application.event.add', {
	'COMMAND': 'test',
	'PARAMS': '{"param1":"value1"}',
}, function(result){
	if(result.error())
	{
		console.error(result.error().ex);
	}
	else
	{
		console.log(result.data());
	}
});

PHP

$result = restCommand('pull.application.event.add', [
	'COMMAND': 'test',
	'PARAMS': ['param1' => 'value1'],
], $_REQUEST["auth"]);

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

{
    "result": true
}

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

{
    "error": "WRONG_AUTH_TYPE",
    "error_description": "Get access to application config available only for application authorization."
}

Ключи:

  • error - код возникшей ошибки
  • error_description - краткое описание возникшей ошибки

Возможные коды ошибок

Код Описание
COMMAND_ERROR Формат поля MODULE_ID не верный. Разрешены английские буквы в смешанном регистре, цифры, символ подчеркивания, точка и тире.
MODULE_ID_ERROR Формат поля MODULE_ID не верный. Разрешены английские буквы в нижнем регистре, цифры, точка и знак подчеркивания.
USER_ID_ACCESS_ERROR Указывать произвольных пользователей может только пользователь с правами администратора.
PARAMS_ERROR Передан не корректный JSON обьект.
WRONG_AUTH_TYPE Метод можно использовать только в рамках OAuth 2.0 или через веб-хуки.


© «Битрикс», 2001-2020, «1С-Битрикс», 2020
Наверх