метод REST scope: imopenlines, imbot

imopenlines.bot.session.finish

Завершить диалог

Кто может выполнять: пользователь приложения с зарегистрированным чат-ботом

Описание

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

Параметры

CHAT_ID integer обязательный

Идентификатор чата, диалог которого нужно завершить.

Идентификатор чата можно получить с помощью методов imopenlines.dialog.get или imopenlines.crm.chat.get

CLIENT_ID string необязательный

Параметр обязателен только для вебхуков.

Передавайте:
- тот же CLIENT_ID, который был указан при регистрации чат-бота методом imbot.register
- или значение параметра botToken, переданного при регистрации чат-бота методом imbot.v2.Bot.register

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

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

Ответ

HTTP-статус: 200

{
    "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

{
    "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

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.