Search

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

Ищет по тексту сообщений и по именам вложенных файлов, но только в чатах, где владелец токена состоит. Открытый канал, в который он не вступал, в поиск не попадает, хотя ленту его читать можно. Сообщения тредов в выдачу входят.

Слова запроса ищутся по словоформам и по части слова, опечатки при этом не исправляются. Запрос в кавычках ищется строгой фразой, поиск по части слова в нём не работает.

По умолчанию сообщения приходят от новых к старым. sort=relevance переключает выдачу на соответствие запросу, где свежие сообщения всё равно ценятся выше.

get/search/messages

Request

  • Base URL: https://api.pachca.com/api/shared/v1
  • URL: https://api.pachca.com/api/shared/v1/search/messages
  • Auth: HTTP bearer

Query parameters

querystring
Example:футболки

Текст поискового запроса

limitinteger
Example:10

Количество возвращаемых результатов за один запрос

cursorstring
Example:eyJpZCI6MTAsImRpciI6ImFzYyJ9

Курсор для пагинации (из meta.paginate.next_page)

order'asc' | 'desc'

Порядок сортировки

Направление сортировки

sort'created_at' | 'relevance'

Сортировка результатов поиска сообщений

Сортировка результатов

created_fromstring date-time
Example:2025-01-01T00:00:00.000Z

Фильтр по дате создания (от)

created_tostring date-time
Example:2025-02-01T00:00:00.000Z

Фильтр по дате создания (до)

chat_idsinteger[]

Фильтр по ID чатов

[
  198,
  334
]
user_idsinteger[]

Фильтр по ID авторов сообщений

[
  12,
  185
]
activeboolean
Example:true

Фильтр по активности чата

Response

The request has succeeded.

Example response

{
  "data": [
    {
      "id": 194275,
      "entity_id": 334,
      "chat_id": 334,
      "root_chat_id": 334,
      "content": "Вчера мы продали 756 футболок (что на 10% больше, чем в прошлое воскресенье)",
      "user_id": 12,
      "created_at": "2021-08-28T15:57:23.000Z",
      "url": "https://app.pachca.com/chats/334?message=194275",
      "files": [
        {
          "id": 3560,
          "key": "attaches/files/12/21zu7934-02e1-44d9-8df2-0f970c259796/congrat.png",
          "name": "congrat.png",
          "url": "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": 1920,
          "height": 1080,
          "duration_ms": 5400
        }
      ],
      "voice_content": {
        "duration_ms": 5400,
        "waveform": "4,8,12,20,16,10,6,3",
        "transcript": "Привет, посмотри пожалуйста последний отчёт"
      },
      "buttons": [
        [
          {
            "text": "Подробнее",
            "url": "https://example.com/details",
            "data": "awesome"
          }
        ]
      ],
      "thread": {
        "id": 265142,
        "chat_id": 2637266155
      },
      "forwarding": {
        "original_message_id": 194275,
        "original_chat_id": 334,
        "author_id": 12,
        "original_created_at": "2025-01-15T10:30:00.000Z"
      },
      "changed_at": "2021-08-28T16:10:00.000Z"
    }
  ],
  "meta": {
    "total": 42,
    "paginate": {
      "next_page": "eyJxZCO2MiwiZGlyIjomSNYjIn3"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.