Views: 4785
Last Modified: 23.03.2022

The method deletes a history element of the last search

Revision: 18
Get information on the current API revision (platform version) – im.revision.get.

Parameters

Parameter Example Req. Description Revision
DIALOG_ID chat17 Yes Dialog ID 18
  • DIALOG_ID – dialog ID (number – if user, chatXXX – if chat).

Method call

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"]);

Example of response

{
	"result": true
}        

Example of response when error occurs

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

Description of keys:

  • error – error code
  • error_description – brief description of error

Possible error codes

Code Description
DIALOG_ID_EMPTY Dialog ID not passed.

Attention: restCommand function is used here for illustration purposes only. It is taken from the EchoBot example. You can send a REST command with your own function, or use the BX24.callMethod or bitrix24-php-sdk methods.





Courses developed by Bitrix24