Delete user from chat

Deletes user from chat

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

Parameter	CLI option	Type	Required	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

1C:Enterprise/OneScript code example

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

    UserID = 10;

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

    URL    = "b24-ar17wx.bitrix24.by";
    Token  = "11ae5d68006e9f06006b12e400000001000...";
    ChatID = "2568";

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

Bash

    oint bitrix24 DeleteUserFromChat \
     --url "b24-ar17wx.bitrix24.by" \
     --chat 2810 \
     --user 10 \
     --token "***"

CMD/Bat

    oint bitrix24 DeleteUserFromChat ^
     --url "b24-ar17wx.bitrix24.by" ^
     --chat 2810 ^
     --user 10 ^
     --token "***"

Result

{
 "result": true,
 "time": {
  "start": 1728454872.91198,
  "finish": 1728454873.00982,
  "duration": 0.0978438854217529,
  "processing": 0.0658779144287109,
  "date_start": "2024-10-09T09:21:12+03:00",
  "date_finish": "2024-10-09T09:21:13+03:00",
  "operating_reset_at": 1728455472,
  "operating": 0
 }
}