Bitrix24 Bot Platform

Modifies the 'message unread' status: all messages prior the specified message (but including the message itself) are marked as read

Revision: 21

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

Parameters

Method call and response

JavaScript

BX24.callMethod('im.dialog.read', {
  'DIALOG_ID': chat29,
  'MESSAGE_ID': 12,
}, function(result){
  if(result.error())
  {
    console.error(result.error().ex);
  }
  else
  {
    console.log(result.data());
  }
});

PHP

$result = restCommand('im.dialog.read', Array(
  'DIALOG_ID' => chat29,
  'MESSAGE_ID' => 12,  
), $_REQUEST["auth"]);

Response example

{
  "result": true
} 

{
    "result": 
    {
        dialogId: "chat76", 
        chatId: 76, 
        counter: 1, 
        lastId: 6930
    }
} 

• dialogId – read chat ID
• chatId – chat ID
• counter – number of unread messages after method execution
• lastId – recent read message

When method is unable to set new read tag:

{
 "result": false
}

Examples of response with error

{
    "error": "MESSAGE_ID_ERROR",
    "error_description": "Message ID can't be empty"
}

Description of keys:

• error – error code
• error_description – brief error description

Possible error codes