Call the Phone Number BX24.im.phoneTo
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
The application runs in an iframe
An application runs inside its own iframe on a different origin. The Bitrix24 runtime is not available there — neither Messenger.* nor BX.Runtime.loadExtension can be reached from the application.
The only channel outward is the parent bridge: the BX24.im.* methods, or their equivalents $b24.parent.imCallTo, $b24.parent.imPhoneTo, $b24.parent.imOpenMessenger, and $b24.parent.imOpenHistory in the b24jssdk library.
Calling these methods prints a deprecation notice in the Bitrix24 console that recommends Messenger.startVideoCall, Messenger.startPhoneCall, or Messenger.openChat. Disregard it: those are top-window methods, available only to code running on the Bitrix24 page itself, and they are not reachable from an application.
The im.public.iframe extension that the notice names is meant for an iframe on the Bitrix24 domain, not for an application frame. For that case, see Passing Context to the Bot When Opening a Chat.
BX24.im.phoneTo(string phone): void;
The BX24.im.phoneTo method passes a phone number to Bitrix24 Messenger and starts an outgoing call.
The method works after BX24.init. Telephony must be available in Bitrix24 to make a call.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
phone* |
Phone number to call. Pass the number in international format, for example, |
Code Example
How to Use Examples in Documentation
BX24.init(function () {
BX24.im.phoneTo('+14151234567');
});
Response Handling
The method sends a call command and returns nothing.
Error Handling
The method does not pass error codes to the application. If calls are unavailable on the current plan, Bitrix24 opens a window with information about the restriction.