Перейти к содержимому
Для разработчиков

Поиск сообщений

GET/search/messages
search:messages

Метод для полнотекстового поиска сообщений.

Параметры строки запроса

query
string
Текст поискового запроса
Пример:футболки
limit
integer, (int32)
Количество возвращаемых результатов за один запрос
Пример:10
По умолчанию:
200
Диапазон:
<= 200
cursor
string
Курсор для пагинации (из meta.paginate.next_page)
Пример:eyJpZCI6MTAsImRpciI6ImFzYyJ9
order
string
Направление сортировки
Возможные значения
Пример:desc
created_from
string, (date-time)
Фильтр по дате создания (от)
Пример:2025-01-01T00:00:00.000Z
created_to
string, (date-time)
Фильтр по дате создания (до)
Пример:2025-02-01T00:00:00.000Z
chat_ids[]
array of integers, (int32)
Фильтр по ID чатов
Пример:[198,334]
user_ids[]
array of integers, (int32)
Фильтр по ID авторов сообщений
Пример:[12,185]
active
boolean
Фильтр по активности чата
Пример:true

Ответ

200OK
The request has succeeded.
data[]
array of objects
*
id
integer, (int32)
*
Идентификатор сообщения
Пример:194275
entity_type
string
*
Тип сущности, к которой относится сообщение
Возможные значения
Пример:discussion
entity_id
integer, (int32)
*
Идентификатор сущности, к которой относится сообщение (беседы/канала, треда или пользователя)
Пример:334
chat_id
integer, (int32)
*
Идентификатор чата, в котором находится сообщение
Пример:334
root_chat_id
integer, (int32)
*
Идентификатор корневого чата. Для сообщений в тредах — идентификатор чата, в котором был создан тред. Для обычных сообщений совпадает с chat_id.
Пример:334
content
string
*
Текст сообщения
Пример:Вчера мы продали 756 футболок (что на 10% больше, чем в прошлое воскресенье)
user_id
integer, (int32)
*
Идентификатор пользователя, создавшего сообщение
Пример:12
created_at
string, (date-time)
*
Дата и время создания сообщения (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ
Пример:2021-08-28T15:57:23.000Z
url
string
*
Прямая ссылка на сообщение
Пример:https://app.pachca.com/chats/334?message=194275
files[]
array of objects
*
Прикрепленные файлы
id
integer, (int32)
*
Идентификатор файла
Пример:3560
key
string
*
Путь к файлу
Пример:attaches/files/12/21zu7934-02e1-44d9-8df2-0f970c259796/congrat.png
name
string
*
Название файла с расширением
Пример:congrat.png
file_type
string
*
Тип файла
Возможные значения
Пример:image
url
string
*
Прямая ссылка на скачивание файла
Пример:https://pachca-prod-uploads.s3.storage.selcloud.ru/attaches/files/12/21zu7934-02e1-44d9-8df2-0f970c259796/congrat.png?response-cache-control=max-age%3D3600%3B&response-content-disposition=attachment&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=142155_staply%2F20231107%2Fru-1a%2Fs3%2Faws4_request&X-Amz-Date=20231107T160412&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=98765asgfadsfdSaDSd4sdfg35asdf67sadf8
width
nullableinteger, (int32)
Ширина изображения в пикселях
Пример:1920
height
nullableinteger, (int32)
Высота изображения в пикселях
Пример:1080
buttons[][]
nullablearray of arrays of objects
*
Массив строк, каждая из которых представлена массивом кнопок
text
string
*
Текст, отображаемый на кнопке
Пример:Подробнее
Длина:
<= 255 символов
url
string
Ссылка, которая будет открыта по нажатию кнопки
Пример:https://example.com/details
data
string
Данные, которые будут отправлены в исходном вебхуке по нажатию кнопки
Пример:awesome
Длина:
<= 255 символов
thread
nullableobject
*
Тред сообщения
id
integer, (int64)
*
Идентификатор созданного треда (используется для отправки POSTновых комментариев в тред)
Пример:265142
chat_id
integer, (int64)
*
Идентификатор чата треда (используется для отправки POSTновых комментариев в тред и получения GETсписка комментариев)
Пример:2637266155
message_id
integer, (int64)
*
Идентификатор сообщения, к которому был создан тред
Пример:154332686
message_chat_id
integer, (int64)
*
Идентификатор чата сообщения
Пример:2637266154
updated_at
string, (date-time)
*
Дата и время обновления треда (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ
Пример:2023-02-01T19:20:47.204Z
forwarding
nullableobject
*
Информация о пересланном сообщении
original_message_id
integer, (int32)
*
Идентификатор оригинального сообщения
Пример:194275
original_chat_id
integer, (int32)
*
Идентификатор чата, в котором находится оригинальное сообщение
Пример:334
author_id
integer, (int32)
*
Идентификатор пользователя, создавшего оригинальное сообщение
Пример:12
original_created_at
string, (date-time)
*
Дата и время создания оригинального сообщения (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ
Пример:2025-01-15T10:30:00.000Z
original_thread_id
nullableinteger, (int32)
*
Идентификатор треда, в котором находится оригинальное сообщение
Пример:null
original_thread_message_id
nullableinteger, (int32)
*
Идентификатор сообщения, к которому был создан тред, в котором находится оригинальное сообщение
Пример:null
original_thread_parent_chat_id
nullableinteger, (int32)
*
Идентификатор чата сообщения, к которому был создан тред, в котором находится оригинальное сообщение
Пример:null
parent_message_id
nullableinteger, (int32)
*
Идентификатор сообщения, к которому написан ответ
Пример:null
display_avatar_url
nullablestring
*
Ссылка на аватарку отправителя сообщения
Пример:null
display_name
nullablestring
*
Полное имя отправителя сообщения
Пример:null
changed_at
nullablestring, (date-time)
*
Дата и время последнего редактирования сообщения (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ
Пример:2021-08-28T16:10:00.000Z
deleted_at
nullablestring, (date-time)
*
Дата и время удаления сообщения (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ
Пример:null
meta
object
*
Мета-информация для пагинации поисковых результатов
total
integer, (int32)
*
Общее количество найденных результатов
Пример:42
paginate
object
*
Вспомогательная информация
next_page
string
*
Курсор пагинации следующей страницы
Пример:eyJxZCO2MiwiZGlyIjomSNYjIn3
Поиск сообщений
Ответ 200