﻿---
sidebar_position: 5
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# 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 | &#x2714; | URL of webhook or a Bitrix24 domain, when token used |
  | ChatID | --chat | String, Number | &#x2714; | Chat ID |
  | UserIDs | --users | Array of string, number | &#x2714; | New members IDs |
  | HideHistory | --hide | Boolean | &#x2716; | Hide old messages from new members |
  | Token | --token | String | &#x2716; | Access token, when app auth method used |

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

<br/>

:::tip
Method at API documentation: [im.chat.user.add](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12097)
:::
<br/>



```bsl title="1C:Enterprise/OneScript code example"
    URL    = "https://b24-ar17wx.bitrix24.by/rest/1/h0m...";
    ChatID = "1846";

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

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

    URL    = "b24-ar17wx.bitrix24.by";
    Token  = "9d50a767006e9f06006b12e400000001000...";
    ChatID = "1848";
    UserID = 10;

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

 <Tabs>
  
    <TabItem value="bash" label="Bash" default>
        ```bash
            oint bitrix24 AddUsersToChat \
             --url "b24-ar17wx.bitrix24.by" \
             --chat 1812 \
             --users "[10,12]" \
             --hide true \
             --token "***"
        ```
    </TabItem>
  
    <TabItem value="bat" label="CMD/Bat" default>
        ```batch
            oint bitrix24 AddUsersToChat ^
             --url "b24-ar17wx.bitrix24.by" ^
             --chat 1812 ^
             --users "[10,12]" ^
             --hide true ^
             --token "***"
        ```
    </TabItem>
</Tabs>


```json title="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
 }
}
```
