Для разработчиков

Информация о сообщении

GET/messages/{id}

Сообщение вместе с автором, вложениями и кнопками.

Удалённое сообщение метод всё равно отдаёт — с пустым content и заполненным deleted_at, без файлов и реакций.

Ссылки на файлы в ответе временные. Обычный файл отдаётся прямой ссылкой на хранилище, а защищённый и зашифрованный — адресом API, по которому нужен токен со скоупом files:read.

Параметры пути

id
integer, (int32)
*
Идентификатор сообщения. Ссылка веб-приложения указывает на сообщение параметром sidebar_message, а без него — параметром message. Число из thread_message_id — сообщение, под которым висит тред.
Пример:194275

Ответ

200OK
The request has succeeded.
data
object
*
Сообщение
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
*
Ссылка на скачивание файла. Обычно ведёт прямо в хранилище и действует до 7 дней, а оставшийся срок может быть меньше — если такая ссылка вернула 403, запросите сообщение заново и получите свежую. Если в пространстве включено шифрование или задан безопасный контур, ссылка ведёт на GETСкачивание файла: забирать такой файл нужно с заголовком Authorization, а токену нужен скоуп files:read.
Пример:https://files.example.com/attaches/files/12/21zu7934-02e1-44d9-8df2-0f970c259796/congrat.png?X-Amz-Expires=604800&X-Amz-Signature=98765asgfadsfdSaDSd4sdfg35asdf67sadf8
width
nullableinteger, (int32)
Ширина изображения в пикселях. null для файлов, не являющихся изображением, а также если размер не был передан при загрузке.
Пример:1920
height
nullableinteger, (int32)
Высота изображения в пикселях. null для файлов, не являющихся изображением, а также если размер не был передан при загрузке.
Пример:1080
duration_ms
nullableinteger, (int32)
Длительность в миллисекундах у голосового, аудио- и видеофайла. null у остальных файлов и если длительность не была передана при загрузке.
Пример:5400
voice_content
nullableobject
*
Данные голосового сообщения. Заполняется только для голосовых сообщений (file_type файла — voice), иначе null.
duration_ms
integer, (int32)
*
Длительность голосового сообщения в миллисекундах
Пример:5400
waveform
string
*
Форма волны (амплитуды) для визуализации голосового сообщения
Пример:4,8,12,20,16,10,6,3
transcript
nullablestring
*
Расшифровка голосового сообщения в текст. null, пока расшифровка не готова или недоступна.
Пример:Привет, посмотри пожалуйста последний отчёт
buttons[][]
nullablearray of arrays of objects
*
Массив строк, каждая из которых представлена массивом кнопок. null, если сообщение отправлено без кнопок.
text
string
*
Текст, отображаемый на кнопке
Пример:Подробнее
Длина:
<= 255 символов
url
string
Ссылка, которая будет открыта по нажатию кнопки. У кнопки должно быть заполнено ровно одно из полей url и data.
Пример:https://example.com/details
Длина:
<= 1024 символов
data
string
Данные, которые будут отправлены в исходящем вебхуке по нажатию кнопки. У кнопки должно быть заполнено ровно одно из полей url и data.
Пример:awesome
Длина:
<= 255 символов
thread
nullableobject
*
Тред, созданный к этому сообщению. null, если тред не создан, а также у сообщений, которые сами находятся внутри треда.
id
integer, (int64)
*
Идентификатор треда. Чтобы написать в тред, передайте его в entity_id метода POSTНовое сообщение с entity_type: "thread".
Пример:265142
chat_id
integer, (int64)
*
Идентификатор чата треда. По нему читают сообщения треда методом GETСписок сообщений чата.
Пример:2637266155
forwarding
nullableobject
*
Информация о пересланном сообщении. null, если сообщение не является пересланным.
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, если оригинальное сообщение было не в треде или тред создан без привязки к сообщению.
Пример:null
original_thread_parent_chat_id
nullableinteger, (int32)
*
Идентификатор чата сообщения, к которому был создан тред, в котором находится оригинальное сообщение. null, если оригинальное сообщение было не в треде или тред создан без привязки к сообщению.
Пример:null
parent_message_id
nullableinteger, (int32)
*
Идентификатор сообщения, к которому написан ответ. null, если сообщение не является ответом на другое сообщение.
Пример:null
display_avatar_url
nullablestring
Ссылка на аватарку отправителя сообщения. Поле присутствует только у сообщений от ботов; у сообщений от сотрудников его в ответе нет. null, если бот не переопределял значение при отправке.
Пример:null
display_name
nullablestring
Полное имя отправителя сообщения. Поле присутствует только у сообщений от ботов; у сообщений от сотрудников его в ответе нет. null, если бот не переопределял значение при отправке.
Пример:null
changed_at
nullablestring, (date-time)
*
Дата и время последнего изменения сообщения (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ. У неотредактированного сообщения совпадает с датой создания. null у сообщений, отправленных до появления этого поля.
Пример:2021-08-28T16:10:00.000Z
deleted_at
nullablestring, (date-time)
*
Дата и время удаления сообщения (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ. null у неудалённых сообщений. В списке сообщений удалённые не возвращаются.
Пример:null
Информация о сообщении
pachca messages get 194275 \  --json \  --token YOUR_ACCESS_TOKEN
Ответ 200
{  "data": {    "id": 194275,    "entity_type": "discussion",    "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",        "file_type": "image",        "url": "https://files.example.com/attaches/files/12/21zu7934-02e1-44d9-8df2-0f970c259796/congrat.png?X-Amz-Expires=604800&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",      "original_thread_id": null,      "original_thread_message_id": null,      "original_thread_parent_chat_id": null    },    "parent_message_id": null,    "display_avatar_url": null,    "display_name": null,    "changed_at": "2021-08-28T16:10:00.000Z",    "deleted_at": null  }}