Skip to main content

Leave chat

Removes the current user from the chat room

Function LeaveChat(Val URL, Val ChatID, Val Token = "") Export

ParameterCLI optionTypeDescription
URL--urlStringURL of webhook or a Bitrix24 domain, when token used
ChatID--chatString, NumberChat ID
Token--tokenStringAccess token, when app auth method used

Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API


tip

Method at API documentation: im.chat.leave


Code example
    URL    = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
ChatID = "642";

Result = OPI_Bitrix24.LeaveChat(URL, ChatID);

URL = "b24-ar17wx.bitrix24.by";
Token = "b529cb66006e9f06006b12e400000001000...";
ChatID = "644";

Result = OPI_Bitrix24.LeaveChat(URL, ChatID, Token);
CLI command example
    
oint bitrix24 LeaveChat --url "b24-ar17wx.bitrix24.by" --chat "452" --token "fe3fa966006e9f06006b12e400000001000..."

Result
{
"result": true,
"time": {
"start": 1720816599.74716,
"finish": 1720816599.81746,
"duration": 0.0702948570251465,
"processing": 0.0438079833984375,
"date_start": "2024-07-12T20:36:39+00:00",
"date_finish": "2024-07-12T20:36:39+00:00",
"operating_reset_at": 1720817199,
"operating": 0
}
}