2024-07-14 17:23:26 +02:00
|
|
|
---
|
|
|
|
|
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 | Destination |
|
|
|
|
|
|-|-|-|-|
|
|
|
|
|
| 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 not-webhook 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-07-14 18:04:01 +02:00
|
|
|
URL = "https://b24-ar17wx.bitrix24.by/rest/1/4swokunb3tk7h7dt/";
|
|
|
|
|
ChatID = "264";
|
2024-07-14 17:23:26 +02:00
|
|
|
|
|
|
|
|
Result = OPI_Bitrix24.LeaveChat(URL, ChatID);
|
|
|
|
|
|
|
|
|
|
|
2024-07-14 18:04:01 +02:00
|
|
|
URL = "b24-ar17wx.bitrix24.by";
|
|
|
|
|
Token = "adf89366006e9f06006b12e400000001000...";
|
|
|
|
|
ChatID = "266";
|
2024-07-14 17:23:26 +02:00
|
|
|
|
|
|
|
|
Result = OPI_Bitrix24.LeaveChat(URL, ChatID, Token);
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
```sh title="CLI command example"
|
|
|
|
|
|
|
|
|
|
oint bitrix24 LeaveChat --url %url% --chat %chat% --token %token%
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
```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
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
```
|
