88  /  169

im.message.command

Просмотров: 6243
Дата последнего изменения: 18.01.2022
Анна Кокина
Сложность урока:
3 уровень - средняя сложность. Необходимо внимание и немного подумать.
1
2
3
4
5

Использование команды бота

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

Параметры

Параметр Пример Обязат. Описание Ревизия
MESSAGE_ID 278 Да Идентификатор сообщения с возможностью отдать команду боту 30
BOT_ID 1 Да Идентификатор бота в чате 30
COMMAND 'KEYBOARD' Да Команда, которую должен выполнить бот 30
COMMAND_PARAMS 'stop' Да Параметры команды 30

Необходимо передавать сообщение, в котором есть выбор команд бота.


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

JavaScript

B24.callMethod(
  'im.message.command',
  {
    MESSAGE_ID: 278,
    BOT_ID: 1,
    COMMAND: 'KEYBOARD',
    COMMAND_PARAMS: 'stop'
  },
  res => {
    if (res.error())
    {
      console.error(result.error().ex);
    }
    else
    {
      console.log(res.data())
    }
  }
)

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

true

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

{
  "error":"PARAMS_ERROR",
  "error_description":"Incorrect params"
}

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

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

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

Код Описание
MESSAGE_ID_ERROR Параметр MESSAGE_ID не задан или не является числом
BOT_ID_ERROR Параметр BOT_ID не задан или не является числом
COMMAND_ERROR Параметр COMMAND не задан
PARAMS_ERROR Параметр COMMAND_PARAMS не задан или не соответствует параметру команды бота


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