Delete user from chat

Deletes user from chat

Function DeleteUserFromChat(Val URL, Val ChatID, Val UserID, Val Token = "") Export

Parameter	CLI option	Type	Description
URL	--url	String	URL of webhook or a Bitrix24 domain, when token used
ChatID	--chat	String, Number	Chat ID
UserID	--user	String, Number	User ID
Token	--token	String	Access token, when app auth method used

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

tip

Method at API documentation: im.chat.user.delete

Code example

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

    UserID = 10;

    Result = OPI_Bitrix24.DeleteUserFromChat(URL, ChatID, UserID);

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

    Result = OPI_Bitrix24.DeleteUserFromChat(URL, ChatID, UserID, Token);

CLI command example

    
  oint bitrix24 DeleteUserFromChat --url "b24-ar17wx.bitrix24.by" --chat "452" --user "10" --token "fe3fa966006e9f06006b12e400000001000..."

Result

{
  "result": true,
  "time": {
  "start": 1720865685.25089,
  "finish": 1720865685.32425,
  "duration": 0.0733590126037598,
  "processing": 0.0480890274047852,
  "date_start": "2024-07-13T10:14:45+00:00",
  "date_finish": "2024-07-13T10:14:45+00:00",
  "operating_reset_at": 1720866285,
  "operating": 0
  }
  }