im.message.add
Отправить сообщение
Описание
Метод im.message.add отправляет сообщение в чат.
Параметры
DIALOG_ID
string
обязательный
Идентификатор чата в формате:
chatXXX— чатsgXXX— чат группы или проектаXXX— идентификатор пользователя личного чата
Идентификатор чата можно получить с помощью метода im.chat.get. Идентификатор пользователя — с помощью методов user.get и user.search
MESSAGE
string
обязательный
Текст сообщения. Обязателен, если не передан ATTACH.
Поддерживается форматирование
ATTACH
object
необязательный
Вложение с блоками контента: изображения, ссылки, файлы. Обязателен, если не передан MESSAGE.
Подробнее читайте в разделе Вложения
KEYBOARD
object
необязательный
Кнопки под сообщением, с которыми может взаимодействовать пользователь.
Подробнее читайте в статье Работа с клавиатурами
MENU
object
необязательный
Дополнительные пункты в контекстном меню чата.
Подробнее читайте в статье Контекстное меню
SYSTEM
string
необязательный
Признак системного сообщения.
Допустимые значения:
- Y — системное сообщение
- N — обычное сообщение
По умолчанию — N
URL_PREVIEW
string
необязательный
Преобразование ссылок в rich-ссылки.
Допустимые значения:
- Y — включено
- N — выключено
По умолчанию — Y
REPLY_ID
integer
необязательный
Идентификатор сообщения, на которое отправляется ответ. Сообщение для ответа должно быть в том же чате.
Идентификатор можно получить с помощью метода im.dialog.messages.get
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"DIALOG_ID":"chat2941","MESSAGE":"Текст сообщения","SYSTEM":"N","URL_PREVIEW":"Y","REPLY_ID":34237}' \
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":"chat2941","MESSAGE":"Текст сообщения","SYSTEM":"N","URL_PREVIEW":"Y","REPLY_ID":34237,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/im.message.add
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
try {
const response = await $b24.actions.v2.call.make<number>({
method: 'im.message.add',
params: {
DIALOG_ID: 'chat2941',
MESSAGE: 'Message text',
SYSTEM: 'N',
URL_PREVIEW: 'Y',
REPLY_ID: 34237,
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Created message with ID:', result)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function sendMessage() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'im.message.add',
params: {
DIALOG_ID: 'chat2941',
MESSAGE: 'Message text',
SYSTEM: 'N',
URL_PREVIEW: 'Y',
REPLY_ID: 34237,
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Created message with ID:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', sendMessage)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.im.message.add(
dialog_id="chat2941",
message="Текст сообщения",
system=False,
url_preview=True,
reply_id=34237,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$response = $b24Service
->core
->call(
'im.message.add',
[
'DIALOG_ID' => 'chat2941',
'MESSAGE' => 'Текст сообщения',
'SYSTEM' => 'N',
'URL_PREVIEW' => 'Y',
'REPLY_ID' => 34237
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error adding message: ' . $e->getMessage();
}
BX24.callMethod(
'im.message.add',
{
DIALOG_ID: 'chat2941',
MESSAGE: 'Текст сообщения',
SYSTEM: 'N',
URL_PREVIEW: 'Y',
REPLY_ID: 34237
},
function(result)
{
if (result.error())
console.error(result.error());
else
console.log(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'im.message.add',
[
'DIALOG_ID' => 'chat2941',
'MESSAGE' => 'Текст сообщения',
'SYSTEM' => 'N',
'URL_PREVIEW' => 'Y',
'REPLY_ID' => 34237
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "im.message.add", b24.Params{
"DIALOG_ID": "chat2941",
"MESSAGE": "Текст сообщения",
"SYSTEM": "N",
"URL_PREVIEW": "Y",
"REPLY_ID": 34237,
})
if err != nil {
return fmt.Errorf("im.message.add: %w", err)
}
var newID b24.ID
if err := json.Unmarshal(res.Result, &newID); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("идентификатор:", newID)
Ответ
HTTP-статус: 200
{
"result": 34239,
"time": {
"start": 1772552939,
"finish": 1772552939.091396,
"duration": 0.09139609336853027,
"processing": 0,
"date_start": "2026-03-03T17:48:59+03:00",
"date_finish": "2026-03-03T17:48:59+03:00",
"operating_reset_at": 1772553539,
"operating": 0
}
}
Возвращаемые данные
result
integer
Идентификатор отправленного сообщения
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": "MESSAGE_EMPTY",
"error_description": "Message can't be empty"
}
| Код | Описание | Значение |
|---|---|---|
MESSAGE_EMPTY |
Message can't be empty | Пустой MESSAGE и отсутствует ATTACH |
USER_ID_EMPTY |
User ID can't be empty | Не передан или некорректен идентификатор пользователя в DIALOG_ID |
USER_NOT_FOUND |
User not found | Пользователь не найден |
CHAT_ID |
Ошибка при создании сообщения | Не удалось создать сообщение. Убедитесь, что чат с таким ID существует |
ACCESS_ERROR |
Action unavailable | Недостаточно прав для отправки сообщения |
PARAMS_ERROR |
Incorrect params | Некорректный набор параметров запроса |
ATTACH_ERROR |
Incorrect attach params | Невалидный объект ATTACH |
ATTACH_OVERSIZE |
You have exceeded the maximum allowable size of attach | Размер ATTACH превышает допустимый |
KEYBOARD_ERROR |
Incorrect keyboard params | Невалидный объект KEYBOARD |
MENU_ERROR |
Incorrect menu params | Невалидный объект MENU |
REPLY_ACCESS_ERROR |
Action unavailable | Нет доступа к сообщению в REPLY_ID |
REPLY_FROM_OTHER_CHAT_ERROR |
You can only reply to a message within the same chat | Нельзя отвечать на сообщение из другого чата |

