Работа с клавиатурами

KEYBOARD добавляет в сообщение интерактивные кнопки: переход по ссылке, выполнение команды, подстановку текста в поле ввода и другие действия.

Клавиатуру передают в параметре KEYBOARD при отправке или обновлении сообщения: im.message.add, im.message.update.

Минимальная структура

  • KEYBOARD.BUTTONS — массив кнопок
  • TEXT — текст кнопки
  • одно действие: LINK или ACTION + ACTION_VALUE или COMMAND

Пример отправки сообщения с клавиатурой

Как использовать примеры в документации

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"DIALOG_ID":"chat2725","MESSAGE":"Выберите действие","KEYBOARD":{"BUTTONS":[{"TEXT":"Открыть сайт","LINK":"https://www.example.ru/"},{"TYPE":"NEWLINE"},{"TEXT":"Подставить команду","ACTION":"PUT","ACTION_VALUE":"/help"}]}}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.message.add
        
curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"DIALOG_ID":"chat2725","MESSAGE":"Выберите действие","KEYBOARD":{"BUTTONS":[{"TEXT":"Открыть сайт","LINK":"https://www.example.ru/"},{"TYPE":"NEWLINE"},{"TEXT":"Подставить команду","ACTION":"PUT","ACTION_VALUE":"/help"}]},"auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/im.message.add
        
try {
            const response = await $b24.callMethod(
                'im.message.add',
                {
                    DIALOG_ID: 'chat2725',
                    MESSAGE: 'Выберите действие',
                    KEYBOARD: {
                        BUTTONS: [
                            { TEXT: 'Открыть сайт', LINK: 'https://www.example.ru/' },
                            { TYPE: 'NEWLINE' },
                            { TEXT: 'Подставить команду', ACTION: 'PUT', ACTION_VALUE: '/help' },
                        ],
                    },
                }
            );
        
            const result = response.getData().result;
            console.log('Created message ID:', result);
        } catch (error) {
            console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'im.message.add',
                    [
                        'DIALOG_ID' => 'chat2725',
                        'MESSAGE' => 'Выберите действие',
                        'KEYBOARD' => [
                            'BUTTONS' => [
                                ['TEXT' => 'Открыть сайт', 'LINK' => 'https://www.example.ru/'],
                                ['TYPE' => 'NEWLINE'],
                                ['TEXT' => 'Подставить команду', 'ACTION' => 'PUT', 'ACTION_VALUE' => '/help'],
                            ],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Created message ID: ' . $result;
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'im.message.add',
            {
                DIALOG_ID: 'chat2725',
                MESSAGE: 'Выберите действие',
                KEYBOARD: {
                    BUTTONS: [
                        { TEXT: 'Открыть сайт', LINK: 'https://www.example.ru/' },
                        { TYPE: 'NEWLINE' },
                        { TEXT: 'Подставить команду', ACTION: 'PUT', ACTION_VALUE: '/help' },
                    ],
                },
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error().ex);
                } else {
                    console.log(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'im.message.add',
            [
                'DIALOG_ID' => 'chat2725',
                'MESSAGE' => 'Выберите действие',
                'KEYBOARD' => [
                    'BUTTONS' => [
                        ['TEXT' => 'Открыть сайт', 'LINK' => 'https://www.example.ru/'],
                        ['TYPE' => 'NEWLINE'],
                        ['TEXT' => 'Подставить команду', 'ACTION' => 'PUT', 'ACTION_VALUE' => '/help'],
                    ],
                ],
            ]
        );
        
        print_r($result);

Актуальная документация по клавиатурам находится в разделе Чат-боты 2.0:

Продолжите изучение

Предыдущая
Вложения
Следующая
Работа с контекстным меню