imopenlines.bot.session.finish

Просмотров: 13888
Дата последнего изменения: 19.11.2021

Александр Суворов

Сложность урока:

3 уровень - средняя сложность. Необходимо внимание и немного подумать.

Завершение текущей сессии

Ревизия Получить информацию о текущей ревизии API (версии платформы) – im.revision.get : 1

Внимание! Для использования методов IMOPENLINES REST необходимо помимо прав на imbot (Создание и управление чат-ботами) иметь доступ к scope imopenlines (Открытые линии).

Параметры

Параметр	Пример	Обязат.	Описание	Ревизия
CHAT_ID	112	Да	Идентификатор чата	1

Вызов метода и ответ

PHP

$result = restCommand('imopenlines.bot.session.finish', Array(

    'CHAT_ID' => 112

), $_REQUEST["auth"]);

Пример ответа

{
	"result": true
}

Результат выполнения: true или ошибка.

Пример ответа при возникновении ошибки

{
    "error": "CHAT_ID_EMPTY",
    "error_description": "Не передан идентификатор чата"
}

Описание ключей:

error – код возникшей ошибки
error_description – краткое описание возникшей ошибки

Возможные коды ошибок

Код	Описание
CHAT_ID_EMPTY	Не передан идентификатор чата.
BOT_ID_ERROR	Неправильный идентификатор чат-бота.

Курсы разработаны в компании «1С-Битрикс»