# imopenlines.bot.session.finish

URL: https://chugunov.pro/api-bitrix24/imopenlines/openlines/chat-bots/imopenlines-bot-session-finish/
Проверено на Битрикс24 REST API, обновлено 11.09.2026 (ревизия источника fb39d6c).
Источник: официальная документация Битрикс24 (bitrix-tools/b24-rest-docs, лицензия MIT, © Bitrix). Справочник независимый, официальной документацией не является.

Завершить диалог
Scope: `imopenlines, imbot`
Кто может выполнять метод: пользователь приложения с зарегистрированным чат-ботом

## Описание

Метод `imopenlines.bot.session.finish` завершает текущий диалог открытой линии от имени чат-бота приложения.

## Параметры

- `CHAT_ID` `integer` — обязательный. Идентификатор чата, диалог которого нужно завершить. 
  Идентификатор чата можно получить с помощью методов [imopenlines.dialog.get](https://chugunov.pro/api-bitrix24/imopenlines/openlines/sessions/imopenlines-dialog-get/) или [imopenlines.crm.chat.get](https://chugunov.pro/api-bitrix24/imopenlines/openlines/chats/imopenlines-crm-chat-get/)
- `CLIENT_ID` `string` — необязательный. Параметр обязателен только для вебхуков.
  Передавайте:
  - тот же `CLIENT_ID`, который был указан при регистрации чат-бота методом [imbot.register](https://chugunov.pro/api-bitrix24/chat-bots/outdated/bots/imbot-register/)
  - или значение параметра `botToken`, переданного при регистрации чат-бота методом [imbot.v2.Bot.register](https://chugunov.pro/api-bitrix24/chat-bots/chat-bots-v2/imbot.v2/bots/bot-register/)

## Ответ

HTTP-статус: 200

```json
{
    "result": true,
    "time": {
        "start": 1728626400.456,
        "finish": 1728626400.539,
        "duration": 0.083,
        "processing": 0.031,
        "date_start": "2024-10-11T10:00:00+03:00",
        "date_finish": "2024-10-11T10:00:00+03:00",
        "operating": 0
    }
}
```

### Возвращаемые данные

- `result` `boolean`. Содержит `true`, если диалог успешно завершен
- `time` `time`. Информация о времени выполнения запроса

## Ошибки

HTTP-статус: 400

```json
{
    "error": "CHAT_ID_EMPTY",
    "error_description": "Chat ID can't be empty"
}
```

- `400` — `CHAT_ID_EMPTY`. Chat ID can't be empty
- `400` — `BOT_ID_ERROR`. Bot not found
- `403` — `WRONG_AUTH_TYPE`. Access for this method not allowed by session authorization

## Примеры запроса

### cURL (Webhook)

```bash
curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"CHAT_ID":112,"CLIENT_ID":"**put_your_client_id_or_bot_token_here**"}' \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imopenlines.bot.session.finish
```

### cURL (OAuth)

```bash
curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"CHAT_ID":112,"auth":"**put_access_token_here**"}' \
  https://**put_your_bitrix24_address**/rest/imopenlines.bot.session.finish
```

### JS (TS)

```ts
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

try {
  const response = await $b24.actions.v2.call.make<boolean>({
    method: 'imopenlines.bot.session.finish',
    params: {
      CHAT_ID: 112,
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Session finished:', result)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
```

### JS (UMD)

```html
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function finishBotSession() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'imopenlines.bot.session.finish',
        params: {
          CHAT_ID: 112,
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Session finished:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', finishBotSession)
</script>
```

### Python

```python
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.imopenlines.bot.session.finish(
        chat_id=112,
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")
```

### PHP

```php
try {
    $response = $b24Service
        ->core
        ->call(
            'imopenlines.bot.session.finish',
            [
                'CHAT_ID' => 112,
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Session finished: ' . var_export($result, true);
} catch (Throwable $exception) {
    error_log($exception->getMessage());
    echo 'Error finishing session: ' . $exception->getMessage();
}
```

### BX24.js

```js
BX24.callMethod(
    'imopenlines.bot.session.finish',
    {
        CHAT_ID: 112,
    },
    function(result) {
        if (result.error()) {
            console.error(result.error().ex);
        } else {
            console.log(result.data());
        }
    }
);
```

### PHP CRest

```php
require_once('crest.php');

$result = CRest::call(
    'imopenlines.bot.session.finish',
    [
        'CHAT_ID' => 112,
    ]
);

if (!empty($result['error'])) {
    echo 'Error: ' . $result['error_description'];
} else {
    echo 'Session finished: ' . var_export($result['result'], true);
}
```

### Go

```go
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "imopenlines.bot.session.finish", b24.Params{
	"CHAT_ID":   112,
	"CLIENT_ID": "**put_your_client_id_or_bot_token_here**",
})
if err != nil {
	return fmt.Errorf("imopenlines.bot.session.finish: %w", err)
}

var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("выполнено:", ok)
```

Оригинал в официальной документации: https://apidocs.bitrix24.ru/api-reference/imopenlines/openlines/chat-bots/imopenlines-bot-session-finish.html