Views: 1603 (Data available since 06.02.2017)

The method cancels notification for read messages.

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

Parameters

Parameter Example Req. Description Revision
ID 17 Yes Notification ID 18
ONLY_CURRENT N No Read only the specified notification 18
  • If the ONLY_CURRENT parameter is passed with Y, check indicating that notification was read will be set only for the specified ID. Otherwise, the check is set for notification with equal or higher ID.

Method call

JavaScript

BX24.callMethod('im.notify.read', {
	'ID': 17,
}, function(result){
	if(result.error())
	{
		console.error(result.error().ex);
	}
	else
	{
		console.log(result.data());
	}
});

PHP

$result = restCommand('im.notify.read', Array(
	'DIALOG_ID' => '17'
), $_REQUEST["auth"]);	

Example of response

{
	"result": true
}        

Attention! The method is specified with using of the restCommand function. This method is used to send data in Bitrix24 and is available in the EchoBot example as well as in this article. You can use your own function or BX24.callMethod, or bitrix24-php-sdk JavaScript methods.





Courses developed by «Bitrix», Inc.