Documentation

BX24.openPath

BX24.openPath(path,callback);

Method opens a specified path inside slider in the Bitrix24 account.


Attention! Method is not operational in the mobile app due to security reasons.

Starting from module version 22.300 can open SPAs.


Parameters

Parameter Description Available from version
path Path inside Bitrix24 account, can start from:
^\/(crm\/(deal|lead|contact|company)|marketplace|company\/personal\/user\/[0-9]+|workgroups\/group\/[0-9]+)\/
callback function is called in 2 cases:
  • during opening error, returns the following: {result: "error", errorCode: "PATH_NOT_AVAILABLE"}
  • in mobile application: {result: "error", errorCode: "METHOD_NOT_SUPPORTED_ON_DEVICE"}
  • when closing a slide: {result: "close"}
  • Example:

    <script src="//api.bitrix24.com/api/v1/"></script>
    <script>
        BX24.init(
            function()
            {
                BX24.openPath(
                    '/crm/deal/details/5/',
                    function(result)
                    {
                        console.log(result);
                    }
                );
            }
        );
    </script>


    © «Bitrix24», 2001-2024
    Up