Documentation

imopenlines.session.start

Scope: catalog Permissions to execute: for all

Method starts a session.

Parameters

ParameterExampleRequiredDescription
CHAT_ID494YesChat ID.

Method call and response

JavaScript for Bitrix24 On-premise.

BX.rest.callMethod(
	'imopenlines.session.start',
	{
		CHAT_ID: 2024
	}
)
	.then(result => console.log(result.data()))
	.catch(result => console.warn(result.error().ex))
;

JavaScript for Bitrix24 Cloud:

BX24.callMethod(
    'imopenlines.session.start',
    {
            CHAT_ID: 2024
        },
    function(result)
    {
            if(result.error())
        {
                 console.warn(result.error().ex);
            return false;
         }

            console.log(result.data());
    }
);

Response example:

true

Possible error codes

CodeDescription
ACCESS_DENIEDCurrent user doesn't have access to the specified chat.
CHAT_TYPESpecified chat is not an Open Channel.
CHAT_IDChat ID is incorrect.


© «Bitrix24», 2001-2024