110  /  166

im.search.last.delete

Просмотров: 12418
Дата последнего изменения: 17.11.2021
Александр Суворов
Сложность урока:
3 уровень - средняя сложность. Необходимо внимание и немного подумать.
1
2
3
4
5

Удаление элемента истории последнего поиска

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

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

Параметры

Параметр Пример Обязат. Описание Ревизия
DIALOG_ID chat17
или
256
Да Идентификатор диалога. Формат:
chatXXX – чат получателя, если сообщение для чата
или XXX – идентификатор получателя, если сообщение для приватного диалога
18


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

JavaScript

BX24.callMethod('im.search.last.delete', {
	'DIALOG_ID': 'chat17'
}, function(result){
	if(result.error())
	{
		console.error(result.error().ex);
	}
	else
	{
		console.log(result.data());
	}
});

PHP

$result = restCommand('im.search.last.delete', Array(
	'DIALOG_ID' => 'chat17'
), $_REQUEST["auth"]);

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

{
	"result": true
}        


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

{
    "error": "DIALOG_ID_EMPTY",
    "error_description": "Dialog ID can't be empty"
}

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

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

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

Код Описание
DIALOG_ID_EMPTY Не передан идентификатор диалога.


1
Курсы разработаны в компании «1С-Битрикс»
Доступна новая документация по REST: понятнее описания, больше примеров, удобнее поиск
Перейти