Start Video Call Messenger.startVideoCall

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.startVideoCall initiates a video call in Bitrix24. It is recommended to use this method instead of BX24.im.callTo.

Promise Messenger.startVideoCall([String dialogId[, Boolean withVideo]])

Parameters

Name
type

Description

dialogId
string

Identifier of the dialog or chat. By default, an empty string '' is used. An empty or invalid value will not pass validation, and the call will terminate without starting the call

withVideo
boolean

Type of call: true - video call, false - audio call

Code Example

How to Use Examples in Documentation

BX.Messenger.Public.startVideoCall('chat123', true);

Response Handling

The method returns a Promise.

Returned Data

Name
type

Description

result
Promise

Promise of the operation to initiate the video call

Continue Learning

Previous
Run JavaScript File
Next
Start Call to Phone Number