1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2025-12-01 22:29:52 +02:00
Files
OpenIntegrations/docs/en/md/Bitrix24/Chats-and-dialogs-managment/Leave-chat.md

65 lines
1.5 KiB
Markdown
Raw Normal View History

---
sidebar_position: 3
---
# Leave chat
Removes the current user from the chat room
`Function LeaveChat(Val URL, Val ChatID, 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 |
| Token | --token | String | 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.leave](https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=93&LESSON_ID=12101)
:::
<br/>
```bsl title="Code example"
2024-08-13 16:37:03 +03:00
URL = "https://b24-ar17wx.bitrix24.by/rest/1/f2ppp8uucc891111/";
ChatID = "450";
Result = OPI_Bitrix24.LeaveChat(URL, ChatID);
2024-08-13 16:37:03 +03:00
URL = "b24-ar17wx.bitrix24.by";
Token = "fe3fa966006e9f06006b12e400000001000...";
ChatID = "452";
Result = OPI_Bitrix24.LeaveChat(URL, ChatID, Token);
```
```sh title="CLI command example"
oint bitrix24 LeaveChat --url "b24-ar17wx.bitrix24.by" --chat "452" --token "fe3fa966006e9f06006b12e400000001000..."
```
```json title="Result"
{
"result": true,
"time": {
"start": 1720816599.74716,
"finish": 1720816599.81746,
"duration": 0.0702948570251465,
"processing": 0.0438079833984375,
"date_start": "2024-07-12T20:36:39+00:00",
"date_finish": "2024-07-12T20:36:39+00:00",
"operating_reset_at": 1720817199,
"operating": 0
}
}
```