Open Chat Messenger.openChat

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

The method Messenger.openChat opens a chat in the Bitrix24 Messenger interface. It is recommended to use this method instead of BX24.im.openMessenger and BX24.im.openHistory.

Promise Messenger.openChat([String dialogId[, Integer messageId]])

Parameters

Name
type

Description

dialogId
string

Identifier of the dialog or chat. If this parameter is not provided, the chat list will open.

messageId
integer

Identifier of the message to open the chat focused on a specific message.

Code Example

How to Use Examples in Documentation

BX.Messenger.Public.openChat('chat123');
        
BX.Messenger.Public.openChat('chat123', 12345);

Response Handling

The method returns a Promise.

Returned Data

Name
type

Description

result
Promise

Promise of the chat opening operation.

Continue Learning

Previous
Start Call to Phone Number
Next
Overview