im.dialog.messages.search
Найти сообщение в чате
Описание
Метод im.dialog.messages.search выполняет поиск сообщений в чате.
Параметры
CHAT_ID
integer
необязательный
Идентификатор чата, в котором выполняется поиск
SEARCH_MESSAGE
string
необязательный
Строка поиска по тексту сообщения.
Поиск по этому параметру выполняется для строк длиной более 2 символов
DATE_FROM
datetime
необязательный
Начало периода поиска в формате ISO 8601 (RFC3339)
DATE_TO
datetime
необязательный
Конец периода поиска в формате ISO 8601 (RFC3339)
DATE
datetime
необязательный
Поиск сообщений за конкретную дату в формате ISO 8601 (RFC3339).
Если параметр передан, поиск выполняется в пределах суток от указанной даты
ORDER
object
необязательный
Параметры сортировки.
Поддерживаемое поле:
- ID — сортировка по идентификатору сообщения, значения ASC или DESC
По умолчанию: {"ID": "DESC"}
LIMIT
integer
необязательный
Количество возвращаемых сообщений.
Значение по умолчанию: 50.
Максимальное значение: 200
LAST_ID
integer
необязательный
Идентификатор последнего сообщения из предыдущей выборки для пагинации
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"CHAT_ID":3,"SEARCH_MESSAGE":"test","ORDER":{"ID":"DESC"},"LIMIT":20}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.dialog.messages.search
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"CHAT_ID":3,"SEARCH_MESSAGE":"test","ORDER":{"ID":"DESC"},"LIMIT":20,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/im.dialog.messages.search
// 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, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type DialogMessagesSearchResult = {
messages: Array<{
id: number
chat_id: number
author_id: number
date: ISODate
text: string
isSystem: boolean
uuid: string | null
forward: object | null
params: unknown[]
viewedByOthers: boolean
unread: boolean
viewed: boolean
}>
users: unknown[]
files: unknown[]
additionalMessages: unknown[]
copilot: object | null
stickers: unknown[]
reactions: unknown[]
tariffRestrictions: { isHistoryLimitExceeded: boolean }
usersShort: unknown[]
}
try {
const response = await $b24.actions.v2.call.make<DialogMessagesSearchResult>({
method: 'im.dialog.messages.search',
params: {
CHAT_ID: 3,
SEARCH_MESSAGE: 'test',
ORDER: { ID: 'DESC' },
LIMIT: 20,
},
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('Found messages:', result.messages.length, result.messages)
}
} 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 searchDialogMessages() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'im.dialog.messages.search',
params: {
CHAT_ID: 3,
SEARCH_MESSAGE: 'test',
ORDER: { ID: 'DESC' },
LIMIT: 20,
},
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('Found messages:', result.messages.length, result.messages)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', searchDialogMessages)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.im.dialog.messages.search(
chat_id=3,
search_message="test",
order={
"ID": "DESC",
},
limit=20,
).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.dialog.messages.search',
[
'CHAT_ID' => 3,
'SEARCH_MESSAGE' => 'test',
'ORDER' => ['ID' => 'DESC'],
'LIMIT' => 20,
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error: ' . $e->getMessage();
}
BX24.callMethod(
'im.dialog.messages.search',
{
CHAT_ID: 3,
SEARCH_MESSAGE: 'test',
ORDER: { ID: 'DESC' },
LIMIT: 20
},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'im.dialog.messages.search',
[
'CHAT_ID' => 3,
'SEARCH_MESSAGE' => 'test',
'ORDER' => ['ID' => 'DESC'],
'LIMIT' => 20,
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "im.dialog.messages.search", b24.Params{
"CHAT_ID": 3,
"SEARCH_MESSAGE": "test",
"ORDER": b24.Params{
"ID": "DESC",
},
"LIMIT": 20,
})
if err != nil {
return fmt.Errorf("im.dialog.messages.search: %w", err)
}
// Форма ответа показана ниже на этой странице.
fmt.Printf("%s\n", res.Result)
Ответ
HTTP-статус: 200
{
"result": {
"users": [
{
"id": 1,
"active": true,
"name": "Алекс",
"firstName": "Алекс",
"lastName": "",
"workPosition": "",
"color": "#df532d",
"avatar": "https://cdn-ru.bitrix24.ru/path/avatar.jpg",
"avatarHr": "https://cdn-ru.bitrix24.ru/path/avatar.jpg",
"gender": "F",
"birthday": "",
"extranet": false,
"network": false,
"bot": false,
"connector": false,
"externalAuthId": "socservices",
"status": "online",
"idle": false,
"lastActivityDate": "2026-02-13T14:27:33+03:00",
"mobileLastDate": false,
"desktopLastDate": false,
"absent": false,
"departments": [1, 107, 47, 3],
"phones": {
"personal_mobile": "79998887766",
"inner_phone": "111"
},
"botData": null,
"type": "user",
"website": "",
"email": "user@example.com"
}
],
"files": [],
"additionalMessages": [],
"copilot": null,
"stickers": [],
"reactions": [],
"tariffRestrictions": {
"isHistoryLimitExceeded": false
},
"usersShort": [],
"messages": [
{
"id": 33653,
"chatId": 2421,
"chat_id": 2421,
"authorId": 1,
"author_id": 1,
"date": "2026-02-13T14:28:00+03:00",
"text": "test message",
"isSystem": false,
"uuid": "18533186-232b-4423-8438-64501da182f5",
"forward": null,
"params": [],
"viewedByOthers": false,
"block": null,
"unread": false,
"viewed": true,
"viewedCount": 0
}
]
},
"time": {
"start": 1770982150,
"finish": 1770982150.503861,
"duration": 0.5038609504699707,
"processing": 0,
"date_start": "2026-02-13T14:29:10+03:00",
"date_finish": "2026-02-13T14:29:10+03:00",
"operating_reset_at": 1770982750,
"operating": 0
}
}
Возвращаемые данные
result
object
Корневой элемент ответа
result.messages
array
Массив найденных сообщений (подробное описание)
result.users
array
Пользователи, связанные с найденными сообщениями (подробное описание)
result.files
array
Файлы из найденных сообщений
result.additionalMessages
array
Дополнительные сообщения, связанные с найденными, например пересылаемые или цитируемые (подробное описание)
result.copilot
object
Данные BitrixGPT, если присутствуют в ответе. Может быть null
result.stickers
array
Стикеры, связанные с найденными сообщениями
result.reactions
array
Реакции на найденные сообщения (подробное описание)
result.tariffRestrictions
object
Информация о тарифных ограничениях истории.
Содержит флаг isHistoryLimitExceeded — признак превышения лимита истории сообщений по тарифу
result.usersShort
array
Краткая информация о пользователях, поставивших реакции.
Используется как дополняющий справочник к result.reactions.reactionUsers, содержит id, name, avatar
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": "CHAT_ID_EMPTY",
"error_description": "CHAT_ID can`t be empty"
}
| Код | Описание | Значение |
|---|---|---|
CHAT_ID_EMPTY |
CHAT_ID can't be empty | Не передан обязательный параметр CHAT_ID |
ACCESS_ERROR |
You do not have access to this chat | Нет доступа к указанному чату |

