Эффективная интеграция и кастомизация функционала в Битрикс24 часто требует работы на уровне API. Сегодня мы подробно рассмотрим «Добавить сообщение im.message.add». Вы узнаете экспертные методики работы с im.message.add и научитесь избегать типичных ошибок начинающих разработчиков.

Добавить сообщение im.message.add

Тут может не хватать некоторых данных — дополним в ближайшее время

• нужны правки под стандарт написания
• не указаны типы параметров
• отсутствуют примеры

> Scope: im
>
> Кто может выполнять метод: любой пользователь

Метод im.message.add отправляет сообщение от текущего пользователя в чат.

Практические примеры использования в коде

• cURL (Webhook)

    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{DIALOG_ID: "chat5",MESSAGE: "Сообщение [B]с вложением[/B] цвета primary и поддержкой [I]bb-кодов[/I]",ATTACH: [{MESSAGE: "API будет доступно в обновлении [B]im 24.0.0[/B]"}]}' \
    https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webbhook_here**/im.message.add

• cURL (OAuth)

    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{DIALOG_ID: "chat5",MESSAGE: "Сообщение [B]с вложением[/B] цвета primary и поддержкой [I]bb-кодов[/I]",ATTACH: [{MESSAGE: "API будет доступно в обновлении [B]im 24.0.0[/B]"}]}' \
    https://**put_your_bitrix24_address**/rest/im.message.add

• JS

    try
    {
    	const response = await $b24.callMethod(
    		'im.message.add',
    		{
    			DIALOG_ID: "chat5",
    			MESSAGE: "Сообщение [B]с вложением[/B] цвета primary и поддержкой [I]bb-кодов[/I]",
    			ATTACH: [
    				{
    					MESSAGE: "API будет доступно в обновлении [B]im 24.0.0[/B]"
    				},
    			],
    		}
    	);
    	
    	const result = response.getData().result;
    	console.log('response', result.answer);
    	if (result.error())
    		alert("Error: " + result.error());
    	else
    		console.log(result);
    }
    catch( error )
    {
    	console.error('Error:', error);
    }

• PHP

    try {
        $response = $b24Service
            ->core
            ->call(
                'im.message.add',
                [
                    'DIALOG_ID' => "chat5",
                    'MESSAGE' => "Сообщение [B]с вложением[/B] цвета primary и поддержкой [I]bb-кодов[/I]",
                    'ATTACH' => [
                        [
                            'MESSAGE' => "API будет доступно в обновлении [B]im 24.0.0[/B]"
                        ],
                    ],
                ]
            );
    
        $result = $response
            ->getResponseData()
            ->getResult();
    
        echo 'Success: ' . print_r($result, true);
        echo 'response: ' . $result['answer'];
    
        if ($result['error']) {
            echo 'Error: ' . $result['error'];
        } else {
            echo 'Data: ' . print_r($result['data'], true);
        }
    
    } catch (Throwable $e) {
        error_log($e->getMessage());
        echo 'Error adding message: ' . $e->getMessage();
    }

• BX24.js

    BX24.callMethod(    
        'im.message.add',
        {
            DIALOG_ID: "chat5",
            MESSAGE: "Сообщение [B]с вложением[/B] цвета primary и поддержкой [I]bb-кодов[/I]",
            ATTACH: [
                {
                    MESSAGE: "API будет доступно в обновлении [B]im 24.0.0[/B]"
                },
            ],
        },
        function(result) {
            console.log('response', result.answer);
            if(result.error())
                alert("Error: " + result.error());
            else
            console.log(result.data());
        }
    );

• PHP CRest

    require_once('crest.php');

    $result = CRest::call(
        'im.message.add',
        [
            "DIALOG_ID" => "chat20921",
            "MESSAGE"   => "Сообщение [B]с вложением[/B] цвета primary и поддержкой [I]bb-кодов[/I]",
            "ATTACH":   => [
                [
                    "MESSAGE" => "API будет доступно в обновлении [B]im 24.0.0[/B]"
                ],
            ],
        ]
    );

    echo '<pre>';
    print_r($result);
    echo '</pre>';

• Пример использования метода в приложении «ЭхоБот»

Ответ в случае успеха

{
    "result": 11
}

Результат выполнения: идентификатор сообщения MESSAGE_ID или ошибка.

Ответ в случае ошибки

{
    "error": "USER_ID_EMPTY",
    "error_description": "Идентификатор получателя не задан в случае отправки сообщения в чат один-на-один"
}

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

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

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

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

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