57  /  110

im.message.update

Просмотров: 334 (Статистика ведётся с 06.02.2017)
Александр Суворов
Сложность урока:
4 уровень - сложно, требуется сосредоточится, внимание деталям и точному следованию инструкции.
1
2
3
4
5

Отправка изменения сообщения чат-бота

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

Параметры

Параметр Пример Обязат. Описание Ревизия
MESSAGE_ID 1 Да Идентификатор сообщения 18
MESSAGE Текст сообщения Нет Текст сообщения. Если передать пустое значение, то сообщение будет удалено 18
ATTACH Нет Вложение 18
URL_PREVIEW Y Нет Преобразовывать ссылки в rich-ссылки 18
KEYBOARD Нет Клавиатура 18
MENU Нет Контекстное меню 18

Ссылки по теме:

Как работать с набираемыми клавиатурами
Как работать с вложениями
Форматирование сообщений


Вызов метода

PHP

$result = restCommand('im.message.update', Array(

    'MESSAGE_ID' => 1,
    'MESSAGE' => 'Текст сообщения',
    'ATTACH' => '',
    'URL_PREVIEW' => 'Y',
    'KEYBOARD' => '',
    'MENU' => '',

), $_REQUEST["auth"]);

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

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


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

{
    "error": "MESSAGE_ID_ERROR",
    "error_description": "Не передан идентификатор сообщения"
}

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

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

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

Код Описание
MESSAGE_ID_ERROR Не передан идентификатор сообщения
CANT_EDIT_MESSAGE У вас нет доступа к этому сообщению или время на его модификацию истекло (после публикации прошло более 3-х суток)
ATTACH_ERROR Весь переданный объект вложения не прошел валидацию
ATTACH_OVERSIZE Превышен максимально допустимый размер вложения (30 Кб)
KEYBOARD_ERROR Весь переданный объект клавиатуры не прошел валидацию
KEYBOARD_OVERSIZE Превышен максимально допустимый размер клавиатуры (30 Кб)
MENU_ERROR Весь переданный объект меню не прошел валидацию
MENU_OVERSIZE Превышен максимально допустимый размер меню (30 Кб)

Обратите внимание! Метод указан с использованием функции restCommand - это метод отправки данных в Битрикс24, данный метод есть в примере ЭхоБота, и представлен здесь в качестве примера. Вы можете использовать свою функцию или javascript-метод BX24.callMethod или bitrix24-php-sdk.



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