метод REST scope: imbot Устаревший

imbot.update

Обновить чат-бота

Устаревший метод. Развитие метода остановлено. Используйте imbot.v2.Bot.update.

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

Описание

Метод imbot.update обновляет данные чат-бота и его обработчики событий.

Параметры

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

Идентификатор чат-бота. Получить идентификатор можно методом imbot.bot.list. Значение должно быть больше 0

FIELDS object обязательный

Данные для обновления чат-бота. Структура объекта подробно описана ниже

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

Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота

Параметр FIELDS

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

Новый строковый код бота, уникальный в рамках Битрикс24

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

Общий URL обработчика событий. Если передан, его значение копируется в EVENT_MESSAGE_ADD, EVENT_MESSAGE_UPDATE, EVENT_MESSAGE_DELETE, EVENT_WELCOME_MESSAGE, EVENT_BOT_DELETE.

Если нужны разные обработчики, не передавайте EVENT_HANDLER. Задайте отдельные URL в параметрах EVENT_MESSAGE_ADD, EVENT_MESSAGE_UPDATE, EVENT_MESSAGE_DELETE, EVENT_WELCOME_MESSAGE, EVENT_BOT_DELETE

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

URL обработчика события ONIMBOTMESSAGEADD

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

URL обработчика события ONIMBOTMESSAGEUPDATE

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

URL обработчика события ONIMBOTMESSAGEDELETE

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

URL обработчика события ONIMBOTJOINCHAT

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

URL обработчика события ONIMBOTDELETE

PROPERTIES object необязательный

Свойства профиля чат-бота. Структура объекта подробно описана ниже

Параметр FIELDS.PROPERTIES

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

Имя чат-бота. Если переданы оба значения: NAME и LAST_NAME, они не должны быть пустыми одновременно

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

Фамилия чат-бота. Если переданы оба значения: NAME и LAST_NAME, они не должны быть пустыми одновременно

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

Цвет чат-бота для мобильного интерфейса: RED, GREEN, MINT, LIGHT_BLUE, DARK_BLUE, PURPLE, AQUA, PINK, LIME, BROWN, AZURE, KHAKI, SAND, MARENGO, GRAY, GRAPHITE

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

Email для связи чат-бота. Бот создается как пользователь, поэтому email бота не должен совпадать с email реального пользователя Битрикс24. Это позволит избежать конфликтов учетных записей

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

День рождения в формате YYYY-MM-DD

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

Должность или описание чат-бота

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

Ссылка на сайт

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

Пол, допустимые значения: M или F

PERSONAL_PHOTO file необязательный

Аватар чат-бота в формате Base64

Размер изображения не должен превышать ограничение в 5000x5000

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

curl -X POST /
  -H "Content-Type: application/json" /
  -H "Accept: application/json" /
  -d '{"BOT_ID":39,"FIELDS":{"CODE":"newbot_v2","EVENT_HANDLER":"https://example.com/bot/events","PROPERTIES":{"NAME":"UpdatedBot","WORK_POSITION":"Updated description"}},"CLIENT_ID":"**put_your_client_id_here**"}' /
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.update

Ответ

{
    "result": true,
    "time": {
        "start": 1728626400.123,
        "finish": 1728626400.234,
        "duration": 0.111,
        "processing": 0.045,
        "date_start": "2024-10-11T10:00:00+03:00",
        "date_finish": "2024-10-11T10:00:00+03:00",
        "operating_reset_at": 1762349466,
        "operating": 0
    }
}

Обработка ошибок

HTTP-статус: 400

{
    "error": "WRONG_REQUEST",
    "error_description": "Update fields can't be empty"
}
Код Описание Значение
WRONG_AUTH_TYPE Access for this method not allowed by session authorization. Метод вызван с сессионной авторизацией вместо OAuth или вебхука
ACCESS_DENIED Access denied! Client ID not specified Не удалось определить приложение: отсутствует clientId авторизации и не передан CLIENT_ID
BOT_ID_ERROR Bot not found Бот не найден
APP_ID_ERROR Bot was installed by another rest application Переданный BOT_ID принадлежит другому приложению
EVENT_MESSAGE_ADD_ERROR Wrong handler URL Передан невалидный URL обработчика EVENT_MESSAGE_ADD
EVENT_MESSAGE_UPDATE_ERROR Wrong handler URL Передан невалидный URL обработчика EVENT_MESSAGE_UPDATE
EVENT_MESSAGE_DELETE_ERROR Wrong handler URL Передан невалидный URL обработчика EVENT_MESSAGE_DELETE
EVENT_WELCOME_MESSAGE_ERROR Wrong handler URL Передан невалидный URL обработчика EVENT_WELCOME_MESSAGE
EVENT_BOT_DELETE_ERROR Wrong handler URL Передан невалидный URL обработчика EVENT_BOT_DELETE
NAME_ERROR Bot name isn't specified В PROPERTIES переданы оба пустых поля: NAME и LAST_NAME
WRONG_REQUEST Update fields can't be empty Не переданы поля и обработчики для обновления
WRONG_REQUEST Bot can't be updated Бот не может быть обновлен

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

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