Add users to chat

Adds users to the chat by ID array

Function AddUsersToChat(Val URL, Val ChatID, Val UserIDs, Val HideHistory = False, 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
UserIDs	--users	Array of string, number	✔	New members IDs
HideHistory	--hide	Boolean	✖	Hide old messages from new members
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.add

1C:Enterprise/OneScript code example

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

    UserIDs = New Array;
    UserIDs.Add(10);
    UserIDs.Add(12);

    Result = OPI_Bitrix24.AddUsersToChat(URL, ChatID, UserIDs);

    URL    = "b24-ar17wx.bitrix24.by";
    Token  = "35c31667006e9f06006b12e400000001000...";
    ChatID = "1108";
    UserID = 10;

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

Bash

    oint bitrix24 AddUsersToChat \
     --url "b24-ar17wx.bitrix24.by" \
     --chat 1188 \
     --users "[10,12]" \
     --hide true \
     --token "***"

CMD/Bat

    oint bitrix24 AddUsersToChat ^
     --url "b24-ar17wx.bitrix24.by" ^
     --chat 1188 ^
     --users "[10,12]" ^
     --hide true ^
     --token "***"

Result

{
 "result": true,
 "time": {
  "start": 1728454873.26338,
  "finish": 1728454873.34975,
  "duration": 0.0863678455352783,
  "processing": 0.0585901737213135,
  "date_start": "2024-10-09T09:21:13+03:00",
  "date_finish": "2024-10-09T09:21:13+03:00",
  "operating_reset_at": 1728455473,
  "operating": 0
 }
}