2024-08-13 10:24:12 +00:00
|
|
|
---
|
|
|
|
sidebar_position: 5
|
|
|
|
---
|
|
|
|
|
|
|
|
# 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`
|
|
|
|
|
2024-08-13 15:52:26 +03:00
|
|
|
| Parameter | CLI option | Type | 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 |
|
2024-08-13 10:24:12 +00:00
|
|
|
|
2024-08-13 15:52:26 +03:00
|
|
|
|
|
|
|
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
|
2024-08-13 10:24:12 +00:00
|
|
|
|
|
|
|
<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="Code example"
|
2024-09-24 11:38:18 +03:00
|
|
|
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
|
2024-10-15 10:07:27 +03:00
|
|
|
ChatID = "1006";
|
2024-08-13 16:47:32 +03:00
|
|
|
|
|
|
|
UserIDs = New Array;
|
|
|
|
UserIDs.Add(10);
|
|
|
|
UserIDs.Add(12);
|
|
|
|
|
|
|
|
Result = OPI_Bitrix24.AddUsersToChat(URL, ChatID, UserIDs);
|
|
|
|
|
2024-09-24 11:38:18 +03:00
|
|
|
URL = "b24-ar17wx.bitrix24.by";
|
2024-10-15 10:07:27 +03:00
|
|
|
Token = "21750a67006e9f06006b12e400000001000...";
|
|
|
|
ChatID = "1008";
|
2024-08-13 16:47:32 +03:00
|
|
|
UserID = 10;
|
|
|
|
|
|
|
|
Result = OPI_Bitrix24.AddUsersToChat(URL, ChatID, UserID, True, Token);
|
2024-08-13 10:24:12 +00:00
|
|
|
```
|
2024-10-15 09:53:37 +03:00
|
|
|
|
2024-08-13 15:52:26 +03:00
|
|
|
|
2024-08-13 10:24:12 +00:00
|
|
|
|
|
|
|
|
|
|
|
```json title="Result"
|
2024-08-14 09:06:31 +03:00
|
|
|
{
|
2024-10-06 16:55:08 +03:00
|
|
|
"result": true,
|
|
|
|
"time": {
|
2024-10-09 09:42:00 +03:00
|
|
|
"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,
|
2024-08-13 15:52:26 +03:00
|
|
|
"operating": 0
|
2024-10-06 16:55:08 +03:00
|
|
|
}
|
|
|
|
}
|
2024-08-13 10:24:12 +00:00
|
|
|
```
|