im.chat.mute

Просмотров: 14533
Дата последнего изменения: 17.11.2021

Александр Суворов

Сложность урока:

3 уровень - средняя сложность. Необходимо внимание и немного подумать.

Отключение уведомлений в чате

Ревизия Получить информацию о текущей ревизии API (версии платформы) – im.revision.get : 18

Обратите внимание! Метод указан с использованием функции restCommand - это метод отправки данных в Битрикс24, данный метод есть в примере ЭхоБота, и представлен здесь в качестве примера. Вы можете использовать свою функцию или javascript-метод BX24.callMethod или bitrix24-php-sdk.

Параметры

Параметр	Пример	Обязат.	Описание	Ревизия
CHAT_ID	17	Да	Идентификатор чата	19
MUTE	Y	Да	Отключить или включить уведомления - Y\|N	19

Варианты ключа MUTE: Y или N.

Вызов метода и ответ

JavaScript

BX24.callMethod('im.chat.mute', {
	'CHAT_ID': 17,
	'MUTE': 'Y'
}, function(result){
	if(result.error())
	{
		console.error(result.error().ex);
	}
	else
	{
		console.log(result.data());
	}
});

PHP

$result = restCommand('im.chat.mute', Array(
	'CHAT_ID' => 17,
	'MUTE' => 'Y'
), $_REQUEST["auth"]);

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

{
	"result": true
}

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

{
    "error": "CHAT_ID_EMPTY",
    "error_description": "Chat ID can't be empty"
}

Описание ключей:

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

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

Код	Описание
CHAT_ID_EMPTY	Не передан идентификатор чата

Курсы разработаны в компании «1С-Битрикс»